Compartilhar via


az ad app

Gerenciar aplicativos do Microsoft Entra.

Comandos

Nome Description Tipo Status
az ad app create

Criar um aplicativo.

Core GA
az ad app credential

Gerenciar as credenciais de senha ou certificado de um aplicativo.

Core GA
az ad app credential delete

Exclua as credenciais de senha ou certificado de um aplicativo.

Core GA
az ad app credential list

Listar metadados de credenciais de certificado ou senha de um aplicativo. (O conteúdo da credencial de senha ou certificado não é recuperável.).

Core GA
az ad app credential reset

Redefina as credenciais de senha ou certificado de um aplicativo.

Core GA
az ad app delete

Excluir um aplicativo.

Core GA
az ad app federated-credential

Gerenciar credenciais de identidade federadas do aplicativo.

Core GA
az ad app federated-credential create

Criar credencial de identidade federada do aplicativo.

Core GA
az ad app federated-credential delete

Excluir credencial de identidade federada do aplicativo.

Core GA
az ad app federated-credential list

Listar credenciais de identidade federadas do aplicativo.

Core GA
az ad app federated-credential show

Mostrar credencial de identidade federada do aplicativo.

Core GA
az ad app federated-credential update

Atualizar a credencial de identidade federada do aplicativo.

Core GA
az ad app list

List applications.

Core GA
az ad app owner

Gerenciar proprietários de aplicativos.

Core GA
az ad app owner add

Adicione um proprietário do aplicativo.

Core GA
az ad app owner list

Listar proprietários de aplicativos.

Core GA
az ad app owner remove

Remova um proprietário do aplicativo.

Core GA
az ad app permission

Gerencie as permissões OAuth2 de um aplicativo.

Core GA
az ad app permission add

Adicione uma permissão de API.

Core GA
az ad app permission admin-consent

Conceda permissões delegadas de & aplicativo por meio do consentimento do administrador.

Core GA
az ad app permission delete

Remova uma permissão de API.

Core GA
az ad app permission grant

Conceda ao aplicativo uma permissão delegada à API.

Core GA
az ad app permission list

Listar permissões de API solicitadas pelo aplicativo.

Core GA
az ad app permission list-grants

Listar concessões de permissão Oauth2.

Core GA
az ad app show

Obtenha os detalhes de um aplicativo.

Core GA
az ad app update

Atualize um aplicativo.

Core GA

az ad app create

Criar um aplicativo.

Para obter uma documentação mais detalhada, consulte 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]

Exemplos

Criar um aplicativo.

az ad app create --display-name mytestapp

Criar um aplicativo que pode voltar ao cliente público com a permissão delegada user.read do 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"
        }
   ]
}]

Criar um aplicativo com uma função

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"
}]

Criar um aplicativo com declarações opcionais

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
        }
    ]
}

Parâmetros Exigidos

--display-name

O nome de exibição do aplicativo.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--app-roles

A coleção de funções atribuídas ao aplicativo. Com atribuições de função de aplicativo, essas funções podem ser atribuídas a usuários, grupos ou entidades de serviço associadas a outros aplicativos. Deve ser o caminho do arquivo JSON ou a cadeia de caracteres JSON em linha. Veja exemplos para obter detalhes.

Propriedade Valor
Parameter group: JSON property Arguments
--enable-access-token-issuance

Especifica se esse aplicativo Web pode solicitar um token de acesso usando o fluxo implícito do OAuth 2.0.

Propriedade Valor
Parameter group: web Arguments
Valores aceitos: false, true
--enable-id-token-issuance

Especifica se esse aplicativo Web pode solicitar um token de ID usando o fluxo implícito do OAuth 2.0.

Propriedade Valor
Parameter group: web Arguments
Valores aceitos: false, true
--end-date

Data ou data após a qual as credenciais expiram (por exemplo, '2017-12-31T11:59:59+00:00' ou '2017-12-31'). O valor padrão é um ano após a hora atual.

Propriedade Valor
Parameter group: keyCredential Arguments
--identifier-uris

Space-separated values. Também conhecido como URI de ID do aplicativo, esse valor é definido quando um aplicativo é usado como um aplicativo de recurso. O identifierUris atua como o prefixo para os escopos que você referenciará no código da API e deve ser globalmente exclusivo. Você pode usar o valor padrão fornecido, que está no formato api://<application-client-id>, ou especificar um URI mais acessível como https://contoso.com/api .

--is-fallback-public-client

Especifica o tipo de aplicativo de fallback como cliente público; por exemplo, um aplicativo instalado em um dispositivo móvel. O valor padrão é false, o que significa que o tipo de aplicativo de fallback é um cliente confidencial, como um aplicativo Web.

Propriedade Valor
Valores aceitos: false, true
--key-display-name

Nome amigável para a chave.

Propriedade Valor
Parameter group: keyCredential Arguments
--key-type

O tipo das credenciais de chave associadas ao aplicativo.

Propriedade Valor
Parameter group: keyCredential Arguments
Valor padrão: AsymmetricX509Cert
Valores aceitos: AsymmetricX509Cert, Password, Symmetric
--key-usage

O uso das credenciais de chave associadas ao aplicativo.

Propriedade Valor
Parameter group: keyCredential Arguments
Valor padrão: Verify
Valores aceitos: Sign, Verify
--key-value

O valor das credenciais de chave associadas ao aplicativo.

Propriedade Valor
Parameter group: keyCredential Arguments
--optional-claims

Os programadores de aplicações podem configurar afirmações opcionais nas respetivas aplicações Microsoft Entra para especificar as afirmações que são enviadas para a respetiva aplicação pelo serviço de tokens de segurança da Microsoft. Para obter mais informações, consulte https://learn.microsoft.com/azure/active-directory/develop/active-directory-optional-claims. Deve ser o caminho do arquivo JSON ou a cadeia de caracteres JSON em linha. Veja exemplos para obter detalhes.

Propriedade Valor
Parameter group: JSON property Arguments
--public-client-redirect-uris

Space-separated values. Especifica os URLs para os quais os tokens de usuário são enviados para entrada ou os URIs de redirecionamento para os quais os códigos de autorização e os tokens de acesso do OAuth 2.0 são enviados.

Propriedade Valor
Parameter group: publicClient Arguments
--requested-access-token-version

Especifica a versão do token de acesso esperada por esse recurso. Isso altera a versão e o formato do JWT produzido, independentemente do ponto de extremidade ou do cliente usado para solicitar o token de acesso.

Propriedade Valor
Parameter group: api Arguments
--required-resource-accesses

Especifique os recursos que o aplicativo precisa acessar. Essa propriedade também especifica o conjunto de permissões delegadas e funções de aplicativo necessárias para cada um desses recursos. Essa configuração de acesso aos recursos necessários impulsiona a experiência de consentimento. Deve ser o caminho do arquivo JSON ou a cadeia de caracteres JSON em linha. Veja exemplos para obter detalhes.

Propriedade Valor
Parameter group: JSON property Arguments
--service-management-reference

Faz referência as informações de contato do aplicativo ou serviço de um banco de dados de Gerenciamento de Serviços ou Ativos.

--sign-in-audience

Especifique quais contas Microsoft têm suporte para o aplicativo atual.

Propriedade Valor
Valores aceitos: AzureADMultipleOrgs, AzureADMyOrg, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount
--start-date

Data ou data em que as credenciais se tornam válidas (por exemplo, '2017-01-01T01:00:00+00:00' ou '2017-01-01'). O valor padrão é a hora atual.

Propriedade Valor
Parameter group: keyCredential Arguments
--web-home-page-url

Home page ou página de aterrissagem do aplicativo.

Propriedade Valor
Parameter group: web Arguments
--web-redirect-uris

Space-separated values. Especifica os URLs para os quais os tokens de usuário são enviados para entrada ou os URIs de redirecionamento para os quais os códigos de autorização e os tokens de acesso do OAuth 2.0 são enviados.

Propriedade Valor
Parameter group: web Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Output format.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az ad app delete

Excluir um aplicativo.

az ad app delete --id

Exemplos

Excluir um aplicativo. (autogenerated)

az ad app delete --id 00000000-0000-0000-0000-000000000000

Parâmetros Exigidos

--id

Identificador uri, id do aplicativo ou id de objeto.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Output format.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az ad app list

List applications.

Para baixa latência, por padrão, somente os primeiros 100 serão retornados, a menos que você forneça argumentos de filtro ou use "--all".

az ad app list [--all]
               [--app-id]
               [--display-name]
               [--filter]
               [--identifier-uri]
               [--show-mine]

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--all

Liste todas as entidades, espere um longo atraso se estiver em uma grande organização.

--app-id

Application id.

--display-name

O nome de exibição do aplicativo.

--filter

Filtro OData, por exemplo, --filter "displayname eq 'test' e servicePrincipalType eq 'Application'".

--identifier-uri

O identificador do aplicativo graph deve estar no formato uri.

--show-mine

Listar entidades pertencentes ao usuário atual.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Output format.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az ad app show

Obtenha os detalhes de um aplicativo.

az ad app show --id

Exemplos

Obtenha os detalhes de um aplicativo com appId.

az ad app show --id 00000000-0000-0000-0000-000000000000

Obtenha os detalhes de um aplicativo com id.

az ad app show --id 00000000-0000-0000-0000-000000000000

Obtenha os detalhes de um aplicativo com o URI do identificador.

az ad app show --id api://myapp

Parâmetros Exigidos

--id

Identificador uri, id do aplicativo ou id de objeto.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Output format.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az ad app update

Atualize um aplicativo.

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]

Exemplos

Atualizar um aplicativo com a permissão delegada User.Read do Microsoft Graph

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"
        }
   ]
}]

declarar uma função de aplicativo

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"
}]

atualizar declarações opcionais

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
        }
    ]
}

atualizar as declarações de associação de grupo de um aplicativo para "Todos"

az ad app update --id e042ec79-34cd-498f-9d9f-123456781234 --set groupMembershipClaims=All

Parâmetros Exigidos

--id

Identificador uri, id do aplicativo ou id de objeto.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

Propriedade Valor
Parameter group: Generic Update Arguments
Valor padrão: []
--app-roles

A coleção de funções atribuídas ao aplicativo. Com atribuições de função de aplicativo, essas funções podem ser atribuídas a usuários, grupos ou entidades de serviço associadas a outros aplicativos. Deve ser o caminho do arquivo JSON ou a cadeia de caracteres JSON em linha. Veja exemplos para obter detalhes.

Propriedade Valor
Parameter group: JSON property Arguments
--display-name

O nome de exibição do aplicativo.

--enable-access-token-issuance

Especifica se esse aplicativo Web pode solicitar um token de acesso usando o fluxo implícito do OAuth 2.0.

Propriedade Valor
Parameter group: web Arguments
Valores aceitos: false, true
--enable-id-token-issuance

Especifica se esse aplicativo Web pode solicitar um token de ID usando o fluxo implícito do OAuth 2.0.

Propriedade Valor
Parameter group: web Arguments
Valores aceitos: false, true
--end-date

Data ou data após a qual as credenciais expiram (por exemplo, '2017-12-31T11:59:59+00:00' ou '2017-12-31'). O valor padrão é um ano após a hora atual.

Propriedade Valor
Parameter group: keyCredential Arguments
--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter em JSON.

Propriedade Valor
Parameter group: Generic Update Arguments
Valor padrão: False
--identifier-uris

Space-separated values. Também conhecido como URI de ID do aplicativo, esse valor é definido quando um aplicativo é usado como um aplicativo de recurso. O identifierUris atua como o prefixo para os escopos que você referenciará no código da API e deve ser globalmente exclusivo. Você pode usar o valor padrão fornecido, que está no formato api://<application-client-id>, ou especificar um URI mais acessível como https://contoso.com/api .

--is-fallback-public-client

Especifica o tipo de aplicativo de fallback como cliente público; por exemplo, um aplicativo instalado em um dispositivo móvel. O valor padrão é false, o que significa que o tipo de aplicativo de fallback é um cliente confidencial, como um aplicativo Web.

Propriedade Valor
Valores aceitos: false, true
--key-display-name

Nome amigável para a chave.

Propriedade Valor
Parameter group: keyCredential Arguments
--key-type

O tipo das credenciais de chave associadas ao aplicativo.

Propriedade Valor
Parameter group: keyCredential Arguments
Valor padrão: AsymmetricX509Cert
Valores aceitos: AsymmetricX509Cert, Password, Symmetric
--key-usage

O uso das credenciais de chave associadas ao aplicativo.

Propriedade Valor
Parameter group: keyCredential Arguments
Valor padrão: Verify
Valores aceitos: Sign, Verify
--key-value

O valor das credenciais de chave associadas ao aplicativo.

Propriedade Valor
Parameter group: keyCredential Arguments
--optional-claims

Os programadores de aplicações podem configurar afirmações opcionais nas respetivas aplicações Microsoft Entra para especificar as afirmações que são enviadas para a respetiva aplicação pelo serviço de tokens de segurança da Microsoft. Para obter mais informações, consulte https://learn.microsoft.com/azure/active-directory/develop/active-directory-optional-claims. Deve ser o caminho do arquivo JSON ou a cadeia de caracteres JSON em linha. Veja exemplos para obter detalhes.

Propriedade Valor
Parameter group: JSON property Arguments
--public-client-redirect-uris

Space-separated values. Especifica os URLs para os quais os tokens de usuário são enviados para entrada ou os URIs de redirecionamento para os quais os códigos de autorização e os tokens de acesso do OAuth 2.0 são enviados.

Propriedade Valor
Parameter group: publicClient Arguments
--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Propriedade Valor
Parameter group: Generic Update Arguments
Valor padrão: []
--requested-access-token-version

Especifica a versão do token de acesso esperada por esse recurso. Isso altera a versão e o formato do JWT produzido, independentemente do ponto de extremidade ou do cliente usado para solicitar o token de acesso.

Propriedade Valor
Parameter group: api Arguments
--required-resource-accesses

Especifique os recursos que o aplicativo precisa acessar. Essa propriedade também especifica o conjunto de permissões delegadas e funções de aplicativo necessárias para cada um desses recursos. Essa configuração de acesso aos recursos necessários impulsiona a experiência de consentimento. Deve ser o caminho do arquivo JSON ou a cadeia de caracteres JSON em linha. Veja exemplos para obter detalhes.

Propriedade Valor
Parameter group: JSON property Arguments
--service-management-reference

Faz referência as informações de contato do aplicativo ou serviço de um banco de dados de Gerenciamento de Serviços ou Ativos.

--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.

Propriedade Valor
Parameter group: Generic Update Arguments
Valor padrão: []
--sign-in-audience

Especifique quais contas Microsoft têm suporte para o aplicativo atual.

Propriedade Valor
Valores aceitos: AzureADMultipleOrgs, AzureADMyOrg, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount
--start-date

Data ou data em que as credenciais se tornam válidas (por exemplo, '2017-01-01T01:00:00+00:00' ou '2017-01-01'). O valor padrão é a hora atual.

Propriedade Valor
Parameter group: keyCredential Arguments
--web-home-page-url

Home page ou página de aterrissagem do aplicativo.

Propriedade Valor
Parameter group: web Arguments
--web-redirect-uris

Space-separated values. Especifica os URLs para os quais os tokens de usuário são enviados para entrada ou os URIs de redirecionamento para os quais os códigos de autorização e os tokens de acesso do OAuth 2.0 são enviados.

Propriedade Valor
Parameter group: web Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Output format.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False