az ad app
Управление приложениями Microsoft Entra.
Команды
| Имя | Описание | Тип | Состояние |
|---|---|---|---|
| az ad app create |
Создание приложения. |
Core | GA |
| az ad app credential |
Управление паролем или учетными данными сертификата приложения. |
Core | GA |
| az ad app credential delete |
Удалите пароль или учетные данные сертификата приложения. |
Core | GA |
| az ad app credential list |
Вывод списка метаданных учетных данных учетных данных или пароля приложения. (Содержимое пароля или учетных данных сертификата не может быть извлечено.) |
Core | GA |
| az ad app credential reset |
Сброс пароля или учетных данных сертификата приложения. |
Core | GA |
| az ad app delete |
Удаление приложения. |
Core | GA |
| az ad app federated-credential |
Управление учетными данными федеративного удостоверения приложения. |
Core | GA |
| az ad app federated-credential create |
Создайте учетные данные федеративного удостоверения приложения. |
Core | GA |
| az ad app federated-credential delete |
Удаление учетных данных федеративного удостоверения приложения. |
Core | GA |
| az ad app federated-credential list |
Перечисление учетных данных федеративного удостоверения приложения. |
Core | GA |
| az ad app federated-credential show |
Отображение учетных данных федеративного удостоверения приложения. |
Core | GA |
| az ad app federated-credential update |
Обновите учетные данные федеративного удостоверения приложения. |
Core | GA |
| az ad app list |
Вывод списка приложений. |
Core | GA |
| az ad app owner |
Управление владельцами приложений. |
Core | GA |
| az ad app owner add |
Добавьте владельца приложения. |
Core | GA |
| az ad app owner list |
Вывод списка владельцев приложений. |
Core | GA |
| az ad app owner remove |
Удалите владельца приложения. |
Core | GA |
| az ad app permission |
Управление разрешениями OAuth2 приложения. |
Core | GA |
| az ad app permission add |
Добавление разрешения API. |
Core | GA |
| az ad app permission admin-consent |
Предоставьте приложениям & делегированные разрешения с помощью согласия администратора. |
Core | GA |
| az ad app permission delete |
Удалите разрешение API. |
Core | GA |
| az ad app permission grant |
Предоставьте приложению делегированные разрешения API. |
Core | GA |
| az ad app permission list |
Вывод списка разрешений API, запрошенных приложением. |
Core | GA |
| az ad app permission list-grants |
Вывод списка разрешений Oauth2. |
Core | GA |
| az ad app show |
Получение сведений о приложении. |
Core | GA |
| az ad app update |
Обновление приложения. |
Core | GA |
az ad app create
Создание приложения.
Более подробную документацию см. в https://learn.microsoft.com/graph/api/resources/application.
az ad app create --display-name
[--app-roles]
[--enable-access-token-issuance {false, true}]
[--enable-id-token-issuance {false, true}]
[--end-date]
[--identifier-uris]
[--is-fallback-public-client {false, true}]
[--key-display-name]
[--key-type {AsymmetricX509Cert, Password, Symmetric}]
[--key-usage {Sign, Verify}]
[--key-value]
[--optional-claims]
[--public-client-redirect-uris]
[--requested-access-token-version]
[--required-resource-accesses]
[--service-management-reference]
[--sign-in-audience {AzureADMultipleOrgs, AzureADMyOrg, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount}]
[--start-date]
[--web-home-page-url]
[--web-redirect-uris]
Примеры
Создание приложения.
az ad app create --display-name mytestapp
Создание приложения, которое может вернуться к общедоступному клиенту с делегированным разрешением User.Read в Microsoft Graph.
az ad app create --display-name my-public --is-fallback-public-client --required-resource-accesses @manifest.json
("manifest.json" contains the following content)
[{
"resourceAppId": "00000003-0000-0000-c000-000000000000",
"resourceAccess": [
{
"id": "e1fe6dd8-ba31-4d61-89e7-88639da4683d",
"type": "Scope"
}
]
}]
Создание приложения с ролью
az ad app create --display-name mytestapp --identifier-uris https://mytestapp.websites.net --app-roles @manifest.json
("manifest.json" contains the following content)
[{
"allowedMemberTypes": [
"User"
],
"description": "Approvers can mark documents as approved",
"displayName": "Approver",
"isEnabled": "true",
"value": "approver"
}]
Создание приложения с необязательными утверждениями
az ad app create --display-name mytestapp --optional-claims @manifest.json
("manifest.json" contains the following content)
{
"idToken": [
{
"name": "auth_time",
"essential": false
}
],
"accessToken": [
{
"name": "ipaddr",
"essential": false
}
],
"saml2Token": [
{
"name": "upn",
"essential": false
},
{
"name": "extension_ab603c56068041afb2f6832e2a17e237_skypeId",
"source": "user",
"essential": false
}
]
}
Обязательные параметры
Отображаемое имя приложения.
Необязательные параметры
Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.
Коллекция ролей, назначенных приложению. При назначении ролей приложения эти роли можно назначать пользователям, группам или субъектам-службам, связанным с другими приложениями. Должен быть путь к JSON-файлу или строковая строка JSON. Дополнительные сведения см. в примерах.
| Свойство | Значение |
|---|---|
| Группа параметров: | JSON property Arguments |
Указывает, может ли веб-приложение запрашивать маркер доступа с помощью неявного потока OAuth 2.0.
| Свойство | Значение |
|---|---|
| Группа параметров: | web Arguments |
| Допустимые значения: | false, true |
Указывает, может ли веб-приложение запрашивать маркер идентификатора с помощью неявного потока OAuth 2.0.
| Свойство | Значение |
|---|---|
| Группа параметров: | web Arguments |
| Допустимые значения: | false, true |
Дата или дата окончания срока действия учетных данных (например, "2017-12-31T11:59:59+00:00" или "2017-12-31". Значение по умолчанию — один год после текущего времени.
| Свойство | Значение |
|---|---|
| Группа параметров: | keyCredential Arguments |
Разделенные пробелами значения. Это значение, также известное как URI идентификатора приложения, задается, когда приложение используется в качестве приложения-ресурса. ИдентификаторUris выступает в качестве префикса для областей, на которые вы будете ссылаться в коде API, и он должен быть глобально уникальным. Можно использовать предоставленное по умолчанию значение, которое находится в форме api://<application-client-id>, или указать более читаемый URI, например https://contoso.com/api.
Указывает резервный тип приложения как общедоступный клиент, например установленное приложение, запущенное на мобильном устройстве. Значение по умолчанию равно false, что означает, что тип резервного приложения является конфиденциальным клиентом, например веб-приложением.
| Свойство | Значение |
|---|---|
| Допустимые значения: | false, true |
Понятное имя ключа.
| Свойство | Значение |
|---|---|
| Группа параметров: | keyCredential Arguments |
Тип учетных данных ключа, связанных с приложением.
| Свойство | Значение |
|---|---|
| Группа параметров: | keyCredential Arguments |
| Default value: | AsymmetricX509Cert |
| Допустимые значения: | AsymmetricX509Cert, Password, Symmetric |
Использование ключевых учетных данных, связанных с приложением.
| Свойство | Значение |
|---|---|
| Группа параметров: | keyCredential Arguments |
| Default value: | Verify |
| Допустимые значения: | Sign, Verify |
Значение для ключевых учетных данных, связанных с приложением.
| Свойство | Значение |
|---|---|
| Группа параметров: | keyCredential Arguments |
Разработчики приложений могут настроить необязательные утверждения в своих приложениях Microsoft Entra, чтобы указать утверждения, отправляемые в приложение службой маркеров безопасности Майкрософт. Дополнительные сведения см. в разделе https://learn.microsoft.com/azure/active-directory/develop/active-directory-optional-claims. Должен быть путь к JSON-файлу или строковая строка JSON. Дополнительные сведения см. в примерах.
| Свойство | Значение |
|---|---|
| Группа параметров: | JSON property Arguments |
Разделенные пробелами значения. Указывает URL-адреса, в которых маркеры пользователей отправляются для входа или URI перенаправления, в которых отправляются коды авторизации OAuth 2.0 и маркеры доступа.
| Свойство | Значение |
|---|---|
| Группа параметров: | publicClient Arguments |
Указывает версию маркера доступа, ожидаемую этим ресурсом. В результате изменяются версия и формат JWT, созданного независимо от конечной точки или клиента, используемых для запроса маркера доступа.
| Свойство | Значение |
|---|---|
| Группа параметров: | api Arguments |
Указывает ресурсы, к которым приложению необходимо получить доступ. В этом свойстве также указывается набор делегированных разрешений и ролей приложения, необходимых для каждого из этих ресурсов. Эта настройка доступа к необходимым ресурсам определяет порядок предоставления согласия. Должен быть путь к JSON-файлу или строковая строка JSON. Дополнительные сведения см. в примерах.
| Свойство | Значение |
|---|---|
| Группа параметров: | JSON property Arguments |
Ссылается на контактные данные приложения или службы из базы данных службы или управления активами.
Указывает, учетные записи Майкрософт, которые поддерживаются для текущего приложения.
| Свойство | Значение |
|---|---|
| Допустимые значения: | AzureADMultipleOrgs, AzureADMyOrg, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount |
Дата или дата, когда учетные данные становятся допустимыми (например, "2017-01-01T01:00:00+00:00" или "2017-01-01". Значение по умолчанию — текущее время.
| Свойство | Значение |
|---|---|
| Группа параметров: | keyCredential Arguments |
Домашняя страница или целевая страница приложения.
| Свойство | Значение |
|---|---|
| Группа параметров: | web Arguments |
Разделенные пробелами значения. Указывает URL-адреса, в которых маркеры пользователей отправляются для входа или URI перенаправления, в которых отправляются коды авторизации OAuth 2.0 и маркеры доступа.
| Свойство | Значение |
|---|---|
| Группа параметров: | web Arguments |
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |
az ad app delete
Удаление приложения.
az ad app delete --id
Примеры
Удаление приложения. (autogenerated)
az ad app delete --id 00000000-0000-0000-0000-000000000000
Обязательные параметры
URI идентификатора, идентификатор приложения или идентификатор объекта.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |
az ad app list
Вывод списка приложений.
Для низкой задержки по умолчанию возвращается только первый 100, если только не указать аргументы фильтра или использовать "-all".
az ad app list [--all]
[--app-id]
[--display-name]
[--filter]
[--identifier-uri]
[--show-mine]
Необязательные параметры
Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.
Вывод списка всех сущностей, ожидайте долгой задержки, если в большой организации.
Идентификатор приложения.
Отображаемое имя приложения.
Фильтр OData, например --filter "displayname eq 'test" и servicePrincipalType eq 'Application'.
Идентификатор приложения Graph должен быть в формате URI.
Вывод списка сущностей, принадлежащих текущему пользователю.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |
az ad app show
Получение сведений о приложении.
az ad app show --id
Примеры
Получение сведений о приложении с помощью appId.
az ad app show --id 00000000-0000-0000-0000-000000000000
Получение сведений о приложении с идентификатором.
az ad app show --id 00000000-0000-0000-0000-000000000000
Получение сведений о приложении с URI идентификатора.
az ad app show --id api://myapp
Обязательные параметры
URI идентификатора, идентификатор приложения или идентификатор объекта.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |
az ad app update
Обновление приложения.
az ad app update --id
[--add]
[--app-roles]
[--display-name]
[--enable-access-token-issuance {false, true}]
[--enable-id-token-issuance {false, true}]
[--end-date]
[--force-string]
[--identifier-uris]
[--is-fallback-public-client {false, true}]
[--key-display-name]
[--key-type {AsymmetricX509Cert, Password, Symmetric}]
[--key-usage {Sign, Verify}]
[--key-value]
[--optional-claims]
[--public-client-redirect-uris]
[--remove]
[--requested-access-token-version]
[--required-resource-accesses]
[--service-management-reference]
[--set]
[--sign-in-audience {AzureADMultipleOrgs, AzureADMyOrg, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount}]
[--start-date]
[--web-home-page-url]
[--web-redirect-uris]
Примеры
Обновление приложения с делегированным разрешением Microsoft Graph User.Read
az ad app update --id e042ec79-34cd-498f-9d9f-123456781234 --required-resource-accesses @manifest.json
("manifest.json" contains the following content)
[{
"resourceAppId": "00000003-0000-0000-c000-000000000000",
"resourceAccess": [
{
"id": "e1fe6dd8-ba31-4d61-89e7-88639da4683d",
"type": "Scope"
}
]
}]
объявление роли приложения
az ad app update --id e042ec79-34cd-498f-9d9f-123456781234 --app-roles @manifest.json
("manifest.json" contains the following content)
[{
"allowedMemberTypes": [
"User"
],
"description": "Approvers can mark documents as approved",
"displayName": "Approver",
"isEnabled": "true",
"value": "approver"
}]
обновление необязательных утверждений
az ad app update --id e042ec79-34cd-498f-9d9f-123456781234 --optional-claims @manifest.json
("manifest.json" contains the following content)
{
"idToken": [
{
"name": "auth_time",
"essential": false
}
],
"accessToken": [
{
"name": "ipaddr",
"essential": false
}
],
"saml2Token": [
{
"name": "upn",
"essential": false
},
{
"name": "extension_ab603c56068041afb2f6832e2a17e237_skypeId",
"source": "user",
"essential": false
}
]
}
Обновление утверждений о членстве в группе приложения на "Все"
az ad app update --id e042ec79-34cd-498f-9d9f-123456781234 --set groupMembershipClaims=All
Обязательные параметры
URI идентификатора, идентификатор приложения или идентификатор объекта.
Необязательные параметры
Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.
Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string or JSON string>.
| Свойство | Значение |
|---|---|
| Группа параметров: | Generic Update Arguments |
| Default value: | [] |
Коллекция ролей, назначенных приложению. При назначении ролей приложения эти роли можно назначать пользователям, группам или субъектам-службам, связанным с другими приложениями. Должен быть путь к JSON-файлу или строковая строка JSON. Дополнительные сведения см. в примерах.
| Свойство | Значение |
|---|---|
| Группа параметров: | JSON property Arguments |
Отображаемое имя приложения.
Указывает, может ли веб-приложение запрашивать маркер доступа с помощью неявного потока OAuth 2.0.
| Свойство | Значение |
|---|---|
| Группа параметров: | web Arguments |
| Допустимые значения: | false, true |
Указывает, может ли веб-приложение запрашивать маркер идентификатора с помощью неявного потока OAuth 2.0.
| Свойство | Значение |
|---|---|
| Группа параметров: | web Arguments |
| Допустимые значения: | false, true |
Дата или дата окончания срока действия учетных данных (например, "2017-12-31T11:59:59+00:00" или "2017-12-31". Значение по умолчанию — один год после текущего времени.
| Свойство | Значение |
|---|---|
| Группа параметров: | keyCredential Arguments |
При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.
| Свойство | Значение |
|---|---|
| Группа параметров: | Generic Update Arguments |
| Default value: | False |
Разделенные пробелами значения. Это значение, также известное как URI идентификатора приложения, задается, когда приложение используется в качестве приложения-ресурса. ИдентификаторUris выступает в качестве префикса для областей, на которые вы будете ссылаться в коде API, и он должен быть глобально уникальным. Можно использовать предоставленное по умолчанию значение, которое находится в форме api://<application-client-id>, или указать более читаемый URI, например https://contoso.com/api.
Указывает резервный тип приложения как общедоступный клиент, например установленное приложение, запущенное на мобильном устройстве. Значение по умолчанию равно false, что означает, что тип резервного приложения является конфиденциальным клиентом, например веб-приложением.
| Свойство | Значение |
|---|---|
| Допустимые значения: | false, true |
Понятное имя ключа.
| Свойство | Значение |
|---|---|
| Группа параметров: | keyCredential Arguments |
Тип учетных данных ключа, связанных с приложением.
| Свойство | Значение |
|---|---|
| Группа параметров: | keyCredential Arguments |
| Default value: | AsymmetricX509Cert |
| Допустимые значения: | AsymmetricX509Cert, Password, Symmetric |
Использование ключевых учетных данных, связанных с приложением.
| Свойство | Значение |
|---|---|
| Группа параметров: | keyCredential Arguments |
| Default value: | Verify |
| Допустимые значения: | Sign, Verify |
Значение для ключевых учетных данных, связанных с приложением.
| Свойство | Значение |
|---|---|
| Группа параметров: | keyCredential Arguments |
Разработчики приложений могут настроить необязательные утверждения в своих приложениях Microsoft Entra, чтобы указать утверждения, отправляемые в приложение службой маркеров безопасности Майкрософт. Дополнительные сведения см. в разделе https://learn.microsoft.com/azure/active-directory/develop/active-directory-optional-claims. Должен быть путь к JSON-файлу или строковая строка JSON. Дополнительные сведения см. в примерах.
| Свойство | Значение |
|---|---|
| Группа параметров: | JSON property Arguments |
Разделенные пробелами значения. Указывает URL-адреса, в которых маркеры пользователей отправляются для входа или URI перенаправления, в которых отправляются коды авторизации OAuth 2.0 и маркеры доступа.
| Свойство | Значение |
|---|---|
| Группа параметров: | publicClient Arguments |
Удалите свойство или элемент из списка. Пример: --remove property.list <indexToRemove> OR --remove propertyToRemove.
| Свойство | Значение |
|---|---|
| Группа параметров: | Generic Update Arguments |
| Default value: | [] |
Указывает версию маркера доступа, ожидаемую этим ресурсом. В результате изменяются версия и формат JWT, созданного независимо от конечной точки или клиента, используемых для запроса маркера доступа.
| Свойство | Значение |
|---|---|
| Группа параметров: | api Arguments |
Указывает ресурсы, к которым приложению необходимо получить доступ. В этом свойстве также указывается набор делегированных разрешений и ролей приложения, необходимых для каждого из этих ресурсов. Эта настройка доступа к необходимым ресурсам определяет порядок предоставления согласия. Должен быть путь к JSON-файлу или строковая строка JSON. Дополнительные сведения см. в примерах.
| Свойство | Значение |
|---|---|
| Группа параметров: | JSON property Arguments |
Ссылается на контактные данные приложения или службы из базы данных службы или управления активами.
Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<value>.
| Свойство | Значение |
|---|---|
| Группа параметров: | Generic Update Arguments |
| Default value: | [] |
Указывает, учетные записи Майкрософт, которые поддерживаются для текущего приложения.
| Свойство | Значение |
|---|---|
| Допустимые значения: | AzureADMultipleOrgs, AzureADMyOrg, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount |
Дата или дата, когда учетные данные становятся допустимыми (например, "2017-01-01T01:00:00+00:00" или "2017-01-01". Значение по умолчанию — текущее время.
| Свойство | Значение |
|---|---|
| Группа параметров: | keyCredential Arguments |
Домашняя страница или целевая страница приложения.
| Свойство | Значение |
|---|---|
| Группа параметров: | web Arguments |
Разделенные пробелами значения. Указывает URL-адреса, в которых маркеры пользователей отправляются для входа или URI перенаправления, в которых отправляются коды авторизации OAuth 2.0 и маркеры доступа.
| Свойство | Значение |
|---|---|
| Группа параметров: | web Arguments |
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |