OneLake Shortcuts - List Shortcuts

Serviço:: Core

Versão da API:: v1

Retorna uma lista de atalhos para o item, incluindo todas as subpastas exaustivamente.

Escopos delegados necessários

OneLake.Read.All ou OneLake.ReadWrite.All

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

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

Interfase

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/shortcuts

Com parâmetros opcionais:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/shortcuts?parentPath={parentPath}&continuationToken={continuationToken}

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.
continuationToken	query		string	Um token para recuperar a próxima página de resultados.
parentPath	query		string	O caminho inicial do qual recuperar os atalhos

Respostas

Nome	Tipo	Description
200 OK	Shortcuts	Solicitação concluída com êxito.
Other Status Codes	ErrorResponse	Códigos de erro comuns: ItemNotFound – O servidor não pode encontrar o item solicitado. UnknownError – Ocorreu um erro.

Nome

Tipo

Description

200 OK

Shortcuts

Solicitação concluída com êxito.

Other Status Codes

ErrorResponse

Códigos de erro comuns:

ItemNotFound – O servidor não pode encontrar o item solicitado.
UnknownError – Ocorreu um erro.

Exemplos

List shortcuts example

List shortcuts with continuation example

List shortcuts with shortcut transforms example

List shortcuts example

Solicitação de exemplo

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/56bac802-080d-4f73-8a42-1b406eb1fcac/shortcuts

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "path": "Files/blafolder/folder3",
      "name": "MyOneLakeShortcut",
      "target": {
        "type": "OneLake",
        "oneLake": {
          "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
          "itemId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
          "path": "Tables/myTablesFolder/someTableSubFolder"
        }
      }
    },
    {
      "path": "Files/noaccess",
      "name": "MyS3Shortcut",
      "target": {
        "type": "AmazonS3"
      }
    },
    {
      "path": "Files/blafolder/folder3",
      "name": "MyS3CompatibleShortcut",
      "target": {
        "type": "S3Compatible",
        "s3Compatible": {
          "connectionId": "3c976446-0bda-472e-8800-f1d6e4f162dc",
          "location": "https://s3endpoint.contoso.com",
          "bucket": "contosoBucket",
          "subpath": "s3CompatibleDirectory"
        }
      }
    },
    {
      "path": "Files/blafolder/folder3",
      "name": "MyGCSShortcut",
      "target": {
        "type": "GoogleCloudStorage",
        "googleCloudStorage": {
          "connectionId": "5b218778-e7a5-4d73-8187-f10824047715",
          "location": "https://gcs-contosoBucket.storage.googleapis.com",
          "subpath": "gcsDirectory"
        }
      }
    },
    {
      "path": "Files/blafolder/folder3",
      "name": "MyExternalDataShareShortcut",
      "target": {
        "type": "ExternalDataShare",
        "externalDataShare": {
          "connectionId": "af196b7b-0bf8-4430-b383-ad48d14f4edf"
        }
      }
    },
    {
      "path": "Files/bla1folder/folder4",
      "name": "MyDataShareShortcutWithREAD",
      "target": {
        "type": "ExternalDataShare"
      }
    }
  ]
}

List shortcuts with continuation example

Solicitação de exemplo

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/56bac802-080d-4f73-8a42-1b406eb1fcac/shortcuts

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "path": "Files/blafolder/folder3",
      "name": "MyOneLakeShortcut",
      "target": {
        "type": "OneLake",
        "oneLake": {
          "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
          "itemId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
          "path": "Tables/myTablesFolder/someTableSubFolder"
        }
      }
    },
    {
      "path": "Files/noaccess",
      "name": "MyS3Shortcut",
      "target": {
        "type": "AmazonS3"
      }
    },
    {
      "path": "Files/blafolder/folder3",
      "name": "MyS3CompatibleShortcut",
      "target": {
        "type": "S3Compatible",
        "s3Compatible": {
          "connectionId": "3c976446-0bda-472e-8800-f1d6e4f162dc",
          "location": "https://s3endpoint.contoso.com",
          "bucket": "contosoBucket",
          "subpath": "s3CompatibleDirectory"
        }
      }
    },
    {
      "path": "Files/blafolder/folder3",
      "name": "MyGCSShortcut",
      "target": {
        "type": "GoogleCloudStorage",
        "googleCloudStorage": {
          "connectionId": "5b218778-e7a5-4d73-8187-f10824047715",
          "location": "https://gcs-contosoBucket.storage.googleapis.com",
          "subpath": "gcsDirectory"
        }
      }
    },
    {
      "path": "Files/blafolder/folder3",
      "name": "MyExternalDataShareShortcut",
      "target": {
        "type": "ExternalDataShare",
        "externalDataShare": {
          "connectionId": "af196b7b-0bf8-4430-b383-ad48d14f4edf"
        }
      }
    },
    {
      "path": "Files/bla1folder/folder4",
      "name": "MyDataShareShortcutWithREAD",
      "target": {
        "type": "ExternalDataShare"
      }
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/56bac802-080d-4f73-8a42-1b406eb1fcac/shortcuts?continuationToken=LDEsMTAwMDAwLDA%3D"
}

List shortcuts with shortcut transforms example

Solicitação de exemplo

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/56bac802-080d-4f73-8a42-1b406eb1fcac/shortcuts

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "path": "Files/blafolder/folder3",
      "name": "MyOneLakeShortcut",
      "target": {
        "type": "OneLake",
        "oneLake": {
          "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
          "itemId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
          "path": "Tables/myTablesFolder/someTableSubFolder"
        }
      },
      "isShortcutTransform": true
    },
    {
      "path": "Files/blafolder/folder3",
      "name": "MyS3CompatibleShortcut",
      "target": {
        "type": "S3Compatible",
        "s3Compatible": {
          "connectionId": "3c976446-0bda-472e-8800-f1d6e4f162dc",
          "location": "https://s3endpoint.contoso.com",
          "bucket": "contosoBucket",
          "subpath": "s3CompatibleDirectory"
        }
      },
      "isShortcutTransform": true
    }
  ]
}

Definições

Nome	Description
AdlsGen2	Um objeto que contém as propriedades da fonte de dados do ADLS Gen2 de destino.
AmazonS3	Um objeto que contém as propriedades da fonte de dados do Amazon S3 de destino.
AzureBlobStorage	Um objeto que contém as propriedades da fonte de dados do Armazenamento de Blobs do Azure de destino.
CsvToDeltaTransform	Transformação CSV para Delta.
CsvToDeltaTransformProperties	Propriedades da transformação CSV para Delta.
Dataverse	Um objeto que contém as propriedades da fonte de dados do Dataverse de destino.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
ExternalDataShareTarget	Um objeto que contém as propriedades do compartilhamento de dados externo de destino.
GoogleCloudStorage	Um objeto que contém as propriedades da fonte de dados de destino do Google Cloud Storage.
OneLake	Um objeto que contém as propriedades da fonte de dados OneLake de destino.
S3Compatible	Um objeto que contém as propriedades da fonte de dados compatível com S3 de destino.
Shortcuts
ShortcutTransformFlagged	Um objeto que representa uma referência que aponta para outros locais de armazenamento que podem ser internos ou externos ao OneLake. O atalho é definido pelo nome, caminho em que o atalho é criado e o destino que especifica o local de armazenamento de destino.
Target	Um objeto que contém a fonte de dados de destino e deve especificar exatamente um dos destinos com suporte, conforme descrito na tabela abaixo.
Type	O objeto type contém propriedades como o tipo de conta de atalho de destino. Tipos adicionais podem ser adicionados ao longo do tempo.

AdlsGen2

Objeto

Um objeto que contém as propriedades da fonte de dados do ADLS Gen2 de destino.

Nome	Tipo	Description
connectionId	string (uuid)	Uma cadeia de caracteres que representa a conexão associada ao atalho. A connectionId é um identificador exclusivo usado para estabelecer uma conexão entre o atalho e a fonte de dados de destino. Para localizar essa ID de conexão, primeiro crie uma conexão de nuvem a ser usada pelo atalho ao se conectar ao local de dados do ADLS. Abra o modo de exibição Configurações da conexão de nuvem e copie a ID da conexão; este é um GUID.
location	string (uri)	Especifica o local do contêiner do ADLS de destino. O URI deve estar no formato https://[account-name].dfs.core.windows.net, em que [nome da conta] é o nome da conta do ADLS de destino.
subpath	string	Especifica o contêiner e a subpasta dentro da conta do ADLS em que a pasta de destino está localizada. Deve ser do formato [contêiner]/[subpasta] em que [contêiner] é o nome do contêiner que contém os arquivos e pastas; [subpasta] é o nome da subpasta dentro do contêiner (opcional). Por exemplo: /mycontainer/mysubfolder

AmazonS3

Objeto

Um objeto que contém as propriedades da fonte de dados do Amazon S3 de destino.

Nome	Tipo	Description
connectionId	string (uuid)	Uma cadeia de caracteres que representa a conexão associada ao atalho. A connectionId é um identificador exclusivo usado para estabelecer uma conexão entre o atalho e a fonte de dados de destino. Para localizar essa ID de conexão, primeiro crie uma conexão de nuvem a ser usada pelo atalho ao se conectar ao local de dados do Amazon S3. Abra o modo de exibição Configurações da conexão de nuvem e copie a ID da conexão; este é um GUID.
location	string (uri)	URL HTTP que aponta para o bucket de destino em S3. A URL deve estar no formato https://[bucket-name].s3. [region-code].amazonaws.com, em que "bucket-name" é o nome do bucket S3 que você deseja apontar e "region-code" é o código para a região em que o bucket está localizado. Por exemplo: https://my-s3-bucket.s3.us-west-2.amazonaws.com
subpath	string	Especifica uma pasta de destino ou subpasta dentro do bucket S3.

AzureBlobStorage

Objeto

Um objeto que contém as propriedades da fonte de dados do Armazenamento de Blobs do Azure de destino.

Nome	Tipo	Description
connectionId	string (uuid)	Uma cadeia de caracteres que representa a conexão associada ao atalho. A connectionId é um identificador exclusivo usado para estabelecer uma conexão entre o atalho e a fonte de dados de destino. Para localizar essa ID de conexão, primeiro crie uma conexão de nuvem a ser usada pelo atalho ao se conectar ao local de dados do Armazenamento de Blobs do Azure. Abra a exibição de configurações da conexão de nuvem e copie o GUID que é a ID da conexão.
location	string (uri)	Especifica o local do contêiner de Armazenamento de Blobs do Azure de destino. O URI deve estar no formato `https://[account-name].blob.core.windows.net` em que `[account-name]` está o nome da conta de Armazenamento de Blobs do Azure de destino.
subpath	string	Especifica o contêiner e a subpasta na conta do Armazenamento de Blobs do Azure em que a pasta de destino está localizada. Deve ser do formato [contêiner]/[subpasta]. [Contêiner] é o nome do contêiner que contém os arquivos e pastas. [Subpasta] é o nome da subpasta dentro do contêiner e é opcional. Por exemplo: /mycontainer/mysubfolder

CsvToDeltaTransform

Objeto

Transformação CSV para Delta.

Nome	Tipo	Description
properties	CsvToDeltaTransformProperties	Propriedades de transformação CSV para Delta.
type	string: csvToDelta	O tipo de transformação. Tipos de transformação adicionais podem ser adicionados ao longo do tempo.

CsvToDeltaTransformProperties

Objeto

Propriedades da transformação CSV para Delta.

Nome	Tipo	Valor padrão	Description
delimiter	string	,	Especifica o caractere usado para separar valores dentro de uma linha no arquivo CSV e ele deve especificar exatamente um dos valores com suporte: `,`, , , `\t`, `\|`, , `&`. `;` O valor padrão é `,`.
skipFilesWithErrors	boolean	True	Se deve ignorar arquivos com erros. True – Ignorar arquivos com erros, False – Não ignore arquivos com erros. O valor padrão é True.
useFirstRowAsHeader	boolean	True	Se a primeira linha do arquivo CSV deve ser usada como o cabeçalho. True – Use a primeira linha como cabeçalho. False – não use a primeira linha como cabeçalho. O valor padrão é True.

Dataverse

Objeto

Um objeto que contém as propriedades da fonte de dados do Dataverse de destino.

Nome	Tipo	Description
connectionId	string (uuid)	Uma cadeia de caracteres que representa a conexão associada ao atalho. A connectionId é um identificador exclusivo usado para estabelecer uma conexão entre o atalho e a fonte de dados de destino. Para localizar essa ID de conexão, primeiro crie uma conexão de nuvem a ser usada pelo atalho ao se conectar ao local de dados do Dataverse. Abra o modo de exibição Configurações da conexão de nuvem e copie a ID da conexão; este é um GUID.
deltaLakeFolder	string	Especifica o caminho da pasta DeltaLake em que os dados de destino são armazenados.
environmentDomain	string (uri)	URI que indica o nome de domínio do ambiente de destino do Dataverse. O URI deve ser formatado como "https://[orgname].crm[xx].dynamics.com", em que `[orgname]` representa o nome da sua organização do Dataverse.
tableName	string	Especifica o nome da tabela de destino no Dataverse

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome	Tipo	Description
resourceId	string	A ID do recurso envolvida 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	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.

ExternalDataShareTarget

Objeto

Um objeto que contém as propriedades do compartilhamento de dados externo de destino.

Nome	Tipo	Description
connectionId	string (uuid)	Uma cadeia de caracteres que representa a conexão associada ao atalho. A connectionId é um identificador exclusivo usado para estabelecer uma conexão entre o atalho e a fonte de dados de destino.

GoogleCloudStorage

Objeto

Um objeto que contém as propriedades da fonte de dados de destino do Google Cloud Storage.

Nome	Tipo	Description
connectionId	string (uuid)	Uma cadeia de caracteres que representa a conexão associada ao atalho. A connectionId é um identificador exclusivo usado para estabelecer uma conexão entre o atalho e a fonte de dados de destino.
location	string (uri)	URL HTTP que aponta para o bucket de destino no GCS. A URL deve estar no formato https://[bucket-name].storage.googleapis.com, em que [bucket-name] é o nome do bucket para o qual você deseja apontar. Por exemplo: https://my-gcs-bucket.storage.googleapis.com
subpath	string	Especifica uma pasta ou subpasta de destino dentro do bucket do GCS. Por exemplo: /folder

OneLake

Objeto

Um objeto que contém as propriedades da fonte de dados OneLake de destino.

Nome	Tipo	Description
connectionId	string (uuid)	Uma cadeia de caracteres que representa a conexão associada ao atalho. A connectionId é um identificador exclusivo usado para estabelecer uma conexão entre o atalho e a fonte de dados de destino. Para localizar essa ID de conexão, primeiro crie uma conexão de nuvem a ser usada pelo atalho ao se conectar ao local de dados do Amazon S3. Abra o modo de exibição Configurações da conexão de nuvem e copie a ID da conexão; este é um GUID.
itemId	string (uuid)	A ID do alvo no OneLake. O destino pode ser um item de Lakehouse, KQLDatabase ou Warehouse.
path	string	Uma cadeia de caracteres que representa o caminho completo para a pasta de destino dentro do Item. Esse caminho deve ser relativo à raiz da estrutura do diretório OneLake. Por exemplo: "Tables/myTablesFolder/someTableSubFolder".
workspaceId	string (uuid)	A ID do workspace de destino.

S3Compatible

Objeto

Um objeto que contém as propriedades da fonte de dados compatível com S3 de destino.

Nome	Tipo	Description
bucket	string	Especifica o bucket de destino dentro do local compatível com S3.
connectionId	string (uuid)	Uma cadeia de caracteres que representa a conexão associada ao atalho. A connectionId é um identificador exclusivo usado para estabelecer uma conexão entre o atalho e a fonte de dados de destino.
location	string (uri)	URL HTTP do ponto de extremidade compatível com S3. Esse ponto de extremidade deve ser capaz de receber chamadas à API do ListBuckets S3. A URL deve estar no formato não específico do bucket; nenhum bucket deve ser especificado aqui. Por exemplo: `https://s3endpoint.contoso.com`
subpath	string	Especifica uma pasta de destino ou subpasta dentro do bucket compatível com S3. Por exemplo: /folder

Shortcuts

Objeto

Nome	Tipo	Description
continuationToken	string	O token do próximo lote do conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
continuationUri	string	O URI do próximo lote do conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
value	ShortcutTransformFlagged[]	Uma lista de atalhos.

ShortcutTransformFlagged

Objeto

Um objeto que representa uma referência que aponta para outros locais de armazenamento que podem ser internos ou externos ao OneLake. O atalho é definido pelo nome, caminho em que o atalho é criado e o destino que especifica o local de armazenamento de destino.

Nome	Tipo	Description
isShortcutTransform	boolean	Determina se esse atalho é um atalho de transformação. True - Uma transformação de atalho, False - Um atalho regular. Você pode obter as propriedades de transformação de atalho usando Get Shortcut.
name	string	Nome do atalho.
path	string	Uma cadeia de caracteres que representa o caminho completo em que o atalho é criado, incluindo "Arquivos" ou "Tabelas".
target	Target	Um objeto que contém a fonte de dados de destino e deve especificar exatamente um dos destinos com suporte.
transform	Transform: CsvToDeltaTransform	Um objeto que contém o nome da transformação e suas propriedades correspondentes a serem aplicadas aos dados de destino e deve especificar exatamente uma das transformações com suporte.

Target

Objeto

Um objeto que contém a fonte de dados de destino e deve especificar exatamente um dos destinos com suporte, conforme descrito na tabela abaixo.

Nome	Tipo	Description
adlsGen2	AdlsGen2	Um objeto que contém as propriedades da fonte de dados do ADLS Gen2 de destino.
amazonS3	AmazonS3	Um objeto que contém as propriedades da fonte de dados do Amazon S3 de destino.
azureBlobStorage	AzureBlobStorage	Um objeto que contém as propriedades da fonte de dados do Armazenamento de Blobs do Azure de destino.
dataverse	Dataverse	Um objeto que contém as propriedades da fonte de dados do Dataverse de destino.
externalDataShare	ExternalDataShareTarget	Um objeto que contém as propriedades do compartilhamento de dados externo de destino.
googleCloudStorage	GoogleCloudStorage	Um objeto que contém as propriedades da fonte de dados de destino do Google Cloud Storage.
oneLake	OneLake	Um objeto que contém as propriedades da fonte de dados OneLake de destino.
s3Compatible	S3Compatible	Um objeto que contém as propriedades da fonte de dados compatível com S3 de destino.
type	Type	O objeto type contém propriedades como o tipo de conta de atalho de destino. Tipos adicionais podem ser adicionados ao longo do tempo.

Type

Enumeração

O objeto type contém propriedades como o tipo de conta de atalho de destino. Tipos adicionais podem ser adicionados ao longo do tempo.

Valor	Description
OneLake	OneLake
AmazonS3	AmazonS3
AdlsGen2	AdlsGen2
GoogleCloudStorage	GoogleCloudStorage
S3Compatible	S3Compatible
Dataverse	Dataverse
ExternalDataShare	ExternalDataShare
AzureBlobStorage	AzureBlobStorage

Compartilhar via

OneLake Shortcuts - List Shortcuts

Escopos delegados necessários

Identidades com suporte do Microsoft Entra

Interfase

Parâmetros de URI

Respostas

Exemplos

List shortcuts example

Solicitação de exemplo

Resposta de exemplo

List shortcuts with continuation example

Solicitação de exemplo

Resposta de exemplo

List shortcuts with shortcut transforms example

Solicitação de exemplo

Resposta de exemplo

Definições

AdlsGen2

AmazonS3

AzureBlobStorage

CsvToDeltaTransform

CsvToDeltaTransformProperties

Dataverse

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ExternalDataShareTarget

GoogleCloudStorage

OneLake

S3Compatible

Shortcuts

ShortcutTransformFlagged

Target

Type