Partilhar via

Items - List Item Connections

Serviço:
Core
Versão da API:
v1

Retorna a lista de conexões às quais o item especificado está conectado.
Esta API suporta paginação.

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 o artigo Escopos.

Limitações

Essa API é bloqueada para um item com um rótulo de sensibilidade protegido, a menos que o chamador tenha os direitos de uso para excluir o rótulo de sensibilidade.

Identidades suportadas pelo Entra da Microsoft

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

Identidade Apoio
Utilizador Sim
Entidade de serviço e identidades geridas Sim

Interfaz

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/connections
Com parâmetros opcionais: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/connections?continuationToken={continuationToken}

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.
continuationToken
 query

string

Um token para recuperar a próxima página de resultados.

Respostas

Name Tipo Description
200 OK

ItemConnections

Pedido concluído com sucesso.
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • ItemNotFound - Indica que o servidor não consegue localizar o item solicitado.

Exemplos

List item connections - Semantic Model Direct Lake example
List item connections example
List item connections with continuation example

List item connections - Semantic Model Direct Lake example

Pedido de amostra

GET https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/connections

Resposta da amostra

Código de estado:
200 
{
  "value": [
    {
      "connectivityType": "Automatic",
      "connectionDetails": {
        "type": "SQL",
        "path": "xqoruksalslrtkdxe2bvrlwgsi-5j2iqepw1i3ucdp6bepe62hcii.datawarehouse.fabric.microsoft.com;532183f5-ac60-4d12-0fc5-4094532f14b5"
      }
    }
  ]
}

List item connections example

Pedido de amostra

GET https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/connections

Resposta da amostra

Código de estado:
200 
{
  "value": [
    {
      "connectivityType": "ShareableCloud",
      "displayName": "ContosoConnection1",
      "id": "6952a7b2-aea3-414f-9d85-6c0fe5d34539",
      "connectionDetails": {
        "type": "Web",
        "path": "https://www.contoso.com"
      }
    },
    {
      "connectivityType": "OnPremisesGateway",
      "displayName": "ContosoConnection2",
      "id": "0b9af1bd-e974-4893-8947-d89d5a560385",
      "gatewayId": "58376c10-5f61-4024-887e-748df4beae45",
      "connectionDetails": {
        "type": "SQL",
        "path": "contoso.database.windows.net;sales"
      }
    }
  ]
}

List item connections with continuation example

Pedido de amostra

GET https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/connections

Resposta da amostra

Código de estado:
200 
{
  "value": [
    {
      "connectivityType": "Automatic",
      "connectionDetails": {
        "type": "SQL",
        "path": "xqoruksalslrtkdxe2bvrlwgsi-5j2iqepw1i3ucdp6bepe62hcii.datawarehouse.fabric.microsoft.com;532183f5-ac60-4d12-0fc5-4094532f14b5"
      }
    }
  ]
}

Definições

Name Description
ConnectivityType

O tipo de conectividade da conexão. Tipos de conectividade adicionais podem ser adicionados ao longo do tempo.
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
ItemConnection
ItemConnections
ListConnectionDetails

A saída de detalhes de conexão para operações de lista.

ConnectivityType

Enumeração

O tipo de conectividade da conexão. Tipos de conectividade adicionais podem ser adicionados ao longo do tempo.

Valor Description
ShareableCloud

A conexão se conecta através da nuvem e pode ser compartilhada com outras pessoas.
PersonalCloud

A conexão se conecta através da nuvem e não pode ser compartilhada com outras pessoas.
OnPremisesGateway

A conexão se conecta por meio de um gateway de dados local.
OnPremisesGatewayPersonal

A conexão se conecta por meio de um gateway de dados pessoal local.
VirtualNetworkGateway

A conexão se conecta através de um gateway de dados de rede virtual.
Automatic

A conexão se conecta através da nuvem usando uma conexão de dados implícita. Essa opção só está disponível para cenários específicos, como modelos semânticos que usam SSO (Single Sign-On)."
None

A conexão não está vinculada

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name Tipo Description
resourceId

string

A ID do recurso envolvida 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

Os detalhes do recurso relacionados ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da 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.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

ItemConnection

Object
Name Tipo Description
connectionDetails

ListConnectionDetails

Os detalhes da conexão da conexão.
connectivityType

ConnectivityType

O tipo de conectividade da conexão.
displayName

string

O nome para exibição da conexão. O comprimento máximo é de 200 caracteres.
gatewayId

string (uuid)

O ID do objeto de gateway da conexão.
id

string (uuid)

O ID do objeto da conexão.

ItemConnections

Object
Name Tipo Description
continuationToken

string

O token para o próximo lote de conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
continuationUri

string

O URI do próximo lote de conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
value

ItemConnection[]

Uma lista de conexões de item

ListConnectionDetails

Object

A saída de detalhes de conexão para operações de lista.

Name Tipo Description
path

string

O caminho da conexão.
type

string

O tipo de conexão.