azure_rm_keyvault_info – Получение сведений о хранилище Azure Key Vault
Новая версия 2.9.
Обзор
- Получение сведений о хранилище Azure Key Vault.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- 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. |
| auth_source строка добавлен в 2.5 |
| Управляет источником учетных данных для аутентификации. Если не указано, будет использована переменная окружения 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 |
| Управляет поведением проверки сертификатов для 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. |
| name - | Имя хранилища ключей. | |
| password строка | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала. | |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group - | Имя группы ресурсов, к которой принадлежит хранилище ключей. | |
| secret строка | Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала. | |
| subscription_id строка | Идентификатор вашей подписки Azure. | |
| tags - | Ограничить результаты, указав список тегов. Формат тегов 'ключ' или 'ключ:значение'. | |
| 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: 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 список | всегда | Список хранилищ ключей Azure. | |||
| access_policies список | всегда | Расположение хранилища. | |||
| object_id строка | всегда | Идентификатор объекта пользователя, службы-принципала или группы безопасности в AAD для хранилища. Пример: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | |||
| permissions сложная структура | всегда | Разрешения, которые у идентификатора есть для ключей, секретов и сертификатов. | |||
| certificates список | всегда | Разрешения на секреты. Пример: ['get', 'import'] | |||
| keys список | всегда | Разрешения на ключи. Пример: ['get', 'create'] | |||
| secrets список | всегда | Разрешения на секреты. Пример: ['list', 'set'] | |||
| tenant_id строка | всегда | Идентификатор аренды AAD, который должен использоваться для аутентификации запросов в хранилище ключей. Пример: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | |||
| enabled_for_deployments логический тип | всегда | Разрешено ли виртуальным машинам Azure извлекать сертификаты, хранящиеся в хранилище ключей, как секреты. | |||
| enabled_for_disk_encryption логический тип | всегда | Разрешено ли Azure Disk Encryption извлекать секреты из хранилища и распаковывать ключи. | |||
| enabled_for_template_deployment логический тип | всегда | Разрешено ли Azure Resource Manager извлекать секреты из хранилища ключей. | |||
| id строка | всегда | Идентификатор ресурса хранилища. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault | |||
| location строка | всегда | Расположение хранилища. Пример: eastus | |||
| name строка | всегда | Имя хранилища. Пример: myVault | |||
| sku словарь | всегда | Sku хранилища. | |||
| family строка | всегда | Имя семейства sku. Пример: A | |||
| name строка | всегда | Имя sku. Пример: standard | |||
| tags список | Список тегов. Пример: ['foo'] | ||||
| vault_uri строка | всегда | Uri хранилища. Пример: https://myVault.vault.azure.net/ | |||
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Yunge Zhu (@yungezz)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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_keyvault_info_module.html
