Compartilhar via


az ad sp

Gerenciar entidades de serviço do Microsoft Entra.

Comandos

Nome Description Tipo Status
az ad sp create

Crie uma entidade de serviço.

Core GA
az ad sp create-for-rbac

Crie um aplicativo e sua entidade de serviço associada, opcionalmente, configure as atribuições de função RBAC da entidade de serviço.

Core GA
az ad sp credential

Gerenciar as credenciais de senha ou certificado de uma entidade de serviço.

Core GA
az ad sp credential delete

Exclua as credenciais de senha ou certificado de uma entidade de serviço.

Core GA
az ad sp credential list

Listar metadados de senha ou credencial de certificado de uma entidade de serviço. (O conteúdo da credencial de senha ou certificado não é recuperável.).

Core GA
az ad sp credential reset

Redefina as credenciais de senha ou certificado de uma entidade de serviço.

Core GA
az ad sp delete

Exclua uma entidade de serviço.

Core GA
az ad sp list

Listar entidades de serviço.

Core GA
az ad sp owner

Gerenciar proprietários da entidade de serviço.

Core GA
az ad sp owner list

Listar proprietários da entidade de serviço.

Core GA
az ad sp show

Obtenha os detalhes de uma entidade de serviço.

Core GA
az ad sp update

Atualize uma entidade de serviço.

Core GA

az ad sp create

Crie uma entidade de serviço.

az ad sp create --id

Exemplos

Crie uma entidade de serviço. (autogenerated)

az ad sp create --id 00000000-0000-0000-0000-000000000000

Parâmetros Exigidos

--id

Identificador uri, id do aplicativo ou id de objeto do aplicativo associado.

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 sp create-for-rbac

Crie um aplicativo e sua entidade de serviço associada, opcionalmente, configure as atribuições de função RBAC da entidade de serviço.

A saída inclui credenciais que você deve proteger. Certifique-se de que você não inclua essas credenciais em seu código ou verifique as credenciais no controle do código-fonte. As an alternative, consider using managed identities if available to avoid the need to use credentials.

Por padrão, esse comando não atribui nenhuma função à entidade de serviço. Você pode usar escopos --role e --para atribuir uma função específica e restringir o escopo a um recurso ou grupo de recursos. Você também pode usar az role assignment create para criar atribuições de função para essa entidade de serviço posteriormente. Consulte etapas para adicionar uma atribuição de função para obter mais informações.

az ad sp create-for-rbac [--cert]
                         [--create-cert]
                         [--create-password {false, true}]
                         [--display-name --name]
                         [--json-auth --sdk-auth {false, true}]
                         [--keyvault]
                         [--role]
                         [--scopes]
                         [--service-management-reference]
                         [--years]

Exemplos

Criar sem atribuição de função.

az ad sp create-for-rbac

Crie usando um nome de exibição personalizado.

az ad sp create-for-rbac -n MyApp

Crie com uma atribuição de função colaborador em escopos especificados. Para recuperar a ID da assinatura atual, execute 'az account show --query id --output tsv'.

az ad sp create-for-rbac -n MyApp --role Contributor --scopes /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup2

Não crie credencial de senha.

az ad sp create-for-rbac --create-password false

Crie usando um certificado autoassinado.

az ad sp create-for-rbac --create-cert

Crie usando uma cadeia de caracteres de certificado existente.

az ad sp create-for-rbac --cert "MIICoT..."

Crie usando um arquivo de certificado existente.

az ad sp create-for-rbac --cert "@~/cert.pem"
`cert.pem` contains the following content
-----BEGIN CERTIFICATE-----  <<< this line is optional
MIICoT...
-----END CERTIFICATE-----    <<< this line is optional

Crie usando um certificado autoassinado e armazene-o no Azure Key Vault.

az ad sp create-for-rbac --keyvault MyVault --cert CertName --create-cert

Crie usando o certificado existente no Azure Key Vault.

az ad sp create-for-rbac --keyvault MyVault --cert CertName

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.

--cert

Certificado a ser usado para credenciais. Quando usado com --keyvault,, indica o nome do certificado a ser usado ou criado. Caso contrário, forneça uma cadeia de caracteres de certificado público formatada em PEM ou DER. Use @{path} para carregar de um arquivo. Não inclua a chave privada.

Propriedade Valor
Parameter group: keyCredential Arguments
--create-cert

Crie um certificado autoassinado a ser usado para a credencial. Somente o usuário atual do sistema operacional tem permissão de leitura/gravação para esse certificado. Use com --keyvault para criar o certificado no Key Vault. Caso contrário, um certificado será criado localmente.

Propriedade Valor
Parameter group: keyCredential Arguments
Valor padrão: False
--create-password

Crie uma credencial de senha (segredo) no aplicativo. Esse é o comportamento padrão. Defina esse argumento como false para desabilitar a criação de credencial de senha.

Propriedade Valor
Parameter group: Credential Arguments
Valor padrão: True
Valores aceitos: false, true
--display-name --name -n

Nome de exibição da entidade de serviço. Se não estiver presente, o padrão para a azure-cli-%Y-%m-%d-%H-%M-%S em que o sufixo é o momento da criação.

--json-auth --sdk-auth
Preterido

A opção '--sdk-auth' foi preterida e será removida em uma versão futura.

Credencial da entidade de serviço de saída junto com pontos de extremidade de nuvem no formato JSON.

Propriedade Valor
Valores aceitos: false, true
--keyvault

Nome ou ID de um KeyVault a ser usado para criar ou recuperar certificados.

Propriedade Valor
Parameter group: keyCredential Arguments
--role

Função da entidade de serviço.

--scopes

Lista de escopos separados por espaço à qual a atribuição de função da entidade de serviço se aplica. por exemplo, assinaturas/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup, /subscriptions/0b1f6471-1bf0-4dda-aec3-1111222223333/resourceGroups/myGroup/providers/Microsoft.Compute/virtualMachines/myVM.

--service-management-reference

Defina a propriedade serviceManagementReference do aplicativo criado. Fazer referência a informações de contato do aplicativo ou serviço de um banco de dados de Serviço ou Gerenciamento de Ativos.

--years

Número de anos para os quais as credenciais serão válidas. Padrão: 1 ano.

Propriedade Valor
Parameter group: Credential 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 sp delete

Exclua uma entidade de serviço.

az ad sp delete --id

Exemplos

Exclua uma entidade de serviço.

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

Parâmetros Exigidos

--id

Nome da entidade de serviço ou ID do 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 sp list

Listar entidades de serviço.

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 sp list [--all]
              [--display-name]
              [--filter]
              [--show-mine]
              [--spn]

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.

--display-name

O nome de exibição do objeto ou seu prefixo.

--filter

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

--show-mine

Listar entidades pertencentes ao usuário atual.

--spn

Nome da entidade de serviço.

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 sp show

Obtenha os detalhes de uma entidade de serviço.

az ad sp show --id

Exemplos

Obtenha os detalhes de uma entidade de serviço com appId.

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

Obtenha os detalhes de uma entidade de serviço com id.

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

Obtenha os detalhes de uma entidade de serviço com o URI do identificador.

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

Parâmetros Exigidos

--id

Nome da entidade de serviço ou ID do 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 sp update

Atualize uma entidade de serviço.

az ad sp update --id
                [--add]
                [--force-string]
                [--remove]
                [--set]

Exemplos

atualizar uma entidade de serviço (gerada automaticamente)

az ad sp update --id 00000000-0000-0000-0000-000000000000 --set groupMembershipClaims=All

Parâmetros Exigidos

--id

Nome da entidade de serviço ou ID do 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: []
--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
--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: []
--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: []
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