Items - Associate Identity (beta)

Serviço:: Core

Versão da API:: v1

Associa a identidade padrão a um item.

Observação

Essa API faz parte de uma versão Beta e é fornecida apenas para fins de avaliação e desenvolvimento. Ele pode mudar com base nos comentários e não é recomendado para uso em produção. Ao chamar essa API, os chamadores devem especificar true como o valor do parâmetro betade consulta.

Essa API dá suporte a LRO (operações de execução longa).

Essa API tem suporte para vários tipos de item, encontre os tipos de item com suporte e informações sobre sua estrutura de definição em Visão geral do gerenciamento de itens.

Permissões

O chamador deve ter permissões de leitura e gravação para o item.

Escopos delegados necessários

Para APIs de item, use estes tipos de escopo:

Escopo genérico: Item.ReadWrite.All
Escopo específico: itemType. ReadWrite.All (por exemplo: Notebook.ReadWrite.All)

para obter mais informações sobre escopos, consulte: artigo de escopos.

Microsoft Entra identidades com suporte

Essa API dá suporte aos Microsoft identities listados nesta seção.

Identity	Suporte
Usuário	Sim
Entidade de serviço e identidades gerenciadas	Quando há suporte para o tipo de item na chamada. Verifique a API correspondente para o tipo de item que você está chamando para ver se a chamada tem suporte.

Interfase

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/identities/default/assign?beta={beta}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
itemId	path	True	string (uuid)	A ID do item.
workspaceId	path	True	string (uuid)	O identificador do espaço de trabalho.
beta	query	True	boolean	Esse parâmetro necessário deve ser definido para `true` acessar essa API, que está atualmente em beta.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
assignmentType	True	IdentityAssignmentEntityType	O tipo de assunto que faz uma solicitação de identidade de associação.

Respostas

Nome	Tipo	Description
200 OK	UpdateItemIdentityResponse	Solicitação concluída com êxito.
202 Accepted		Solicitação aceita, associação de identidade está em andamento. Cabeçalhos Location: string Retry-After: integer
429 Too Many Requests	ErrorResponse	O limite de taxa de serviço foi excedido. O servidor retorna um `Retry-After` cabeçalho indicando, em segundos, quanto tempo o cliente deve aguardar antes de enviar solicitações adicionais. Cabeçalhos Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: ItemNotFound - O item solicitado não foi encontrado. InvalidRequest – Solicitação de associação inválida.

Exemplos

Associate identity example

Solicitação de exemplo

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715/identities/default/assign?beta=True

{
  "assignmentType": "Caller"
}

Resposta de exemplo

Código de status:: 200

{
  "assignmentStatus": [
    {
      "itemId": "eab1679a-8cab-40d6-9ba6-5c2a07a7ce81",
      "status": "Succeeded"
    },
    {
      "itemId": "8eedb1b0-3af8-4b17-8e7e-663e61e12211",
      "parentItemId": "eab1679a-8cab-40d6-9ba6-5c2a07a7ce81",
      "status": "Succeeded"
    },
    {
      "itemId": "83b128a3-f58f-4eee-ab0b-e7e25a748f54",
      "parentItemId": "eab1679a-8cab-40d6-9ba6-5c2a07a7ce81",
      "status": "Failed",
      "errorInfo": {
        "errorCode": "AssignmentFailed",
        "message": "The assignment operation failed due to insufficient permissions."
      }
    }
  ]
}

Código de status:: 202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Definições

Nome	Description
ErrorRelatedResource	O objeto relacionado ao erro nos detalhes do recurso.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
IdentityAssignmentEntityType	O tipo de assunto que faz uma solicitação de identidade de associação.
IdentityAssignmentStatusType	O status da atribuição de identidade. Status adicional pode ser adicionado ao longo do tempo.
ItemAssignmentStatus	O status de uma atribuição de identidade para um item.
UpdateItemIdentityRequest	Associar conteúdo da solicitação de identidade.
UpdateItemIdentityResponse	Associar resposta de identidade.

ErrorRelatedResource

Objeto

O objeto relacionado ao erro nos detalhes do recurso.

Nome	Tipo	Description
resourceId	string	O identificador do recurso envolvido no erro.
resourceType	string	O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.
requestId	string (uuid)	ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.

IdentityAssignmentEntityType

Enumeração

O tipo de assunto que faz uma solicitação de identidade de associação.

Valor	Description
Caller	Usuário ou entidade de serviço que faz a solicitação de identidade associada.

IdentityAssignmentStatusType

Enumeração

O status da atribuição de identidade. Status adicional pode ser adicionado ao longo do tempo.

Valor	Description
Succeeded	A identidade é atribuída com êxito ao item.
Failed	Falha na atribuição de identidade.

ItemAssignmentStatus

Objeto

O status de uma atribuição de identidade para um item.

Nome	Tipo	Description
errorInfo	ErrorResponseDetails	As informações de erro se a atribuição de identidade falhou.
itemId	string (uuid)	O ID do item.
parentItemId	string (uuid)	A ID do item pai.
status	IdentityAssignmentStatusType	O status da atribuição de identidade. Status adicional pode ser adicionado ao longo do tempo.

UpdateItemIdentityRequest

Objeto

Associar conteúdo da solicitação de identidade.

Nome	Tipo	Description
assignmentType	IdentityAssignmentEntityType	O tipo de assunto que faz uma solicitação de identidade de associação.

UpdateItemIdentityResponse

Objeto

Associar resposta de identidade.

Nome	Tipo	Description
assignmentStatus	ItemAssignmentStatus[]	A identidade atribuída ao item após a atualização.