Compartilhar via

az ad sp

  • Referência

Gerenciar entidades de serviço do Microsoft Entra.

Comandos

Nome Description Tipo Status
az ad sp create

Crie uma entidade de serviço.

 Núcleo GA
az ad sp create-for-rbac

Crie uma entidade de serviço e configure o acesso dela aos recursos do Azure.

 Núcleo GA
az ad sp credential

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

 Núcleo GA
az ad sp credential delete

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

 Núcleo GA
az ad sp credential list

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

 Núcleo GA
az ad sp credential reset

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

 Núcleo GA
az ad sp delete

Excluir uma entidade de serviço.

 Núcleo GA
az ad sp list

Listar entidades de serviço.

 Núcleo GA
az ad sp owner

Gerenciar proprietários de entidades de serviço.

 Núcleo GA
az ad sp owner list

Listar proprietários de entidade de serviço.

 Núcleo GA
az ad sp show

Obtenha os detalhes de uma entidade de serviço.

 Núcleo GA
az ad sp update

Atualizar uma entidade de serviço.

 Núcleo GA

az ad sp create

Editar

Crie uma entidade de serviço.

az ad sp create --id

Exemplos

Crie uma entidade de serviço. (gerado automaticamente)

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

Parâmetros Exigidos

--id

Uri do identificador, id do aplicativo ou id do objeto do aplicativo associado.

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ad sp create-for-rbac

Editar

Crie uma entidade de serviço e configure o acesso dela aos recursos do Azure.

A saída inclui credenciais que você deve proteger. Lembre-se de não incluir essas credenciais em seu código ou de verificar as credenciais em seu controle do código-fonte. Como alternativa, considere usar as identidades gerenciadas, se estiverem disponíveis, para evitar a necessidade de usar credenciais.

Por padrão, esse comando não atribui nenhuma função à entidade de serviço. Você pode usar --role e --scopes 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 mais tarde. Consulte as etapas para adicionar uma atribuição de função para obter mais informações.

az ad sp create-for-rbac [--cert]
                         [--create-cert]
                         [--display-name]
                         [--json-auth {false, true}]
                         [--keyvault]
                         [--role]
                         [--scopes]
                         [--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 função de Colaborador atribuições em escopos especificados. Para recuperar a ID de 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

Crie usando um certificado autoassinado.

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

Crie usando um certificado autoassinado e armazene-o no KeyVault.

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

Crie usando o certificado existente no KeyVault.

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

Parâmetros Opcionais

--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 a partir de um arquivo. Não inclua informações de chave privada.

--create-cert

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

Valor padrão: False
--display-name --name -n

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

--json-auth --sdk-auth
Preterido

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

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

Valores aceitos: false, true
--keyvault

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

--role

Função da entidade de serviço.

--scopes

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

--years

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

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ad sp delete

Editar

Excluir uma entidade de serviço.

az ad sp delete --id

Exemplos

Excluir 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 o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ad sp list

Editar

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

--all

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

--display-name

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 de propriedade do usuário atual.

--spn

Nome da entidade de serviço.

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ad sp show

Editar

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 URI de 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 o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ad sp update

Editar

Atualizar 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

--add

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

Valor padrão: []
--force-string

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

Valor padrão: False
--remove

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

Valor padrão: []
--set

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

Valor padrão: []
Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.