Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_adapplication_info – Получение информации об Azure Active Directory приложении

Примечание

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

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

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

Для использования в playbook укажите: 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

added in azure.azcollection 0.0.1

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

api_profile

string

added in azure.azcollection 0.0.1

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

Default: "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

added in 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 могут использоваться для идентификации идентификатора подписки, если присутствует более одного, в противном случае используется подписка az cli по умолчанию.

При установке в msi, хост-машина должна быть ресурсом azure с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если ресурс имеет доступ к более чем одной подписке, в противном случае выбирается первая подписка.

msi был добавлен в Ansible 2.6.

Варианты:

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

cert_validation_mode

string

added in 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

added in azure.azcollection 0.0.1

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

Default: "AzureCloud"

disable_instance_discovery

boolean

added in 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

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

пароль

строка

Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо сервисного принципала.

профиль

строка

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

секрет

строка

Секрет Azure-клиента. Используется при аутентификации с помощью сервисного принципала.

идентификатор_подписки

строка

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

арендатор

строка

Идентификатор Azure-арендатора. Используется при аутентификации с помощью сервисного принципала.

отпечаток

строка

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

Отпечаток частного ключа, указанного в x509_certificate_path.

Используется при аутентификации с помощью сервисного принципала.

Требуется, если определен x509_certificate_path.

путь_к_сертификату_x509

путь

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

Путь к X509-сертификату, используемому для создания сервисного принципала в формате PEM.

Сертификат должен быть присоединен к закрытому ключу.

Используется при аутентификации с помощью сервисного принципала.

Примечания

Примечание

  • Для аутентификации с Azure вы можете передавать параметры, устанавливать переменные среды, использовать профиль, сохраненный в файле ~/.azure/credentials, или войти перед запуском задач или плейбука с помощью az login.
  • Аутентификация также возможна с помощью сервисного принципала или пользователя Active Directory.
  • Для аутентификации через сервисный принципал передайте идентификатор_подписки, идентификатор_клиента, секрет и арендатор или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
  • Для аутентификации через пользователя Active Directory передайте ad_user и пароль или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
  • В качестве альтернативы данные учетных данных могут храниться в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: идентификатор_подписки, идентификатор_клиента, секрет и арендатор или идентификатор_подписки, ad_user и пароль. Также возможно добавить дополнительные профили. Укажите профиль, передав профиль или установив 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

сложный

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

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

app_display_name

строка

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

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

Пример: "app"

app_id

строка

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

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

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

available_to_other_tenants

строка

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

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

Пример: "AzureADandPersonalMicrosoftAccount"

identifier_uris

список / элементы=строка

Список идентификаторов URI приложения.

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

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

object_id

строка

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

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

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

optional_claims

сложный

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

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

access_token_claims

список / элементы=строка

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

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

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

id_token_claims

список / элементы=строка

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

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

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

saml2_token_claims

список / элементы=строка

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

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

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

public_client_reply_urls

список / элементы=строка

URL-адреса ответов для публичных клиентов.

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

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

Пример: []

sign_in_audience

строка

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

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

Пример: "AzureADandPersonalMicrosoftAccount"

spa_reply_urls

список / элементы=строка

URL-адреса ответов SPA.

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

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

Пример: []

state

строка

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

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

Пример: "absent"

web_reply_urls

список / элементы=строка

URL-адреса ответов веб-клиента.

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

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

Пример: []

applications

сложный

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

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

app_display_name

строка

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

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

Пример: "app"

app_id

строка

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

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

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

available_to_other_tenants

строка

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

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

Пример: "AzureADandPersonalMicrosoftAccount"

identifier_uris

список / элементы=строка

Список идентификаторов URI приложения.

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

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

object_id

строка

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

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

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

optional_claims

сложный

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

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

access_token_claims

список / элементы=строка

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

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

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

id_token_claims

список / элементы=строка

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

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

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

saml2_token_claims

список / элементы=строка

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

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

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

public_client_reply_urls

список / элементы=строка

Ссылки для ответов общедоступных клиентов.

Список URL-адресов, разделенных пробелами, на которые Azure AD перенаправит в ответ на запрос OAuth 2.0.

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

Пример: []

sign_in_audience

строка

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

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

Пример: "AzureADandPersonalMicrosoftAccount"

spa_reply_urls

список / элементы=строка

Ссылки для ответов SPA.

Список URL-адресов, разделенных пробелами, на которые Azure AD перенаправит в ответ на запрос OAuth 2.0.

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

Пример: []

web_reply_urls

список / элементы=строка

Ссылки для ответов веб-приложений.

Список URL-адресов, разделенных пробелами, на которые Azure AD перенаправит в ответ на запрос OAuth 2.0.

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

Пример: []

Авторы

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

Ссылки на сборки

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (источники)

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

Spec-Zone.ru

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