Spec-Zone.ru › Ansible

модуль azure.azcollection.azure_rm_adapplication_info — получение сведений о приложении Azure Active Directory

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).

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

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

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

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

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

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

  • Получение сведений о приложении Azure Active Directory.

Требования

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

  • 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

добавлено в azure.azcollection 0.0.1

URL центра сертификации Azure AD. Используйте при аутентификации с помощью имени пользователя и пароля, если у вас собственный центр сертификации ADFS.

api_profile

string

добавлено в azure.azcollection 0.0.1

Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

По умолчанию: "latest"

app_diff

list / elements=dictionary

Список приложений

Имя приложения или его идентификатор являются обязательными

Также можно указать все поля приложений (с разбором из JSON или YAML).

С помощью этого параметра можно сравнить самостоятельно определённые приложения с текущим состоянием, используя список приложений. Приложения, присутствующие только в текущем состоянии, но отсутствующие в вашем списке, будут возвращены в виде списка со всеми полями и получат дополнительный статус ABSENT. Это позволяет сначала добавить приложения с помощью azure_rm_adapplication, а затем использовать azure_rm_adapplication_info (параметр diff), чтобы определить приложения, которых не должно быть в текущем состоянии, и впоследствии удалить их с помощью azure_rm_adapplication

app_display_name

string

Имя приложения.

app_id

string

Идентификатор приложения.

auth_source

string

добавлено в azure.azcollection 0.0.1

Определяет источник учетных данных, используемых для аутентификации.

Также можно задать с помощью переменной окружения ANSIBLE_AZURE_AUTH_SOURCE.

Если задано значение auto (по умолчанию), приоритет источников следующий: параметры модуля -> env -> credential_file -> cli.

Если задано значение env, учетные данные будут прочитаны из переменных окружения.

Если задано значение credential_file, профиль будет прочитан из ~/.azure/credentials.

Если задано значение cli, учетные данные будут получены из профиля Azure CLI. Для указания идентификатора подписки, если их несколько, можно использовать subscription_id или переменную окружения AZURE_SUBSCRIPTION_ID; в противном случае будет использована подписка Azure CLI по умолчанию.

Если задано значение msi, компьютер-хост должен быть ресурсом Azure с включенным расширением MSI. Для указания идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать subscription_id или переменную окружения AZURE_SUBSCRIPTION_ID; в противном случае будет выбрана первая подписка.

Параметр msi добавлен в Ansible 2.6.

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

добавлено в azure.azcollection 0.0.1

Определяет способ проверки сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав ignore. Значение также можно задать в профиле файла учетных данных или с помощью переменной окружения AZURE_CERT_VALIDATION.

Варианты:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi).

Также можно задать с помощью переменной окружения AZURE_CLIENT_ID.

cloud_environment

string

добавлено в azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, укажите имя среды (согласно Azure Python SDK, например AzureChinaCloud, AzureUSGovernment) или URL конечной точки обнаружения метаданных (требуется для Azure Stack). Значение также можно задать в профиле файла учетных данных или с помощью переменной окружения AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

disable_instance_discovery

boolean

добавлено в azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра сертификации будут полностью отключены. Эта возможность предназначена для сценариев, в которых невозможно обратиться к конечной точке метаданных, например в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает получение метаданных центра сертификации с сайта https://login.microsoft.com/ для проверки центра сертификации. Если задать значение **True**, проверка центра сертификации будет отключена. Поэтому крайне важно убедиться, что настроенный узел центра сертификации является допустимым и заслуживающим доверия.

Значение задаётся в профиле файла учетных данных или с помощью переменной окружения AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

  • false ← (по умолчанию)
  • true

identifier_uri

string

Идентификатор объекта identifier_uri.

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

object_id

string

Идентификатор объекта приложения.

oidc_token

string

добавлено в azure.azcollection 3.17.0

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC.

Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC.

Также можно задать с помощью переменной окружения AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

добавлено в azure.azcollection 3.17.0

Путь к файлу с токеном OpenID Connect (OIDC) (JWT), используемым для аутентификации с помощью удостоверения рабочей нагрузки.

Файл должен содержать только необработанный токен.

Этот способ обычно используется на платформах, которые сохраняют токены OIDC в файлах.

Также можно задать с помощью переменной окружения AZURE_FEDERATED_TOKEN_FILE.

password

string

Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы.

profile

string

Профиль безопасности из файла ~/.azure/credentials.

secret

string

Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы.

subscription_id

string

Идентификатор вашей подписки Azure.

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 ad app info by App ID
  azure_rm_adapplication_info:
    app_id: "{{ app_id }}"

- name: get ad app info ---- by object ID
  azure_rm_adapplication_info:
    object_id: "{{ object_id }}"

- name: get ad app info ---- by identifier uri
  azure_rm_adapplication_info:
    identifier_uri: "{{ identifier_uri }}"

- name: get ad app info ---- by display name
  azure_rm_adapplication_info:
    app_display_name: "{{ display_name }}"

- name: get ad app diff ---- by display name
  azure_rm_adapplication_info:
    app_diff:
      - app_display_name: "{{ display_name }}"
      - app_id: "{{ app_id }}"

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

Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

app_diff

complex

Информация о приложении AD.

Возвращается: всегда

app_display_name

string

Отображаемое имя объекта или его префикс.

Возвращается: всегда

Пример: "app"

app_id

string

Идентификатор приложения.

Возвращается: всегда

Пример: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

identifier_uris

list / elements=string

Список identifiers_uri приложения.

Возвращается: всегда

Пример: ["http://ansible-atodorov"]

notes

string

Примечания, относящиеся к управлению приложением.

Возвращается: всегда

Пример: "Test value"

object_id

string

Идентификатор объекта приложения.

Возвращается: всегда

Пример: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

optional_claims

complex

Объявляет необязательные утверждения для приложения.

Возвращается: всегда

access_token_claims

list / elements=string

Необязательные утверждения, возвращаемые в токене доступа JWT

Возвращается: всегда

Пример: [{"name": "aud"}, {"source": null}, {"essential": false}, {"additional_properties": []}]

id_token_claims

list / elements=string

Необязательные утверждения, возвращаемые в токене идентификатора JWT

Возвращается: всегда

Пример: [{"name": "acct"}, {"source": null}, {"essential": false}, {"additional_properties": []}]

saml2_token_claims

list / elements=string

Необязательные утверждения, возвращаемые в токене SAML

Возвращается: всегда

Пример: [{"name": "acct"}, {"source": null}, {"essential": false}, {"additional_properties": []}]

public_client_reply_urls

list / elements=string

URL-адреса перенаправления общедоступного клиента.

Разделённые пробелами URI, на которые Azure AD будет перенаправлять в ответ на запрос OAuth 2.0.

Возвращается: всегда

Пример: []

sign_in_audience

string

Приложение можно использовать в любом клиенте Azure AD

Возвращается: всегда

Пример: "AzureADandPersonalMicrosoftAccount"

spa_reply_urls

list / elements=string

URL-адреса перенаправления SPA.

Разделённые пробелами URI, на которые Azure AD будет перенаправлять в ответ на запрос OAuth 2.0.

Возвращается: всегда

Пример: []

state

string

absent --> Приложение отсутствует в app_diff.

Возвращается: всегда

Пример: "absent"

web_reply_urls

list / elements=string

URL-адреса веб-перенаправления.

Разделённые пробелами URI, на которые Azure AD будет перенаправлять в ответ на запрос OAuth 2.0.

Возвращается: всегда

Пример: []

applications

complex

Информация о приложении AD.

Возвращается: всегда

app_display_name

string

Отображаемое имя объекта или его префикс.

Возвращается: всегда

Пример: "app"

app_id

string

Идентификатор приложения.

Возвращается: всегда

Пример: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

identifier_uris

list / elements=string

Список identifiers_uri приложения.

Возвращается: всегда

Пример: ["http://ansible-atodorov"]

object_id

string

Идентификатор объекта приложения.

Возвращается: всегда

Пример: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

optional_claims

complex

Объявляет необязательные утверждения для приложения.

Возвращается: всегда

access_token_claims

list / elements=string

Необязательные утверждения, возвращаемые в токене доступа JWT

Возвращается: всегда

Пример: [{"name": "aud"}, {"source": null}, {"essential": false}, {"additional_properties": []}]

id_token_claims

list / elements=string

Необязательные утверждения, возвращаемые в токене идентификатора JWT

Возвращается: всегда

Пример: [{"name": "acct"}, {"source": null}, {"essential": false}, {"additional_properties": []}]

saml2_token_claims

list / elements=string

Необязательные утверждения, возвращаемые в токене SAML

Возвращается: всегда

Пример: [{"name": "acct"}, {"source": null}, {"essential": false}, {"additional_properties": []}]

public_client_reply_urls

list / elements=string

URL-адреса перенаправления общедоступного клиента.

Разделённые пробелами URI, на которые Azure AD будет перенаправлять в ответ на запрос OAuth 2.0.

Возвращается: всегда

Пример: []

sign_in_audience

string

Приложение можно использовать в любом клиенте Azure AD

Возвращается: всегда

Пример: "AzureADandPersonalMicrosoftAccount"

spa_reply_urls

list / elements=string

URL-адреса перенаправления SPA.

Разделённые пробелами URI, на которые Azure AD будет перенаправлять в ответ на запрос OAuth 2.0.

Возвращается: всегда

Пример: []

web_reply_urls

list / elements=string

URL-адреса веб-перенаправления.

Разделённые пробелами URI, на которые Azure AD будет перенаправлять в ответ на запрос OAuth 2.0.

Возвращается: всегда

Пример: []

Авторы

  • haiyuan_zhang (@haiyuazhang) Fred-sun (@Fred-sun) guopeng_lin (@guopenglin) Xu Zhang (@xuzhang)

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

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API