Модуль azure.azcollection.azure_rm_adapplication — управление приложением Azure Active Directory

ad_user

string

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

adfs_authority_url

string

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

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

allow_guests_sign_in

boolean

Свойство приложения, указывающее, принимает ли приложение другие поставщики удостоверений (IDP) или принимает их частично.

Варианты:

• false
• true

api_profile

string

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

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

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

app_id

string

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

app_roles

list / elements=dictionary

Объявляет роли, которые необходимо связать с приложением.

allowed_member_types

list / elements=string / обязательный

Указывает, можно ли назначать эту роль приложения пользователям и группам: allowed_member_types=User.

Другим приложениям: allowed_member_types=Application.

Или и тем и другим: User и Appplication.

description

string

Описание роли приложения.

Оно отображается при назначении роли приложения.

Если роль приложения действует как разрешение приложения, описание отображается в процессе предоставления согласия.

display_name

string

Отображаемое имя разрешения, которое показывается при назначении роли приложения и в процессе предоставления согласия.

is_enabled

boolean

При создании или обновлении роли приложения этому параметру необходимо присвоить значение true (это значение используется по умолчанию).

Чтобы удалить роль, сначала необходимо присвоить этому параметру значение false.

После этого роль можно удалить в следующем вызове.

Варианты:

• false
• true

value

string

Указывает значение, которое следует включить в утверждение roles в токенах ID и токенах доступа, используемых для аутентификации назначенного пользователя или субъекта-службы.

Длина значения не должна превышать 120 символов.

Допустимые символы включают !

Любые другие символы, включая пробел, не допускаются.

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"

credential_description

string

Описание пароля.

disable_instance_discovery

boolean

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

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

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

Варианты:

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

display_name

string / обязательный

Отображаемое имя приложения.

end_date

string

Дата или дата и время, после которых срок действия учетных данных истекает (например, «2017-12-31»).

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

homepage

string

URL-адрес, по которому пользователи могут войти в систему и использовать приложение.

identifier_uris

list / elements=string

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

key_type

string

Тип учетных данных ключа, связанных с приложением.

Варианты:

• "AsymmetricX509Cert" ← (по умолчанию)
• "Password"
• "Symmetric"

key_usage

string

Назначение учетных данных ключа, связанных с приложением.

Варианты:

• "Sign"
• "Verify" ← (по умолчанию)

key_value

string

Значение учетных данных ключа, связанных с приложением.

log_mode

string

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

log_path

string

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

native_app

boolean

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

Варианты:

• false
• true

notes

string

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

oauth2_allow_implicit_flow

boolean

Разрешить ли неявный поток предоставления разрешений OAuth2.

Варианты:

• false
• true

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.

optional_claims

dictionary

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

access_token_claims

list / elements=dictionary

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

additional_properties

list / elements=string

Дополнительные свойства утверждения.

Если в этой коллекции указано свойство, оно изменяет поведение необязательного утверждения, заданного свойством name.

essential

boolean

Если значение равно true, утверждение, заданное клиентом, необходимо для обеспечения удобной авторизации при выполнении конкретной задачи, запрошенной конечным пользователем.

По умолчанию используется значение false.

Варианты:

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

name

string / обязательный

Имя необязательного утверждения.

source

string

Источник утверждения (объект каталога).

Существуют предопределенные утверждения и пользовательские утверждения из свойств расширения.

Если значение source равно null, утверждение является предопределенным необязательным утверждением.

Если значение source равно user, значение свойства name представляет собой свойство расширения из объекта пользователя.

id_token_claims

list / elements=dictionary

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

additional_properties

list / elements=string

Дополнительные свойства утверждения.

Если в этой коллекции указано свойство, оно изменяет поведение необязательного утверждения, заданного свойством name.

essential

boolean

Если значение равно true, утверждение, заданное клиентом, необходимо для обеспечения удобной авторизации при выполнении конкретной задачи, запрошенной конечным пользователем.

По умолчанию используется значение false.

Варианты:

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

name

string / обязательный

Имя необязательного утверждения.

source

string

Источник утверждения (объект каталога).

Существуют предопределенные утверждения и пользовательские утверждения из свойств расширения.

Если значение source равно null, утверждение является предопределенным необязательным утверждением.

Если значение source равно user, значение свойства name представляет собой свойство расширения из объекта пользователя.

saml2_token_claims

list / elements=dictionary

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

additional_properties

list / elements=string

Дополнительные свойства утверждения.

Если в этой коллекции указано свойство, оно изменяет поведение необязательного утверждения, заданного свойством name.

essential

boolean

Если значение равно true, утверждение, заданное клиентом, необходимо для обеспечения удобной авторизации при выполнении конкретной задачи, запрошенной конечным пользователем.

По умолчанию используется значение false.

Варианты:

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

name

string / обязательный

Имя необязательного утверждения.

source

string

Источник утверждения (объект каталога).

Существуют предопределенные утверждения и пользовательские утверждения из свойств расширения.

Если значение source равно null, утверждение является предопределенным необязательным утверждением.

Если значение source равно user, значение свойства name представляет собой свойство расширения из объекта пользователя.

password

string

Пароль приложения, также называемый «секретом клиента».

profile

string

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

public_client_reply_urls

list / elements=string

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

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

Значение не обязательно должно быть физической конечной точкой, но должно быть допустимым URI.

required_resource_accesses

list / elements=dictionary

Области ресурсов и роли, к которым приложению требуется доступ.

Должно быть представлено в формате JSON манифеста.

resource_access

list / elements=dictionary

Описание роли приложения.

id

string

Уникальный идентификатор одного из экземпляров oauth2PermissionScopes или appRole, предоставляемых приложением ресурса.

type

string

Указывает, ссылается ли свойство id на oauth2PermissionScopes или appRole.

Возможные значения: Scope или Role.

resource_app_id

string

Уникальный идентификатор ресурса, к которому приложению требуется доступ.

Он должен совпадать со значением appId, объявленным в целевом приложении ресурса.

secret

string

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

sign_in_audience

string

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

В Microsoft Graph SDK параметр available_to_other_tenants объявлен устаревшим и заменён на sign_in_audience.

См. ссылку https://learn.microsoft.com/en-us/graph/migrate-azure-ad-graph-property-differences#application-property-differences

Возможные значения:

• "AzureADMyOrg"
• "AzureADMultipleOrgs"
• "AzureADandPersonalMicrosoftAccount"
• "PersonalMicrosoftAccount"

spa_reply_urls

list / elements=string

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

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

Значение не обязательно должно быть физической конечной точкой, но должно быть допустимым URI.

start_date

string

Дата или дата и время, с которых учётные данные становятся действительными, например «2017-01-01».

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

state

string

Задаёт состояние субъекта-службы Active Directory.

Используйте present для создания или обновления пароля и absent для удаления.

Возможные значения:

• "absent"
• "present" ← (по умолчанию)

subscription_id

string

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

tenant

string

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

thumbprint

string

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

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

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

Обязательный параметр, если задан x509_certificate_path.

web_reply_urls

псевдонимы: reply_urls

list / elements=string

URL перенаправления веб-приложения.

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

Значение не обязательно должно быть физической конечной точкой, но должно быть допустимым URI.

x509_certificate_path

path

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

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

Закрытый ключ должен быть добавлен после сертификата.

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

app_id

string

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

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

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

display_name

string

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

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

Пример: "fredAKSCluster"

homepage

string

URL, по которому пользователи могут войти и использовать ваше приложение.

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

identifier_uris

list / elements=string

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

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

Пример: []

oauth2_allow_implicit_flow

boolean

Разрешён ли неявный поток OAuth2.

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

Пример: false

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.

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

Пример: []