Модуль azure.azcollection.azure_rm_keyvault_info — Получение фактов о хранилище Azure Key Vault
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля потребуются дополнительные требования, см. Требования для получения подробностей.
Чтобы использовать его в плейбуке, укажите: azure.azcollection.azure_rm_keyvault_info.
Добавлен в azure.azcollection 0.1.2
Обзор
- Получить данные о хранилище Azure Key Vault.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
- Все пакеты python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
- Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
ad_user string | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности. |
adfs_authority_url string added in azure.azcollection 0.0.1 | URL-адрес центра проверки подлинности Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный центр проверки подлинности ADFS. |
api_profile string added in azure.azcollection 0.0.1 | Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию Default: |
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных, используемых для аутентификации. Также может быть установлен через переменную среды При установке в При установке в При установке в При установке в При установке в Параметр Варианты:
|
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или для Azure Stack может потребоваться отключить это поведение, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi). Также может быть установлен через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных центра проверки подлинности из https://login.microsoft.com/ для проверки центра проверки подлинности. Установив это значение в **True**, проверка центра проверки подлинности отключается. В результате крайне важно убедиться, что настроенный хост центра проверки подлинности является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string | Имя хранилища ключей. |
password string | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group string | Имя группы ресурсов, к которой принадлежит хранилище ключей. |
secret string | Секретный ключ клиента Azure. Используйте при аутентификации с помощью субъекта безопасности. |
subscription_id string | Ваш идентификатор подписки Azure. |
теги список / элементы=строка | Ограничить результаты, указав список тегов. Форматировать теги как ‘ключ’ или ‘ключ:значение’. |
арендатор строка | Идентификатор Azure-арендатора. Используется при аутентификации с помощью Служебного принципала. |
отпечаток строка добавлен в azure.azcollection 1.14.0 | Отпечаток частного ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью Служебного принципала. Требуется, если определен x509_certificate_path. |
путь_к_сертификату_x509 путь добавлен в 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: Get Key Vault by name
azure_rm_keyvault_info:
resource_group: myResourceGroup
name: myVault
- name: List Key Vaults in specific resource group
azure_rm_keyvault_info:
resource_group: myResourceGroup
- name: List Key Vaults in current subscription
azure_rm_keyvault_info:
Значения возврата
Общие значения возврата описаны в здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
keyvaults list / elements=string | Список хранилищ ключей Azure. Возвращается: всегда |
|
access_policies list / elements=string |
Список политик. Возвращается: всегда |
|
object_id string |
Идентификатор объекта пользователя, субъекта безопасности или группы безопасности в AAD для хранилища. Возвращается: всегда Пример: |
|
permissions complex |
Разрешения, которыми обладает идентификатор для ключей, секретов и сертификатов. Возвращается: всегда |
|
certificates list / elements=string |
Разрешения на секреты. Возвращается: всегда Пример: |
|
keys list / elements=string |
Разрешения на ключи. Возвращается: всегда Пример: |
|
secrets list / elements=string |
Разрешения на секреты. Возвращается: всегда Пример: |
|
tenant_id string |
Идентификатор клиента AAD, который должен использоваться для аутентификации запросов к хранилищу ключей. Возвращается: всегда Пример: |
|
enable_purge_protection boolean |
Свойство, указывающее, включена ли для этого хранилища защита от очистки. Возвращается: всегда Пример: |
|
enable_soft_delete boolean |
Свойство, указывающее, разрешено ли Azure Resource Manager получать секреты из хранилища ключей. Возвращается: всегда Пример: |
|
enabled_for_deployments boolean |
Разрешено ли виртуальным машинам Azure получать сертификаты, хранящиеся как секреты, из хранилища ключей. Возвращается: всегда Пример: |
|
enabled_for_disk_encryption boolean |
Разрешено ли шифрованию дисков Azure получать секреты из хранилища и распаковывать ключи. Возвращается: всегда Пример: |
|
enabled_for_template_deployment boolean |
Разрешено ли Azure Resource Manager получать секреты из хранилища ключей. Возвращается: всегда Пример: |
|
id string |
Идентификатор ресурса хранилища. Возвращается: всегда Пример: |
|
location string |
Расположение хранилища. Возвращается: всегда Пример: |
|
name string |
Имя хранилища. Возвращается: всегда Пример: |
|
sku dictionary |
Sku хранилища. Возвращается: всегда |
|
family string |
Название семейства SKU. Возвращаемое значение: всегда Пример: |
|
name string |
Имя SKU. Возвращаемое значение: всегда Пример: |
|
soft_delete_retention_in_days integer |
Свойство, определяющее количество дней хранения удалённых хранилищ. Возвращаемое значение: всегда Пример: |
|
tags list / elements=string |
Список тегов. Возвращаемое значение: успех Пример: |
|
vault_uri string |
URI хранилища. Возвращаемое значение: всегда Пример: |
Ссылки на коллекцию
© 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_keyvault_info_module.html