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

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

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 do URI

Name Em Necessário Tipo Description
itemId
 path True

string (uuid)

A ID do item de dados.
workspaceId
 path True

string (uuid)

A ID do espaço de trabalho.
shortcutConflictPolicy
 query

ShortcutConflictPolicy

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

Corpo do Pedido

Name Necessário Tipo Description
name True

string

Nome do atalho.
path True

string

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

CreatableShortcutTarget

Um objeto que contenha a fonte de dados alvo e que deve especificar exatamente um dos destinos suportados: OneLake, Amazon S3, ADLS Gen2, Google Cloud Storage, compatível com S3, Dataverse, Azure Blob storage ou OneDrive SharePoint.

Respostas

Name Tipo Description
200 OK

Shortcut

Atualizado com sucesso.

Cabeçalhos

Location: string
201 Created

Shortcut

Criado com sucesso.

Cabeçalhos

Location: string
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • ItemNotFound - O servidor não consegue 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

Pedido de amostra

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

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

Pedido de amostra

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

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

Pedido de amostra

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

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

Pedido de amostra

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

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

Pedido de amostra

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

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

Pedido de amostra

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

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

Pedido de amostra

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

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

Pedido de amostra

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

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

Pedido de amostra

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

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

Name Description
AdlsGen2

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

Um objeto que contém as propriedades da fonte de dados de destino do Amazon S3.
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 suportados, 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

CSV para transformação Delta.
CsvToDeltaTransformProperties

Propriedades para a transformação CSV para Delta.
Dataverse

Um objeto que contém as propriedades da fonte de dados 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 externos de destino.
GoogleCloudStorage

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

Um objeto contendo as propriedades da fonte de dados alvo OneDrive for Business ou 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 o 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 onde o atalho é criado e destino, especificando o local de armazenamento de destino.
ShortcutConflictPolicy

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

Object

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

Name Tipo Description
connectionId

string (uuid)

Uma cadeia de caracteres que representa a conexão que está vinculada ao atalho. O connectionId é um identificador exclusivo usado para estabelecer uma conexão entre o atalho e a fonte de dados de destino. Para encontrar esse ID de conexão, primeiro crie uma conexão na nuvem para ser usada pelo atalho ao se conectar ao local de dados ADLS. Abra a visualização Configurações da conexão de nuvem e copie o ID da conexão; este é um GUID.
location

string (uri)

Especifica o local do contêiner ADLS de destino. O URI deve estar no formato https://[account-name].dfs.core.windows.net, onde [account-name] é o nome da conta ADLS de destino.
subpath

string

Especifica o contêiner e a subpasta dentro da conta ADLS onde a pasta de destino está localizada. Deve ser do formato [container]/[subfolder] onde [container] é 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

Object

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

Name Tipo Description
connectionId

string (uuid)

Uma cadeia de caracteres que representa a conexão que está vinculada ao atalho. O connectionId é um identificador exclusivo usado para estabelecer uma conexão entre o atalho e a fonte de dados de destino. Para encontrar esse ID de conexão, primeiro crie uma conexão na nuvem para ser usada pelo atalho ao se conectar ao local de dados do Amazon S3. Abra a visualização Configurações da conexão de nuvem e copie o ID da conexão; este é um GUID.
location

string (uri)

URL HTTP que aponta para o bucket de destino no S3. O URL deve estar no formato https://[bucket-name].s3. [region-code].amazonaws.com, onde "bucket-name" é o nome do bucket do S3 para o qual você deseja apontar e "region-code" é o código da região onde o bucket está localizado. Por exemplo: https://my-s3-bucket.s3.us-west-2.amazonaws.com
subpath

string

Especifica uma pasta ou subpasta de destino dentro do bucket do S3.

AzureBlobStorage

Object

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

Name Tipo Description
connectionId

string (uuid)

Uma cadeia de caracteres que representa a conexão que está vinculada ao atalho. O 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 para ser usada pelo atalho ao se conectar ao local de dados do Armazenamento de Blobs do Azure. Abra a visualização de configurações da conexão de nuvem e copie o GUID que é o ID da conexão.
location

string (uri)

Especifica o local do contêiner de Armazenamento de Blob do Azure de destino. O URI deve estar no formato https://[account-name].blob.core.windows.net em que [account-name] é o nome da conta de Armazenamento de Blob do Azure de destino.
subpath

string

Especifica o contêiner e a subpasta dentro da conta de Armazenamento de Blob do Azure onde a pasta de destino está localizada. Deve ser do formato [container]/[subpasta]. [Container] é 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

Object

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

Name Tipo Description
adlsGen2

AdlsGen2

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

AmazonS3

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

CreateShortcutRequest

Object

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

Name Tipo Description
name

string

Nome do atalho.
path

string

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

CreatableShortcutTarget

Um objeto que contenha a fonte de dados alvo e que deve especificar exatamente um dos destinos suportados: OneLake, Amazon S3, ADLS Gen2, Google Cloud Storage, compatível com S3, Dataverse, Azure Blob storage ou OneDrive SharePoint.

CsvToDeltaTransform

Object

CSV para transformação Delta.

Name Tipo Description
properties

CsvToDeltaTransformProperties

CSV para Delta transformam propriedades.
type string:

csvToDelta

O tipo de transformação. Tipos de transformação adicionais podem ser adicionados ao longo do tempo.

CsvToDeltaTransformProperties

Object

Propriedades para a transformação CSV para Delta.

Name Tipo Default value Description
delimiter

string

,

Especifica o caractere usado para separar valores dentro de uma linha no arquivo CSV e deve especificar exatamente um dos valores suportados: ,, , \t, |, &, ;. O valor predefinido é ,.
skipFilesWithErrors

boolean

True

Se deve ignorar arquivos com erros. True - Ignorar ficheiros com erros, Falso - Não saltar ficheiros com erros. O valor padrão é True.
useFirstRowAsHeader

boolean

True

Se a primeira linha do arquivo CSV deve ser usada como cabeçalho. True - Use a primeira linha como cabeçalho. Falso - Não use a primeira linha como cabeçalho. O valor padrão é True.

Dataverse

Object

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

Name Tipo Description
connectionId

string (uuid)

Uma cadeia de caracteres que representa a conexão que está vinculada ao atalho. O connectionId é um identificador exclusivo usado para estabelecer uma conexão entre o atalho e a fonte de dados de destino. Para encontrar esse ID de conexão, primeiro crie uma conexão de nuvem para ser usada pelo atalho ao se conectar ao local de dados do Dataverse. Abra a visualização Configurações da conexão de nuvem e copie o ID da conexão; este é um GUID.
deltaLakeFolder

string

Especifica o caminho da pasta DeltaLake onde 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", onde [orgname] representa o nome da sua organização do Dataverse.
tableName

string

Especifica o nome da tabela de destino no Dataverse

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.

ExternalDataShareTarget

Object

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

Name Tipo Description
connectionId

string (uuid)

Uma cadeia de caracteres que representa a conexão que está vinculada ao atalho. O connectionId é um identificador exclusivo usado para estabelecer uma conexão entre o atalho e a fonte de dados de destino.

GoogleCloudStorage

Object

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

Name Tipo Description
connectionId

string (uuid)

Uma cadeia de caracteres que representa a conexão que está vinculada ao atalho. O 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, onde [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 GCS. Por exemplo: /folder

OneDriveSharePoint

Object

Um objeto contendo as propriedades da fonte de dados alvo OneDrive for Business ou SharePoint Online.

Name Tipo Description
connectionId

string (uuid)

Uma cadeia de caracteres que representa a conexão que está vinculada ao atalho. O connectionId é um identificador exclusivo usado para estabelecer uma conexão entre o atalho e a fonte de dados de destino. Para encontrar este ID de ligação, crie primeiro uma ligação na cloud para ser usada pelo atalho ao ligar à localização de dados do SharePoint do OneDrive. Abra a visualização de configurações da conexão de nuvem e copie o GUID que é o ID da conexão.
location

string (uri)

Especifica a localização do contentor de SharePoint OneDrive de destino. O URI deve estar no formato https://microsoft.sharepoint.com que corresponde ao caminho da conta SharePoint OneDrive alvo.
subpath

string

Especifica o contentor e a subpasta dentro da conta SharePoint OneDrive onde a pasta de destino está localizada. Deve ser do formato [container]/[subpasta]. [Container] é 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

Object

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

Name Tipo Description
connectionId

string (uuid)

Uma cadeia de caracteres que representa a conexão que está vinculada ao atalho. O connectionId é um identificador exclusivo usado para estabelecer uma conexão entre o atalho e a fonte de dados de destino. Para encontrar esse ID de conexão, primeiro crie uma conexão na nuvem para ser usada pelo atalho ao se conectar ao local de dados do Amazon S3. Abra a visualização Configurações da conexão de nuvem e copie o ID da conexão; este é um GUID.
itemId

string (uuid)

A ID do destino no OneLake. O alvo 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 de diretórios OneLake. Por exemplo: "Tables/myTablesFolder/someTableSubFolder".
workspaceId

string (uuid)

A ID do espaço de trabalho de destino.

S3Compatible

Object

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

Name Tipo Description
bucket

string

Especifica o bucket de destino no local compatível com o S3.
connectionId

string (uuid)

Uma cadeia de caracteres que representa a conexão que está vinculada ao atalho. O 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 o S3. Esse ponto de extremidade deve ser capaz de receber chamadas de API 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 ou subpasta de destino dentro do bucket compatível com o S3. Por exemplo: /folder

Shortcut

Object

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 onde o atalho é criado e destino, especificando o local de armazenamento de destino.

Name Tipo Description
name

string

Nome do atalho.
path

string

Uma cadeia de caracteres que representa o caminho completo onde 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 suportados.
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 suportadas.

ShortcutConflictPolicy

Enumeração

Quando fornecido, ele define a ação a ser tomada quando um atalho com o mesmo nome e caminho já existe. A ação padrão é 'Abortar'. Tipos adicionais de ShortcutConflictPolicy 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 já existir um atalho com o mesmo nome e caminho, a criação do atalho substituirá o atalho existente. Crie atalho se ele não existir.
OverwriteOnly

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

Target

Object

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

Name Tipo Description
adlsGen2

AdlsGen2

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

AmazonS3

Um objeto que contém as propriedades da fonte de dados de destino do Amazon S3.
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 Dataverse de destino.
externalDataShare

ExternalDataShareTarget

Um objeto que contém as propriedades do compartilhamento de dados externos 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 alvo OneDrive for Business & SharePoint Online.
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 o 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

OneLago
AmazonS3

AmazonS3
AdlsGen2

AdlsGen2
GoogleCloudStorage

GoogleCloudStorage [en]
S3Compatible

Compatível com S3
Dataverse

Dataverse
ExternalDataShare

ExternalDataShare
AzureBlobStorage

AzureBlobStorage
OneDriveSharePoint

OneDriveSharePoint