Модуль azure.azcollection.azure_rm_keyvaultkey — Использование ключей Azure KeyVault

Примечание

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

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

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

Для использования в плейбуке укажите: azure.azcollection.azure_rm_keyvaultkey.

Новая в 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"`
byok_file строка	Файл BYOK.
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"`
curve строка	Имя эллиптической кривой. Для допустимых значений см. JsonWebKeyCurveName. Возможные значения включают P-256, P-384, P-521, P-256K.
disable_instance_discovery логическое добавлено в azure.azcollection 2.3.0	Определяет, будет ли выполняться обнаружение экземпляра при попытке аутентификации. Установка в значение true полностью отключит как обнаружение экземпляра, так и проверку авторизации. Эта функция предназначена для использования в сценариях, где точка конечного соединения метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает получение метаданных авторизации с https://login.microsoft.com/ для проверки авторизации. Установив это значение в True, отключается проверка авторизации. Поэтому крайне важно убедиться, что заданный хост авторизации является действительным и надёжным. Устанавливается через профиль файла учетных данных или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
key_attributes словарь	Атрибуты ключа, управляемого службой хранилища ключей.
enabled логическое	Включен ли ключ. Варианты: `false` `true`
expires строка	Недействителен после даты в формате UTC ISO без Z в конце
not_before строка	Недействителен до даты в формате UTC ISO без Z в конце

key_name string / обязательно	Имя ключа хранилища ключей.
key_size целое число	Размер ключа в битах. Например, 2048, 3072 или 4096 для RSA.
key_type строка	Тип ключа для создания. Для допустимых значений см. JsonWebKeyType. Возможные значения включают EC, EC-HSM, RSA, RSA-HSM, oct По умолчанию: `"RSA"`
keyvault_uri строка / обязательно	URI конечной точки хранилища ключей.
log_mode строка	Родительский аргумент.
log_path строка	Родительский аргумент.
password строка	Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо службы-принципала.
pem_file строка	Файл PEM.
pem_password строка	Пароль PEM.
profile строка	Профиль безопасности, найденный в файле ~/.azure/credentials.
secret строка	Секрет Azure-клиента. Используется при аутентификации с помощью службы-принципала.
state строка	Утвердить состояние ключа. Используйте `present` для создания ключа и `absent` для удаления ключа. Варианты: `"absent"` `"present"` ← (по умолчанию)
subscription_id строка	Ваш идентификатор подписки Azure.
tags словарь	Словарь пар строка:строка для назначения метаданных объекту. Метаданные тегов объекта будут обновлены с предоставленными значениями. Для удаления тегов установите опцию append_tags в значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не допускают использование пробелов в теге. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов на ресурсах.
tenant строка	Идентификатор Azure-аренды. Используется при аутентификации с помощью службы-принципала.
thumbprint строка добавлен в azure.azcollection 1.14.0	Отпечаток указанного в x509_certificate_path закрытого ключа. Используется при аутентификации с помощью службы-принципала. Требуется, если определен x509_certificate_path.
x509_certificate_path путь добавлен в azure.azcollection 1.14.0	Путь к X509-сертификату, используемому для создания службы-принципала в формате PEM. Сертификат должен быть добавлен к закрытому ключу. Используется при аутентификации с помощью службы-принципала.

Примечания

Примечание

Для аутентификации с Azure можно передавать параметры, устанавливать переменные среды, использовать профиль, сохраненный в файле ~/.azure/credentials, или войти в систему перед запуском задач или выполнения playbook с помощью 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 key
  azure_rm_keyvaultkey:
    key_name: MyKey
    keyvault_uri: https://contoso.vault.azure.net/

- name: Delete a key
  azure_rm_keyvaultkey:
    key_name: MyKey
    keyvault_uri: https://contoso.vault.azure.net/
    state: absent

Значения возврата

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

Ключ	Описание
state сложное	Текущее состояние ключа. Возвращается: успех
key_id строка	Путь к ресурсу ключа. Возвращается: успех Пример: `"https://contoso.vault.azure.net/keys/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_keyvaultkey_module.html