Federated Identity Credentials - Create Or Update

Referência

Serviço:: Managed Identity

Versão da API:: 2024-11-30

Crie ou atualize uma credencial de identidade federada sob a identidade atribuída ao usuário especificado.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}/federatedIdentityCredentials/{federatedIdentityCredentialResourceName}?api-version=2024-11-30

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
federatedIdentityCredentialResourceName	path	True	string	O nome do recurso de credencial de identidade federada. Padrão Regex: `^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{2,119}$`
resourceGroupName	path	True	string	O nome do Grupo de Recursos ao qual a identidade pertence.
resourceName	path	True	string	O nome do recurso de identidade.
subscriptionId	path	True	string	O ID da Subscrição a que pertence a identidade.
api-version	query	True	string	Versão da API a invocar.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.audiences	True	string[]	A lista de audiências que podem aparecer no token emitido.
properties.issuer	True	string	O URL do emissor a ser confiável.
properties.subject	True	string	O identificador da identidade externa.

Respostas

Name	Tipo	Description
200 OK	FederatedIdentityCredential	Credencial de identidade federada atualizada.
201 Created	FederatedIdentityCredential	Criada credencial de identidade federada.
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

FederatedIdentityCredentialCreate

Pedido de amostra

HTTP

PUT https://management.azure.com/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourceGroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/resourceName/federatedIdentityCredentials/ficResourceName?api-version=2024-11-30

{
  "properties": {
    "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID",
    "subject": "system:serviceaccount:ns:svcaccount",
    "audiences": [
      "api://AzureADTokenExchange"
    ]
  }
}

Resposta da amostra

Código de estado:: 201

{
  "id": "/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName",
  "name": "ficResourceName",
  "properties": {
    "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID",
    "subject": "system:serviceaccount:ns:svcaccount",
    "audiences": [
      "api://AzureADTokenExchange"
    ]
  },
  "type": "Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials"
}

Código de estado:: 200

{
  "id": "/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName",
  "name": "ficResourceName",
  "properties": {
    "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID",
    "subject": "system:serviceaccount:ns:svcaccount",
    "audiences": [
      "api://AzureADTokenExchange"
    ]
  },
  "type": "Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials"
}

Definições

Name	Description
CloudError	Uma resposta de erro do serviço ManagedServiceIdentity.
CloudErrorBody	Uma resposta de erro do serviço ManagedServiceIdentity.
createdByType	O tipo de identidade que criou o recurso.
FederatedIdentityCredential	Descreve uma credencial de identidade federada.
systemData	Metadados referentes à criação e última modificação do recurso.

CloudError

Uma resposta de erro do serviço ManagedServiceIdentity.

Name	Tipo	Description
error	CloudErrorBody	Uma lista de detalhes adicionais sobre o erro.

CloudErrorBody

Uma resposta de erro do serviço ManagedServiceIdentity.

Name	Tipo	Description
code	string	Um identificador para o erro.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O alvo do erro específico. Por exemplo, o nome da propriedade em erro.

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

FederatedIdentityCredential

Descreve uma credencial de identidade federada.

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.audiences	string[]	A lista de audiências que podem aparecer no token emitido.
properties.issuer	string	O URL do emissor a ser confiável.
properties.subject	string	O identificador da identidade externa.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

systemData

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Partilhar via