azure_rm_keyvaultsecret – Использование секретов Azure KeyVault.

Новая версия 2.5.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Создание или удаление секрета в заданном хранилище ключей. Используя хранилище ключей, вы можете шифровать ключи и секреты (например, ключи проверки подлинности, ключи учетных записей хранения, ключи шифрования данных, файлы .PFX и пароли).

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user -		Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала.
adfs_authority_url - добавлен в 2.6	По умолчанию: null	URL-адрес службы авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной службы авторизации ADFS.
api_profile - добавлен в 2.5	По умолчанию: "latest"	Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags boolean	Варианты: no да ←	Используется для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом представлении любые теги, которые не найдены в параметре тегов, будут удалены из метаданных объекта.
auth_source - добавлен в 2.5	Варианты: auto cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, будет использоваться переменная окружения ANSIBLE_AZURE_AUTH_SOURCE, по умолчанию `auto` если переменная не определена. `auto` будет следовать умолчанию приоритета параметров модуля -> переменных окружения -> профиля по умолчанию в файле учетных данных `~/.azure/credentials`. При установке в `cli`, учетные данные будут взяты из профиля Azure CLI по умолчанию. Также можно установить через переменную окружения `ANSIBLE_AZURE_AUTH_SOURCE`. При установке в `msi`, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. `subscription_id` или переменная окружения `AZURE_SUBSCRIPTION_ID` может быть использована для идентификации идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка. `msi` был добавлен в Ansible 2.6.
cert_validation_mode - добавлен в 2.5	Варианты: validate ignore	Управляет поведением проверки сертификатов для Azure-точек конечных точек. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или при работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также можно установить через профиль файла учетных данных или переменную окружения `AZURE_CERT_VALIDATION`.
client_id -		Идентификатор клиента Azure. Используется при аутентификации с помощью служебного принципала.
cloud_environment - добавлен в 2.4	По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес точки конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную окружения `AZURE_CLOUD_ENVIRONMENT`.
keyvault_uri - / обязательно		URI конечной точки хранилища ключей.
password -		Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала.
profile -		Профиль безопасности, найденный в файле ~/.azure/credentials.
secret -		Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала.
secret_name - / обязательно		Имя секрета хранилища ключей.
secret_value -		Секрет, который необходимо защитить с помощью хранилища ключей.
state -	Варианты: absent present ←	Утверждение состояния подсети. Используйте 'present' для создания или обновления секрета и 'absent' для удаления секрета.
subscription_id -		Идентификатор вашей подписки Azure.
tags -		Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в значение false.
tenant -		Идентификатор Azure-аренды. Используется при аутентификации с помощью служебного принципала.

Примечания

Примечание

Для аутентификации с Azure вы можете передать параметры, установить переменные окружения или использовать профиль, хранящийся в ~/.azure/credentials. Аутентификация возможна с помощью служебного принципала или пользователя Active Directory. Для аутентификации через служебного принципала передайте subscription_id, client_id, secret и tenant или установите переменные окружения AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
Для аутентификации через пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
В качестве альтернативы учетные данные можно сохранить в ~/.azure/credentials. Это файл ini, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также возможно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

Примеры

- name: Create a secret
  azure_rm_keyvaultsecret:
    secret_name: MySecret
    secret_value: My_Pass_Sec
    keyvault_uri: https://contoso.vault.azure.net/
    tags:
        testing: testing
        delete: never

- name: Delete a secret
  azure_rm_keyvaultsecret:
    secret_name: MySecret
    keyvault_uri: https://contoso.vault.azure.net/
    state: absent

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ		Возвращаемое значение	Описание
state complex		success	Текущее состояние секрета.
	secret_id string		Путь к ресурсу секрета.

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Ian Philpot (@tripdubroot)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/azure_rm_keyvaultsecret_module.html