Items - Associate Identity (beta)

Serviço:: Core

Versão da API:: v1

Associa a identidade padrão a um item.

Observação

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

Esta API suporta operações de longa duração (LRO).

Esta API é suportada para vários tipos de itens, localize os tipos de itens suportados e informações sobre a sua estrutura de definição no 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
Âmbito específico: itemType. ReadWrite.All (por exemplo: Notebook.ReadWrite.All)

Para obter mais informações sobre escopos, consulte: Escopos Artigo.

Identidades suportadas pela Microsoft Entra

Esta API suporta as Microsoft c0 listadas nesta secção.

Identidade	Suporte
User	Sim
Entidade de serviço e identidades geridas	Quando o tipo de item na chamada é suportado. Verifique a API correspondente para o tipo de item que você está chamando para ver se sua chamada é suportada.

Interface

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
itemId	path	True	string (uuid)	O ID do item.
workspaceId	path	True	string (uuid)	O ID do espaço de trabalho.
beta	query	True	boolean	Este parâmetro exigido deve ser definido para `true` aceder a esta API, que está atualmente em beta.

Corpo do Pedido

Name	Necessário	Tipo	Description
assignmentType	True	IdentityAssignmentEntityType	O tipo de sujeito que faz um pedido de identidade associada.

Respostas

Name	Tipo	Description
200 OK	UpdateItemIdentityResponse	Pedido concluído com sucesso.
202 Accepted		Pedido aceite, associação de identidade está em andamento. Cabeçalhos Location: string Retry-After: integer
429 Too Many Requests	ErrorResponse	O limite de tarifa de serviço foi ultrapassado. O servidor devolve um `Retry-After` cabeçalho que indica, em segundos, quanto tempo o cliente deve esperar antes de enviar pedidos adicionais. Cabeçalhos Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: ItemNotFound - O item solicitado não foi encontrado. InvalidRequest - Pedido de associação inválido.

Exemplos

Associate identity example

Pedido de amostra

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 da amostra

Código de estado:: 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 estado:: 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

Name	Description
ErrorRelatedResource	Os detalhes do objeto de recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes do erro na resposta.
IdentityAssignmentEntityType	O tipo de sujeito que faz um pedido de identidade associada.
IdentityAssignmentStatusType	O estado da atribuição de identidade. Status adicional pode ser adicionado ao longo do tempo.
ItemAssignmentStatus	O estado de uma atribuição de identidade a um item.
UpdateItemIdentityRequest	Carga útil de pedido de identidade associada.
UpdateItemIdentityResponse	Resposta de identidade associada.

ErrorRelatedResource

Object

Os detalhes do objeto de recurso relacionado ao erro.

Name	Tipo	Description
resourceId	string	O ID do recurso envolvido no erro.
resourceType	string	O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

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

ErrorResponseDetails

Object

Os detalhes do erro na resposta.

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

IdentityAssignmentEntityType

Enumeração

O tipo de sujeito que faz um pedido de identidade associada.

Valor	Description
Caller	Utilizador ou principal de serviço que faz o pedido de identidade do associado.

IdentityAssignmentStatusType

Enumeração

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

Valor	Description
Succeeded	A identidade é atribuída com sucesso ao item.
Failed	A atribuição de identidade falhou.

ItemAssignmentStatus

Object

O estado de uma atribuição de identidade a um item.

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

UpdateItemIdentityRequest

Object

Carga útil de pedido de identidade associada.

Name	Tipo	Description
assignmentType	IdentityAssignmentEntityType	O tipo de sujeito que faz um pedido de identidade associada.

UpdateItemIdentityResponse

Object

Resposta de identidade associada.

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