Модуль azure.azcollection.azure_rm_appconfiguration_info — получение сведений о хранилище Azure App Configuration
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для работы с этим модулем необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_appconfiguration_info.
Новое в azure.azcollection 3.15.0
Краткое описание
- Получение сведений о хранилищах Azure App Configuration (Microsoft.AppConfiguration/configurationStores).
- Поддерживается получение сведений по имени, перечисление хранилищ в группе ресурсов и перечисление хранилищ в подписке.
- При получении сведений по имени можно включить реплики хранилища.
Требования
Следующие требования должны быть выполнены на узле, на котором выполняется этот модуль.
- python >= 2.7
- На узле, выполняющем этот модуль, должна быть установлена через galaxy коллекция azure.azcollection
- Все пакеты python, перечисленные в requirements.txt коллекции, должны быть установлены с помощью pip на узле, выполняющем модули из azure.azcollection
- Полные инструкции по установке доступны по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Описание |
|---|---|
ad_user string | Имя пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
adfs_authority_url string добавлено в azure.azcollection 0.0.1 | URL-адрес центра сертификации Azure AD. Используйте при аутентификации по имени пользователя и паролю, если у вас есть собственный центр сертификации ADFS. |
api_profile string добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию По умолчанию: |
appconfig_name string | Имя хранилища App Configuration. |
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных, используемых для аутентификации. Также можно задать с помощью переменной среды Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Варианты:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Управляет проверкой сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной среды |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, укажите имя среды (как определено в Azure Python SDK, например По умолчанию: |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра сертификации будут полностью отключены. Эта возможность предназначена для сценариев, в которых недоступна конечная точка метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляра включает получение метаданных центра сертификации с https://login.microsoft.com/ для проверки центра сертификации. Если задать значение **True**, проверка центра сертификации будет отключена. Поэтому крайне важно убедиться, что настроенный узел центра сертификации действителен и заслуживает доверия. Задается в профиле файла учетных данных или с помощью переменной среды Варианты:
|
include_replicas boolean | Если задан параметр Для операций перечисления по умолчанию отключено, чтобы избежать дополнительных вызовов. Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
oidc_token string добавлено в azure.azcollection 3.17.0 | Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions и Azure DevOps), где платформа напрямую предоставляет токен OIDC. Также можно задать с помощью переменной среды |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Файл должен содержать только необработанный токен. Этот метод обычно используется на платформах, которые предоставляют токены OIDC в виде файлов. Также можно задать с помощью переменной среды |
password string | Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
profile string | Профиль безопасности из файла ~/.azure/credentials. |
resource_group string | Имя группы ресурсов, которой принадлежит хранилище App Configuration. |
secret string | Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
subscription_id string | Идентификатор вашей подписки Azure. |
tags list / элементы=string | Ограничивает результаты списком тегов. Формат тегов: |
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.
- Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
- Для аутентификации через субъект-службу передайте 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 App Configuration store
azure_rm_appconfiguration_info:
resource_group: myRG
appconfig_name: myAGS
- name: Get App Configuration store with replicas
azure_rm_appconfiguration_info:
resource_group: myRG
appconfig_name: myAGS
include_replicas: true
- name: List stores in RG
azure_rm_appconfiguration_info:
resource_group: myRG
- name: List stores in subscription
azure_rm_appconfiguration_info:
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
appconfigurations list / elements=string | Список хранилищ App Configuration. Возвращается: всегда |
|
appconfig_name string |
Имя хранилища App Configuration. Возвращается: всегда Пример: |
|
disable_local_auth boolean |
Отключена ли локальная аутентификация. Возвращается: всегда Пример: |
|
enable_purge_protection boolean |
Включена ли защита от окончательного удаления. Возвращается: всегда Пример: |
|
id string |
Идентификатор ресурса хранилища App Configuration. Возвращается: всегда Пример: |
|
identity dictionary |
Сведения об управляемой идентификации. Возвращается: всегда |
|
principal_id string |
Идентификатор субъекта управляемой идентификации. Возвращается: всегда Пример: |
|
tenant_id string |
Идентификатор клиента управляемой идентификации. Возвращается: всегда Пример: |
|
type string |
Тип управляемой идентификации. Возвращается: всегда Пример: |
|
location string |
Расположение хранилища App Configuration в Azure. Возвращается: всегда Пример: |
|
public_network_access string |
Включен ли доступ из общедоступной сети. Возвращается: всегда Пример: |
|
replicas list / elements=dictionary |
Список реплик хранилища App Configuration. Возвращается: если include_replicas имеет значение true и задан appconfig_name |
|
id string |
Идентификатор ресурса реплики. Возвращается: всегда Пример: |
|
location string |
Расположение реплики в Azure. Возвращается: всегда Пример: |
|
name string |
Имя реплики. Возвращается: всегда Пример: |
|
sku dictionary |
Артикул хранилища App Configuration. Возвращается: всегда |
|
name string |
Название артикула. Возвращается: всегда Пример: |
|
soft_delete_retention_in_days integer |
Количество дней хранения элементов, удалённых обратимо. Возвращается: всегда Пример: |
|
tags dictionary |
Список тегов. Возвращается: при успешном выполнении Пример: |
Ссылки коллекции
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_appconfiguration_info_module.html