azure.azcollection.azure_rm_keyvaultsecret модуль — Использование секретов Azure KeyVault

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для её установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: azure.azcollection.azure_rm_keyvaultsecret.

Добавлена в azure.azcollection 0.1.2

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

Описание

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

Требования

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

python >= 2.7
На хосте, на котором выполняется модуль, должна быть установлена коллекция azure.azcollection через galaxy
Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на хосте, на котором выполняются модули из azure.azcollection
Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

END_OF_DOCUMENT_MARKER

Параметр	Комментарии
ad_user строка	Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо сервисного принципала.
adfs_authority_url строка добавлен в azure.azcollection 0.0.1	URL-адрес полномочий Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS.
api_profile строка добавлен в azure.azcollection 0.0.1	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. По умолчанию: `"latest"`
append_tags логическое	Управление полем тегов: каноническое или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. Варианты: `false` `true` ← (по умолчанию)
auth_source строка добавлен в azure.azcollection 0.0.1	Управление источником учетных данных для аутентификации. Также может быть задано через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. Если установлено в значение `auto` (по умолчанию), приоритет имеет параметры модуля -> `env` -> `credential_file` -> `cli`. Если установлено в `env`, учетные данные будут считываться из переменных среды. Если установлено в `credential_file`, профиль будет считан из `~/.azure/credentials`. Если установлено в `cli`, учетные данные будут взяты из профиля Azure CLI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` может быть использована для идентификации идентификатора подписки, если их несколько, в противном случае используется стандартная подписка az cli. Если установлено в `msi`, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` может использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка. `msi` была добавлена в Ansible 2.6. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode строка добавлен в azure.azcollection 0.0.1	Управление проверкой сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить эту функцию, передав `ignore`. Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id строка	Идентификатор Azure клиента. Используйте при аутентификации с сервисным принципалом или управляемой учетной записью (msi). Также может быть задано через переменную среды `AZURE_CLIENT_ID`.
cloud_environment строка добавлен в azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес точки входа для обнаружения метаданных (необходим для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
content_type строка	Тип значения секрета, например, пароль.
disable_instance_discovery логическое добавлен в azure.azcollection 2.3.0	Определяет, будет ли выполняться обнаружение экземпляра при попытке аутентификации. Установка в значение true полностью отключит обнаружение экземпляра и проверку полномочий. Эта функция предназначена для использования в сценариях, где точка входа метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляра подразумевает получение метаданных полномочий с https://login.microsoft.com/ для проверки полномочий. Установив это значение в True, проверка полномочий отключается. Поэтому необходимо убедиться, что заданный хост полномочий действителен и надежен. Устанавливается через профиль файла учетных данных или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
keyvault_uri строка / обязательно	URI конечной точки хранилища ключей.
log_mode строка	Родительский аргумент.
log_path строка	Родительский аргумент.
password строка	Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо сервисного принципала.
profile строка	Профиль безопасности, найденный в файле ~/.azure/credentials.
purge_if_need логическое	Удалить секреты навсегда. Варианты: `false` `true`

recover_if_need boolean	Возможность постоянного восстановления удалённых секретов. Варианты: `false` `true`
secret string	Секрет клиента Azure. Используется при аутентификации с помощью принципала службы.
secret_expiry string	Необязательная дата и время истечения срока действия секрета
secret_name string / обязательно	Имя секрета хранилища ключей.
secret_valid_from string	Необязательная дата и время начала действия секрета
secret_value string	Секрет, подлежащий защите в хранилище ключей.
state string	Утверждение состояния подсети. Используйте `present` для создания или обновления секрета и `absent` для удаления секрета. Варианты: `"absent"` `"present"` ← (по умолчанию)
subscription_id string	Ваш идентификатор подписки Azure.
tags dictionary	Словарь пар «строка:строка» для присвоения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в тегах. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов для ресурсов.
tenant string	Идентификатор клиента Azure. Используется при аутентификации с помощью принципала службы.
thumbprint string Добавлено в azure.azcollection 1.14.0	Отпечаток отпечатков указанного в x509_certificate_path закрытого ключа. Используется при аутентификации с помощью принципала службы. Требуется, если определено x509_certificate_path.
x509_certificate_path path Добавлено в azure.azcollection 1.14.0	Путь к X509-сертификату, используемому для создания принципала службы в формате PEM. Сертификат должен быть присоединён к закрытому ключу. Используется при аутентификации с помощью принципала службы.

Примечания

Примечание

Для аутентификации с 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

- name: Recover a delete secret
  azure_rm_keyvaultsecret:
    secret_name: MySecret
    keyvault_uri: https://contoso.vault.azure.net/
    recover_if_need: true

- name: Purge a delete secret
  azure_rm_keyvaultsecret:
    secret_name: MySecret
    keyvault_uri: https://contoso.vault.azure.net/
    purge_if_need: true

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

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

Ключ	Описание
state complex	Текущее состояние секрета. Возвращаемое значение: success
secret_id string	Путь к ресурсу секрета. Возвращаемое значение: success Пример: `"https://contoso.vault.azure.net/secrets/hello/e924f053839f4431b35bc54393f98423"`

Авторы

Ian Philpot (@iphilpot)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_keyvaultsecret_module.html