Partilhar via

az ad app

  • Referência

Gerencie aplicativos Microsoft Entra.

Comandos

Name Description Tipo Status
az ad app create

Crie um aplicativo.

 Principal GA
az ad app credential

Gerencie a senha ou as credenciais de certificado de um aplicativo.

 Principal GA
az ad app credential delete

Exclua a senha ou as credenciais de certificado de um aplicativo.

 Principal GA
az ad app credential list

Liste os metadados de senha ou credencial de certificado de um aplicativo. (O conteúdo da senha ou credencial de certificado não pode ser recuperado.)

 Principal GA
az ad app credential reset

Redefina a senha ou as credenciais de certificado de um aplicativo.

 Principal GA
az ad app delete

Excluir um aplicativo.

 Principal GA
az ad app federated-credential

Gerencie credenciais de identidade federada de aplicativos.

 Principal GA
az ad app federated-credential create

Crie uma credencial de identidade federada de aplicativo.

 Principal GA
az ad app federated-credential delete

Exclua a credencial de identidade federada do aplicativo.

 Principal GA
az ad app federated-credential list

Listar credenciais de identidade federada do aplicativo.

 Principal GA
az ad app federated-credential show

Mostrar credencial de identidade federada do aplicativo.

 Principal GA
az ad app federated-credential update

Atualize a credencial de identidade federada do aplicativo.

 Principal GA
az ad app list

Listar aplicativos.

 Principal GA
az ad app owner

Gerencie proprietários de aplicativos.

 Principal GA
az ad app owner add

Adicione um proprietário de aplicativo.

 Principal GA
az ad app owner list

Listar proprietários de aplicativos.

 Principal GA
az ad app owner remove

Remova um proprietário de aplicativo.

 Principal GA
az ad app permission

Gerencie as permissões OAuth2 de um aplicativo.

 Principal GA
az ad app permission add

Adicione uma permissão de API.

 Principal GA
az ad app permission admin-consent

Conceder permissões delegadas ao Aplicativo & por meio do consentimento do administrador.

 Principal GA
az ad app permission delete

Remova uma permissão de API.

 Principal GA
az ad app permission grant

Conceda ao aplicativo permissões delegadas de API.

 Principal GA
az ad app permission list

Listar permissões de API que o aplicativo solicitou.

 Principal GA
az ad app permission list-grants

Listar concessões de permissão Oauth2.

 Principal GA
az ad app show

Obtenha os detalhes de uma candidatura.

 Principal GA
az ad app update

Atualize um aplicativo.

 Principal GA

az ad app create

Editar

Crie um aplicativo.

Para obter documentação mais detalhada, consulte https://docs.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]
                 [--required-resource-accesses]
                 [--sign-in-audience {AzureADMultipleOrgs, AzureADMyOrg, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount}]
                 [--start-date]
                 [--web-home-page-url]
                 [--web-redirect-uris]

Exemplos

Crie um aplicativo.

az ad app create --display-name mytestapp

Crie um aplicativo que pode retornar ao cliente público com a permissão delegada do Microsoft Graph User.Read

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 Obrigatórios

--display-name

O nome para exibição do aplicativo.

Parâmetros Opcionais

--app-roles

A coleção de funções atribuídas ao aplicativo. Com as 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 in-line. Veja exemplos para detalhes.

--enable-access-token-issuance

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

Valores aceites: 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.

Valores aceites: false, true
--end-date

Data ou data/hora 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.

--identifier-uris

Valores separados por espaço. Também conhecido como URI de ID de 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 sua API e deve ser globalmente exclusivo. Você pode usar o valor padrão fornecido, que está no formato api://, ou especificar um URI mais legível como https://contoso.com/api.

--is-fallback-public-client

Especifica o tipo de aplicativo de fallback como cliente público, como um aplicativo instalado em execução 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.

Valores aceites: false, true
--key-display-name

Nome amigável para a chave.

--key-type

O tipo das credenciais de chave associadas ao aplicativo.

Valores aceites: AsymmetricX509Cert, Password, Symmetric
Default value: AsymmetricX509Cert
--key-usage

O uso das credenciais de chave associadas ao aplicativo.

Valores aceites: Sign, Verify
Default value: Verify
--key-value

O valor para as credenciais de chave associadas ao aplicativo.

--optional-claims

Os desenvolvedores de aplicativos podem configurar declarações opcionais em seus aplicativos Microsoft Entra para especificar as declarações que são enviadas para seu aplicativo pelo serviço de token de segurança da Microsoft. Para obter mais informações, veja https://docs.microsoft.com/azure/active-directory/develop/active-directory-optional-claims. Deve ser o caminho do arquivo JSON ou a cadeia de caracteres JSON in-line. Veja exemplos para detalhes.

--public-client-redirect-uris

Valores separados por espaço. Especifica as URLs para onde os tokens de usuário são enviados para entrada ou os URIs de redirecionamento para onde os códigos de autorização e os tokens de acesso do OAuth 2.0 são enviados.

--required-resource-accesses

Especifica 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 in-line. Veja exemplos para detalhes.

--sign-in-audience

Especifica as contas da Microsoft com suporte para o aplicativo atual.

Valores aceites: AzureADMultipleOrgs, AzureADMyOrg, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount
--start-date

Data ou hora 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.

--web-home-page-url

Página inicial ou página de destino do aplicativo.

--web-redirect-uris

Valores separados por espaço. Especifica as URLs para onde os tokens de usuário são enviados para entrada ou os URIs de redirecionamento para onde os códigos de autorização e os tokens de acesso do OAuth 2.0 são enviados.

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az ad app delete

Editar

Excluir um aplicativo.

az ad app delete --id

Exemplos

Excluir um aplicativo. (gerado automaticamente)

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

Parâmetros Obrigatórios

--id

Uri do identificador, ID do aplicativo ou ID do objeto.

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az ad app list

Editar

Listar aplicativos.

Para latência baixa, por padrão, apenas 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

--all

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

--app-id

Id do aplicativo.

--display-name

O nome para exibição do aplicativo.

--filter

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

--identifier-uri

O identificador do aplicativo gráfico deve estar no formato uri.

--show-mine

Listar entidades de propriedade do usuário atual.

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az ad app show

Editar

Obtenha os detalhes de uma candidatura.

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 uma aplicação com id.

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

Obtenha os detalhes de um aplicativo com URI de identificador.

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

Parâmetros Obrigatórios

--id

Uri do identificador, ID do aplicativo ou ID do objeto.

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az ad app update

Editar

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]
                 [--required-resource-accesses]
                 [--set]
                 [--sign-in-audience {AzureADMultipleOrgs, AzureADMyOrg, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount}]
                 [--start-date]
                 [--web-home-page-url]
                 [--web-redirect-uris]

Exemplos

Atualizar um aplicativo com permissão delegada do 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"
        }
   ]
}]

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 Obrigatórios

--id

Uri do identificador, ID do aplicativo ou ID do objeto.

Parâmetros Opcionais

--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>.

Default value: []
--app-roles

A coleção de funções atribuídas ao aplicativo. Com as 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 in-line. Veja exemplos para detalhes.

--display-name

O nome para 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.

Valores aceites: 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.

Valores aceites: false, true
--end-date

Data ou data/hora 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.

--force-string

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

Default value: False
--identifier-uris

Valores separados por espaço. Também conhecido como URI de ID de 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 sua API e deve ser globalmente exclusivo. Você pode usar o valor padrão fornecido, que está no formato api://, ou especificar um URI mais legível como https://contoso.com/api.

--is-fallback-public-client

Especifica o tipo de aplicativo de fallback como cliente público, como um aplicativo instalado em execução 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.

Valores aceites: false, true
--key-display-name

Nome amigável para a chave.

--key-type

O tipo das credenciais de chave associadas ao aplicativo.

Valores aceites: AsymmetricX509Cert, Password, Symmetric
Default value: AsymmetricX509Cert
--key-usage

O uso das credenciais de chave associadas ao aplicativo.

Valores aceites: Sign, Verify
Default value: Verify
--key-value

O valor para as credenciais de chave associadas ao aplicativo.

--optional-claims

Os desenvolvedores de aplicativos podem configurar declarações opcionais em seus aplicativos Microsoft Entra para especificar as declarações que são enviadas para seu aplicativo pelo serviço de token de segurança da Microsoft. Para obter mais informações, veja https://docs.microsoft.com/azure/active-directory/develop/active-directory-optional-claims. Deve ser o caminho do arquivo JSON ou a cadeia de caracteres JSON in-line. Veja exemplos para detalhes.

--public-client-redirect-uris

Valores separados por espaço. Especifica as URLs para onde os tokens de usuário são enviados para entrada ou os URIs de redirecionamento para onde os códigos de autorização e os tokens de acesso do OAuth 2.0 são enviados.

--remove

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

Default value: []
--required-resource-accesses

Especifica 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 in-line. Veja exemplos para detalhes.

--set

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

Default value: []
--sign-in-audience

Especifica as contas da Microsoft com suporte para o aplicativo atual.

Valores aceites: AzureADMultipleOrgs, AzureADMyOrg, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount
--start-date

Data ou hora 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.

--web-home-page-url

Página inicial ou página de destino do aplicativo.

--web-redirect-uris

Valores separados por espaço. Especifica as URLs para onde os tokens de usuário são enviados para entrada ou os URIs de redirecionamento para onde os códigos de autorização e os tokens de acesso do OAuth 2.0 são enviados.

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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