azure.azcollection.azure_service_principal_attribute lookup – Поиск атрибутов субъекта-службы Azure.

Примечание

Этот плагин поиска входит в коллекцию azure.azcollection (версия 3.18.0).

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

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

Чтобы использовать его в плейбуке, укажите: azure.azcollection.azure_service_principal_attribute.

Добавлено в azure.azcollection 1.12.0

Краткое описание
Требования
Параметры-ключевые слова
Примечания
См. также
Примеры
Возвращаемое значение

Краткое описание

Описывает идентификатор объекта учетной записи субъекта-службы Azure.

Требования

Следующие требования должны быть выполнены на локальном узле контроллера, выполняющем этот поиск.

Все пакеты Python, перечисленные в requirements.txt коллекции, должны быть установлены на узле, выполняющем модули из azure.azcollection, с помощью pip
Полные инструкции по установке доступны по адресу https://galaxy.ansible.com/azure/azcollection
На узле, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection из Galaxy
msgraph-sdk
python >= 2.7

Параметры-ключевые слова

В этом разделе описаны параметры-ключевые слова поиска. Это значения key1=value1, key2=value2 и так далее в следующих примерах: lookup('azure.azcollection.azure_service_principal_attribute', key1=value1, key2=value2, ...) и query('azure.azcollection.azure_service_principal_attribute', key1=value1, key2=value2, ...)

Параметр	Комментарии
auth_source string	Определяет источник учетных данных, используемых для аутентификации. Также может быть задано с помощью переменной среды `ANSIBLE_AZURE_AUTH_SOURCE`. Если задано значение `auto` (по умолчанию), порядок приоритета следующий: параметры модуля -> `env` -> `credential_file` -> `cli`. Если задано значение `env`, учетные данные будут считываться из переменных среды. Если задано значение `cli`, учетные данные будут получены из профиля Azure CLI. Для определения идентификатора подписки, если их несколько, можно использовать `subscription_id` или переменную среды `AZURE_SUBSCRIPTION_ID`; в противном случае используется подписка az cli по умолчанию. Если задано значение `msi`, узел должен быть ресурсом Azure с включенным расширением MSI. Для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать `subscription_id` или переменную среды `AZURE_SUBSCRIPTION_ID`; в противном случае выбирается первая подписка. Параметр `msi` добавлен в Ansible 2.6. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"env"` `"msi"` Конфигурация: Переменная среды: `ANSIBLE_AZURE_AUTH_SOURCE`
client_id псевдонимы: azure_client_id string	Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также может быть задано с помощью переменной среды `AZURE_CLIENT_ID`. Конфигурация: Переменная среды: `AZURE_CLIENT_ID`
cloud_environment псевдонимы: azure_cloud_environment string добавлено в azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, укажите имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес диспетчера ресурсов (обязателен для Azure Stack). Также может быть задано в профиле файла учетных данных или с помощью переменной среды `AZURE_CLOUD_ENVIRONMENT`. Если задан URL-адрес, необходимо также указать ARM_CLOUD_METADATA_URL, если облако не зарегистрировано в azcli. По умолчанию: `"AzureCloud"` Конфигурация: Переменная среды: `AZURE_CLOUD_ENVIRONMENT`
oidc_token string	Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Конфигурация: Переменная среды: `AZURE_FEDERATED_TOKEN`
oidc_token_file_path path	Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Конфигурация: Переменная среды: `AZURE_FEDERATED_TOKEN_FILE`
secret псевдонимы: azure_secret string	Секрет клиента Azure. Используется при аутентификации с помощью субъекта-службы. Конфигурация: Переменная среды: `AZURE_SECRET`
subscription_id string	Идентификатор вашей подписки Azure. Конфигурация: Переменная среды: `AZURE_SUBSCRIPTION_ID`
tenant псевдонимы: azure_tenant string	Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта-службы. Конфигурация: Переменная среды: `AZURE_TENANT`

Примечания

Примечание

Если на узле Ansible не включен MSI, необходимо указать действительный субъект-службу, имеющий доступ к хранилищу ключей.
Для аутентификации через субъект-службу передайте client_id, secret и tenant либо задайте переменные среды AZURE_CLIENT_ID, AZURE_CLIENT_SECRET и AZURE_TENANT_ID.
Также поддерживается аутентификация через az login.
Для аутентификации в Azure можно передать параметры, задать переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или войти в систему перед выполнением задач или плейбука с помощью az login.
Также возможна аутентификация с помощью субъекта-службы.
Для аутентификации через 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.
Кроме того, учетные данные можно сохранить в ~/.azure/credentials. Это INI-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant.

См. также

Вход с помощью Azure CLI: Как выполнить аутентификацию с помощью команды az login.

Примеры

set_fact:
  object_id: "{{ lookup('azure_service_principal_attribute',
                         client_id=azure_client_id,
                         secret=azure_secret,
                         tenant=azure_secret) }}"

Возвращаемое значение

Ключ	Описание
Возвращаемое значение string	Возвращает идентификатор объекта субъекта-службы. Возвращается: при успехе

Авторы

Yunge Zhu (@yungezz)

Ссылки на коллекцию

© 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_service_principal_attribute_lookup.html