Partilhar via


az identity federated-credential

Gerencie credenciais de identidade federada em identidades atribuídas pelo usuário.

Comandos

Name Description Tipo Status
az identity federated-credential create

Crie uma credencial de identidade federada sob uma identidade atribuída ao usuário existente.

Core disponibilidade geral
az identity federated-credential delete

Exclua uma credencial de identidade federada sob uma identidade atribuída ao usuário existente.

Core disponibilidade geral
az identity federated-credential list

Liste todas as credenciais de identidade federada sob uma identidade atribuída ao usuário existente.

Core disponibilidade geral
az identity federated-credential show

Mostrar uma credencial de identidade federada sob uma identidade atribuída ao usuário existente.

Core disponibilidade geral
az identity federated-credential update

Atualize uma credencial de identidade federada sob uma identidade atribuída ao usuário existente.

Core disponibilidade geral

az identity federated-credential create

Crie uma credencial de identidade federada sob uma identidade atribuída ao usuário existente.

az identity federated-credential create --identity-name
                                        --name
                                        --resource-group
                                        [--audiences]
                                        [--claims-matching-expression-value --cme-value]
                                        [--claims-matching-expression-version --cme-version]
                                        [--issuer]
                                        [--subject]

Exemplos

Crie uma credencial de identidade federada sob uma identidade atribuída ao usuário específico usando o assunto.

az identity federated-credential create --name myFicName --identity-name myIdentityName --resource-group myResourceGroup --issuer myIssuer --subject mySubject --audiences myAudiences

Crie uma credencial de identidade federada sob uma identidade atribuída ao usuário específico usando claimsMatchingExpression.

az identity federated-credential create --name myFicName --identity-name myIdentityName --resource-group myResourceGroup --issuer myIssuer --claims-matching-expression-version 1 --claims-matching-expression-value "claims['sub'] eq 'foo'" --audiences myAudiences

Parâmetros Obrigatórios

--identity-name

O nome do recurso de identidade.

--name -n

O nome do recurso de credencial de identidade federada.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--audiences

O valor aud no token enviado ao Azure para obter o token de identidade gerenciado atribuído pelo usuário. O valor configurado na credencial federada e o do token de entrada devem corresponder exatamente para que o Azure emita o token de acesso. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Default value: ['api://AzureADTokenExchange']
--claims-matching-expression-value --cme-value
Pré-visualizar

A expressão baseada em curinga para a correspondência de declarações de entrada. Não pode ser usado com --subject.

Propriedade Valor
Grupo de parâmetros: ClaimsMatchingExpression Arguments
--claims-matching-expression-version --cme-version
Pré-visualizar

Especifica a versão da expressão de correspondência de declarações usada na expressão.

Propriedade Valor
Grupo de parâmetros: ClaimsMatchingExpression Arguments
--issuer

A URL de metadados de conexão openId do emissor do provedor de identidade que o Azure AD usaria no protocolo de troca de tokens para validar tokens antes de emitir um token como a identidade gerenciada atribuída pelo usuário.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--subject

O subvalor no token enviado ao Azure AD para obter o token de identidade gerenciado atribuído pelo usuário. O valor configurado na credencial federada e o do token de entrada devem corresponder exatamente para que o Azure AD emita o token de acesso. Ou 'subject' ou 'claimsMatchingExpression' devem ser definidos, mas não ambos.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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.

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az identity federated-credential delete

Exclua uma credencial de identidade federada sob uma identidade atribuída ao usuário existente.

az identity federated-credential delete --identity-name
                                        --name
                                        --resource-group
                                        [--yes]

Exemplos

Exclua uma credencial de identidade federada sob uma identidade atribuída a um usuário específico.

az identity federated-credential delete --name myFicName --identity-name myIdentityName --resource-group myResourceGroup

Parâmetros Obrigatórios

--identity-name

O nome do recurso de identidade.

--name -n

O nome do recurso de credencial de identidade federada.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--yes -y

Não solicite confirmação.

Propriedade Valor
Default value: False
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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.

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az identity federated-credential list

Liste todas as credenciais de identidade federada sob uma identidade atribuída ao usuário existente.

az identity federated-credential list --identity-name
                                      --resource-group
                                      [--max-items]
                                      [--next-token]
                                      [--skiptoken]
                                      [--top]

Exemplos

Liste todas as credenciais de identidade federada sob uma identidade atribuída ao usuário existente.

az identity federated-credential list --identity-name myIdentityName --resource-group myResourceGroup

Parâmetros Obrigatórios

--identity-name

O nome do recurso de identidade.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--max-items

Número total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um token será fornecido na saída do comando. Para retomar a paginação, forneça o valor do token em --next-token argumento de um comando subsequente.

Propriedade Valor
Grupo de parâmetros: Pagination Arguments
--next-token

Token para especificar por onde começar a paginar. Este é o valor de token de uma resposta truncada anteriormente.

Propriedade Valor
Grupo de parâmetros: Pagination Arguments
--skiptoken

Um token de pulo é usado para continuar recuperando itens depois que uma operação retorna um resultado parcial. Se uma resposta anterior contiver um elemento nextLink, o valor do elemento nextLink incluirá um parâmetro skipToken que especifica um ponto de partida a ser usado para chamadas subsequentes.

--top

Número de registos a devolver.

Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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.

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az identity federated-credential show

Mostrar uma credencial de identidade federada sob uma identidade atribuída ao usuário existente.

az identity federated-credential show --identity-name
                                      --name
                                      --resource-group

Exemplos

Mostrar uma credencial de identidade federada sob uma identidade atribuída ao usuário específico.

az identity federated-credential show --name myFicName --identity-name myIdentityName --resource-group myResourceGroup

Parâmetros Obrigatórios

--identity-name

O nome do recurso de identidade.

--name -n

O nome do recurso de credencial de identidade federada.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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.

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az identity federated-credential update

Atualize uma credencial de identidade federada sob uma identidade atribuída ao usuário existente.

az identity federated-credential update --identity-name
                                        --name
                                        --resource-group
                                        [--add]
                                        [--audiences]
                                        [--claims-matching-expression-value --cme-value]
                                        [--claims-matching-expression-version --cme-version]
                                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--issuer]
                                        [--remove]
                                        [--set]
                                        [--subject]

Exemplos

Atualize uma credencial de identidade federada sob uma identidade atribuída ao usuário específico usando o assunto.

az identity federated-credential update --identity-name myIdentityName --name myFicName --resource-group myResourceGroup --issuer myIssuer --subject mySubject --audiences myAudiences

Atualize uma credencial de identidade federada sob uma identidade atribuída a um usuário específico usando claimsMatchingExpression.

az identity federated-credential update --identity-name myIdentityName --name myFicName --resource-group myResourceGroup --issuer myIssuer --claims-matching-expression-version 1 --claims-matching-expression-value "claims['sub'] eq 'foo'" --audiences myAudiences

Parâmetros Obrigatórios

--identity-name

O nome do recurso de identidade.

--name -n

O nome do recurso de credencial de identidade federada.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--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
Grupo de parâmetros: Generic Update Arguments
--audiences

O valor aud no token enviado ao Azure para obter o token de identidade gerenciado atribuído pelo usuário. O valor configurado na credencial federada e o do token de entrada devem corresponder exatamente para que o Azure emita o token de acesso. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--claims-matching-expression-value --cme-value
Pré-visualizar

A expressão baseada em curinga para a correspondência de declarações de entrada. Não pode ser usado com --subject.

Propriedade Valor
Grupo de parâmetros: ClaimsMatchingExpression Arguments
--claims-matching-expression-version --cme-version
Pré-visualizar

Especifica a versão da expressão de correspondência de declarações usada na expressão.

Propriedade Valor
Grupo de parâmetros: ClaimsMatchingExpression Arguments
--force-string

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--issuer

A URL de metadados de conexão openId do emissor do provedor de identidade que o Azure AD usaria no protocolo de troca de tokens para validar tokens antes de emitir um token como a identidade gerenciada atribuída pelo usuário.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--remove

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--set

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--subject

O subvalor no token enviado ao Azure AD para obter o token de identidade gerenciado atribuído pelo usuário. O valor configurado na credencial federada e o do token de entrada devem corresponder exatamente para que o Azure AD emita o token de acesso. Ou 'subject' ou 'claimsMatchingExpression' devem ser definidos, mas não ambos.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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.

--subscription

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

--verbose

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

Propriedade Valor
Default value: False