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		URL-адрес авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственном центре авторизации ADFS.
api_profile строка добавлено в 2.5	Значение по умолчанию: "latest"	Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags логическое	Варианты: нет да ←	Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноничности любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлено в 2.5	Варианты: авто 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	Варианты: ignore validate	Управляет поведением проверки сертификата для 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, или войти в систему перед запуском задач или книги команд с помощью az login.
Аутентификация также возможна с помощью главного принципа службы или пользователя 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 в среде.

См. также

Вход в Azure CLI: Как войти в систему с помощью команды az login.

Примеры

- 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 сложное		success	Текущее состояние секрета.
	secret_id строка		Путь к ресурсу секрета.

Статус

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

Авторы

Ian Philpot (@iphilpot)

Подсказка

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

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