Compartilhar via

OneLake Shortcuts - Create Shortcut

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

Cria um novo atalho ou atualiza um atalho existente.

Escopos delegados necessários

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

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/shortcuts
Com parâmetros opcionais: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/shortcuts?shortcutConflictPolicy={shortcutConflictPolicy}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
itemId
 path True

string (uuid)

A ID do item de dados.
workspaceId
 path True

string (uuid)

A ID do workspace
shortcutConflictPolicy
 query

ShortcutConflictPolicy

Quando fornecido, ele define a ação a ser executada quando já existe um atalho com o mesmo nome e caminho. A ação padrão é 'Abortar'. Tipos de ShortcutConflictPolicy adicionais podem ser adicionados ao longo do tempo.

Corpo da solicitação

Nome Obrigatório Tipo Description
name True

string

Nome do atalho.
path True

string

Uma cadeia de caracteres que representa o caminho completo em que o atalho é criado, incluindo "Arquivos" ou "Tabelas".
target True

CreatableShortcutTarget

Um objeto que contém a fonte de dados de destino e deve especificar exatamente um dos destinos com suporte: OneLake, Amazon S3, ADLS Gen2, Google Cloud Storage, compatível com S3, Dataverse, Armazenamento de Blobs do Azure ou OneDrive SharePoint.

Respostas

Nome Tipo Description
200 OK

Shortcut

Atualizado com êxito.

Cabeçalhos

Location: string
201 Created

Shortcut

Criado com êxito.

Cabeçalhos

Location: string
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • ItemNotFound – O servidor não pode encontrar o item solicitado.

  • UnknownError – Ocorreu um erro.

Exemplos

Create or update shortcut target to OneLake
Create shortcut AdlsGen2 target example
Create shortcut AmazonS3 target example
Create shortcut Azure Blob Storage target example
Create shortcut Google Cloud Storage target example
Create shortcut One Lake target example
Create shortcut OneDriveSharePoint or OneDrive for Business or SharePoint Online target example
Create shortcut S3 Compatible target example
Update shortcut target to OneLake

Create or update shortcut target to OneLake

Solicitação de exemplo

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts?shortcutConflictPolicy=CreateOrOverwrite

{
  "path": "Files/blafolder/folder3",
  "name": "MyOneLakeShortcut",
  "target": {
    "oneLake": {
      "workspaceId": "acafbeb1-8037-4d0c-896e-a46fb27ff256",
      "itemId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
      "path": "Tables/myTablesFolder/someTableSubFolder"
    }
  }
}

Resposta de exemplo

Código de status:
200 
Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts/Files/blafolder/folder3/MyOneLakeShortcut
{
  "path": "Files/blafolder/folder3",
  "name": "MyOneLakeShortcut",
  "target": {
    "type": "OneLake",
    "oneLake": {
      "workspaceId": "acafbeb1-8037-4d0c-896e-a46fb27ff256",
      "itemId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
      "path": "Tables/myTablesFolder/someTableSubFolder"
    }
  }
}

Create shortcut AdlsGen2 target example

Solicitação de exemplo

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts

{
  "path": "Files/landingZone",
  "name": "PartnerProducts",
  "target": {
    "adlsGen2": {
      "location": "https://contosoadlsaccount.dfs.core.windows.net",
      "subpath": "/mycontainer/data/ContosoProducts",
      "connectionId": "91324db9-8dc4-4730-a1e5-bafabf1fb91e"
    }
  }
}

Resposta de exemplo

Código de status:
201 
Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts/Files/landingZone/PartnerProducts
{
  "path": "Files/landingZone",
  "name": "PartnerProducts",
  "target": {
    "type": "AdlsGen2",
    "adlsGen2": {
      "location": "https://contosoadlsaccount.dfs.core.windows.net",
      "subpath": "/mycontainer/data/ContosoProducts",
      "connectionId": "91324db9-8dc4-4730-a1e5-bafabf1fb91e"
    }
  }
}

Create shortcut AmazonS3 target example

Solicitação de exemplo

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts

{
  "path": "Files/landingZone",
  "name": "PartnerEmployees",
  "target": {
    "amazonS3": {
      "location": "https://my-s3-bucket.s3.us-west-2.amazonaws.com",
      "subpath": "/data/ContosoEmployees",
      "connectionId": "cf480513-2c1c-46b2-958a-42556ee584c3"
    }
  }
}

Resposta de exemplo

Código de status:
201 
Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts/Files/landingZone/PartnerEmployees
{
  "path": "Files/landingZone",
  "name": "PartnerEmployees",
  "target": {
    "type": "AmazonS3",
    "amazonS3": {
      "location": "https://my-s3-bucket.s3.us-west-2.amazonaws.com",
      "subpath": "/data/ContosoEmployees",
      "connectionId": "cf480513-2c1c-46b2-958a-42556ee584c3"
    }
  }
}

Create shortcut Azure Blob Storage target example

Solicitação de exemplo

POST https://api.fabric.microsoft.com/v1/workspaces/bf94607f-3ba1-4a95-8259-27649ccd7755/items/884e71cd-f5b4-45f9-8e00-b71355f7ea5d/shortcuts

{
  "path": "Files",
  "name": "MyAzureBlobStorage",
  "target": {
    "azureBlobStorage": {
      "location": "https://azureblobstoragetesting.blob.core.windows.net",
      "subpath": "/tables",
      "connectionId": "97e33458-1353-4911-96b1-6f4f4bbfd335"
    }
  }
}

Resposta de exemplo

Código de status:
201 
Location: https://api.fabric.microsoft.com/v1/workspaces/bf94607f-3ba1-4a95-8259-27649ccd7755/items/884e71cd-f5b4-45f9-8e00-b71355f7ea5d/shortcuts/Files/MyAzureBlobStorage
{
  "path": "Files",
  "name": "MyAzureBlobStorage",
  "target": {
    "type": "AzureBlobStorage",
    "azureBlobStorage": {
      "location": "https://azureblobstoragetesting.blob.core.windows.net",
      "subpath": "/tables",
      "connectionId": "97e33458-1353-4911-96b1-6f4f4bbfd335"
    }
  }
}

Create shortcut Google Cloud Storage target example

Solicitação de exemplo

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts

{
  "path": "Files/landingZone",
  "name": "MyGCSShortcut1",
  "target": {
    "googleCloudStorage": {
      "location": "https://gcs-contosoBucket.storage.googleapis.com",
      "subpath": "/gcsDirectory/data/ContosoProducts",
      "connectionId": "3c976446-0bda-472e-8800-f1d6e4f162dc"
    }
  }
}

Resposta de exemplo

Código de status:
201 
Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts/Files/landingZone/MyGCSShortcut1
{
  "path": "Files/landingZone",
  "name": "MyGCSShortcut1",
  "target": {
    "type": "GoogleCloudStorage",
    "googleCloudStorage": {
      "location": "https://gcs-contosoBucket.storage.googleapis.com",
      "subpath": "/gcsDirectory/data/ContosoProducts",
      "connectionId": "3c976446-0bda-472e-8800-f1d6e4f162dc"
    }
  }
}

Create shortcut One Lake target example

Solicitação de exemplo

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts

{
  "path": "Files/blafolder/folder3",
  "name": "MyOneLakeShortcut",
  "target": {
    "oneLake": {
      "workspaceId": "acafbeb1-8037-4d0c-896e-a46fb27ff256",
      "itemId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
      "path": "Tables/myTablesFolder/someTableSubFolder"
    }
  }
}

Resposta de exemplo

Código de status:
201 
Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts/Files/blafolder/folder3/MyOneLakeShortcut
{
  "path": "Files/blafolder/folder3",
  "name": "MyOneLakeShortcut",
  "target": {
    "type": "OneLake",
    "oneLake": {
      "workspaceId": "acafbeb1-8037-4d0c-896e-a46fb27ff256",
      "itemId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
      "path": "Tables/myTablesFolder/someTableSubFolder"
    }
  }
}

Create shortcut OneDriveSharePoint or OneDrive for Business or SharePoint Online target example

Solicitação de exemplo

POST https://api.fabric.microsoft.com/v1/workspaces/bf94607f-3ba1-4a95-8259-27649ccd7755/items/884e71cd-f5b4-45f9-8e00-b71355f7ea5d/shortcuts

{
  "path": "Files",
  "name": "MyOneDriveSharePoint",
  "target": {
    "oneDriveSharePoint": {
      "location": "https://microsoft.sharepoint.com",
      "subpath": "/Shared Documents/Test Folder",
      "connectionId": "97e33458-1353-4911-96b1-6f4f4bbfd335"
    }
  }
}

Resposta de exemplo

Código de status:
201 
Location: https://api.fabric.microsoft.com/v1/workspaces/bf94607f-3ba1-4a95-8259-27649ccd7755/items/884e71cd-f5b4-45f9-8e00-b71355f7ea5d/shortcuts/Files/MyOneDriveSharePoint
{
  "path": "Files",
  "name": "MyOneDriveSharePoint",
  "target": {
    "type": "OneDriveSharePoint",
    "oneDriveSharePoint": {
      "location": "https://microsoft.sharepoint.com",
      "subpath": "/Shared Documents/Test Folder",
      "connectionId": "97e33458-1353-4911-96b1-6f4f4bbfd335"
    }
  }
}

Create shortcut S3 Compatible target example

Solicitação de exemplo

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts

{
  "path": "Files/landingZone",
  "name": "MyS3CompatibleShortcut1",
  "target": {
    "s3Compatible": {
      "location": "https://s3endpoint.contoso.com",
      "bucket": "contosoBucket1",
      "subpath": "/s3CompatibleDirectory/data/ContosoProducts",
      "connectionId": "3c976446-0bda-472e-8800-f1d6e4f162dc"
    }
  }
}

Resposta de exemplo

Código de status:
201 
Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts/Files/landingZone/MyS3CompatibleShortcut1
{
  "path": "Files/landingZone",
  "name": "MyS3CompatibleShortcut1",
  "target": {
    "type": "S3Compatible",
    "s3Compatible": {
      "location": "https://s3endpoint.contoso.com",
      "bucket": "contosoBucket1",
      "subpath": "/s3CompatibleDirectory/data/ContosoProducts",
      "connectionId": "3c976446-0bda-472e-8800-f1d6e4f162dc"
    }
  }
}

Update shortcut target to OneLake

Solicitação de exemplo

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts?shortcutConflictPolicy=CreateOrOverwrite

{
  "path": "Files/blafolder/folder3",
  "name": "MyOneLakeShortcut",
  "target": {
    "oneLake": {
      "workspaceId": "acafbeb1-8037-4d0c-896e-a46fb27ff256",
      "itemId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
      "path": "Tables/myTablesFolder/someTableSubFolder"
    }
  }
}

Resposta de exemplo

Código de status:
200 
Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/shortcuts/Files/blafolder/folder3/MyOneLakeShortcut
{
  "path": "Files/blafolder/folder3",
  "name": "MyOneLakeShortcut",
  "target": {
    "type": "OneLake",
    "oneLake": {
      "workspaceId": "acafbeb1-8037-4d0c-896e-a46fb27ff256",
      "itemId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
      "path": "Tables/myTablesFolder/someTableSubFolder"
    }
  }
}

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.
CreatableShortcutTarget

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.
CreateShortcutRequest

Uma solicitação de criação de atalho com um objeto que representa uma referência a outro local de armazenamento.
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.
OneDriveSharePoint

Um objeto que contém as propriedades do OneDrive for Business de destino ou da fonte de dados do SharePoint Online.
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.
Shortcut

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.
ShortcutConflictPolicy

Quando fornecido, ele define a ação a ser executada quando já existe um atalho com o mesmo nome e caminho. A ação padrão é 'Abortar'. Tipos de ShortcutConflictPolicy adicionais podem ser adicionados ao longo do tempo.
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

CreatableShortcutTarget

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.
googleCloudStorage

GoogleCloudStorage

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

OneDriveSharePoint

Um objeto que contém as propriedades da fonte de dados do OneDrive for Business &sharePoint Online de destino.
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.

CreateShortcutRequest

Objeto

Uma solicitação de criação de atalho com um objeto que representa uma referência a outro local de armazenamento.

Nome Tipo Description
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

CreatableShortcutTarget

Um objeto que contém a fonte de dados de destino e deve especificar exatamente um dos destinos com suporte: OneLake, Amazon S3, ADLS Gen2, Google Cloud Storage, compatível com S3, Dataverse, Armazenamento de Blobs do Azure ou OneDrive SharePoint.

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

OneDriveSharePoint

Objeto

Um objeto que contém as propriedades do OneDrive for Business de destino ou da fonte de dados do SharePoint Online.

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 OneDrive SharePoint. 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 do OneDrive SharePoint de destino. O URI deve estar no formato https://microsoft.sharepoint.com que é o caminho da conta do OneDrive SharePoint de destino.
subpath

string

Especifica o contêiner e a subpasta na conta do OneDrive SharePoint 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

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

Shortcut

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

ShortcutConflictPolicy

Enumeração

Quando fornecido, ele define a ação a ser executada quando já existe um atalho com o mesmo nome e caminho. A ação padrão é 'Abortar'. Tipos de ShortcutConflictPolicy adicionais podem ser adicionados ao longo do tempo.

Valor Description
Abort

Quando já existir um atalho com o mesmo nome e caminho, a criação do atalho será cancelada.
GenerateUniqueName

Quando já existir um atalho com o mesmo nome e caminho, a criação do atalho continuará com um novo nome de atalho exclusivo.
CreateOrOverwrite

Quando um atalho com o mesmo nome e caminho já existir, a criação de atalho substituirá o atalho existente. Crie um atalho se ele não existir.
OverwriteOnly

Quando um atalho com o mesmo nome e caminho já existir, a criação de atalho substituirá o atalho existente.

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.
oneDriveSharePoint

OneDriveSharePoint

Um objeto que contém as propriedades da fonte de dados do OneDrive for Business &sharePoint Online de destino.
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
OneDriveSharePoint

OneDriveSharePoint