azure.azcollection.azure_keyvault_secret поиск — Считывание секрета из Azure Key Vault.
Примечание
Этот плагин поиска входит в коллекцию azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого плагина поиска необходимы дополнительные требования, см. Требования для получения подробностей.
Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_keyvault_secret.
Новое в azure.azcollection 1.12.0
Описание
- Этот поиск возвращает содержимое секрета, сохраненного в Azure Key Vault.
- Когда хост Ansible включён в режим MSI на виртуальной машине Azure, пользователю не нужно предоставлять какие-либо учетные данные для доступа к Azure Key Vault.
Требования
Ниже перечислены требования, необходимые на локальном узле контроллера, на котором выполняется этот поиск.
- requests
- azure
Термины
Параметр | Комментарии |
|---|---|
Термины строка / обязательный | Имя секрета, версия может быть включена, например, secret_name/secret_version. |
Параметры ключевых слов
Здесь описываются параметры ключевых слов поиска. Это значения key1=value1, key2=value2 и т. д. в следующих примерах: lookup('azure.azcollection.azure_keyvault_secret', key1=value1, key2=value2, ...) и query('azure.azcollection.azure_keyvault_secret', key1=value1, key2=value2, ...)
Параметр | Комментарии |
|---|---|
client_id строка | Идентификатор клиента службы принципала, имеющей доступ к Azure Key Vault |
cloud_type строка | Укажите облако, например, |
secret строка | Секрет службы принципала. |
tenant_id строка | Идентификатор клиента службы принципала. |
use_msi строка | Автообнаружение маркера MSI, значение по умолчанию — true. |
vault_url строка / обязательный | URL Azure Key Vault. |
Примечания
Примечание
- Когда позиционные и ключевые параметры используются вместе, позиционные параметры должны быть перечислены перед ключевыми параметрами:
lookup('azure.azcollection.azure_keyvault_secret', term1, term2, key1=value1, key2=value2)иquery('azure.azcollection.azure_keyvault_secret', term1, term2, key1=value1, key2=value2) - Если версия не указана, этот плагин вернёт последнюю версию секрета.
- Если Ansible выполняется на виртуальной машине Azure с включённым MSI, client_id, secret и tenant не требуются.
- Для включения MSI на виртуальной машине Azure, пожалуйста, обратитесь к этому документу https://docs.microsoft.com/en-us/azure/active-directory/managed-service-identity/
- После включения MSI на виртуальной машине Azure, не забудьте предоставить доступ к хранилищу ключей для виртуальной машины, добавив новую политику доступа в Azure Portal.
- Если MSI не включен на узле Ansible, необходимо указать действительный служба принципал, который имеет доступ к хранилищу ключей.
- Для аутентификации через службу принципала, передайте client_id, secret и tenant_id или задайте переменные среды AZURE_CLIENT_ID, AZURE_CLIENT_SECRET и AZURE_TENANT_ID.
- Поддерживается также аутентификация через
az login. - Для использования плагина из коллекции, пожалуйста, используйте полное имя пространства имён, имя коллекции и имя плагина поиска, который вы хотите использовать.
Возвращаемое значение
Ключ | Описание |
|---|---|
Возвращаемое значение строка | Строка содержимого секрета Возвращено: success |
Ссылки на коллекции
© 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_keyvault_secret_lookup.html
