Compartir a través de

OneLake Shortcuts - Create Shortcut

Servicio:
Core
Versión de la API:
v1

Crea un nuevo acceso directo o actualiza un acceso directo existente.

Ámbitos delegados necesarios

OneLake.ReadWrite.All

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

identidad Apoyo
Usuario Sí
de entidad de servicio y identidades administradas Sí

Interfaz

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/shortcuts
Con parámetros opcionales: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/shortcuts?shortcutConflictPolicy={shortcutConflictPolicy}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
itemId
 path True

string (uuid)

Identificador del elemento de datos.
workspaceId
 path True

string (uuid)

El identificador del área de trabajo.
shortcutConflictPolicy
 query

ShortcutConflictPolicy

Cuando se proporciona, define la acción que se debe realizar cuando ya existe un acceso directo con el mismo nombre y ruta de acceso. La acción predeterminada es "Anular". Se pueden agregar tipos de ShortcutConflictPolicy adicionales a lo largo del tiempo.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
name True

string

Nombre del acceso directo.
path True

string

Cadena que representa la ruta de acceso completa donde se crea el acceso directo, incluidos "Archivos" o "Tablas".
target True

CreatableShortcutTarget

Objeto que contiene el origen de datos de destino y debe especificar exactamente uno de los destinos admitidos: OneLake, Amazon S3, ADLS Gen2, Google Cloud Storage, S3 compatible, Dataverse, Azure Blob Storage o OneDrive SharePoint.

Respuestas

Nombre Tipo Description
200 OK

Shortcut

Se ha actualizado correctamente.

Encabezados

Location: string
201 Created

Shortcut

Se ha creado correctamente.

Encabezados

Location: string
Other Status Codes

ErrorResponse

Códigos de error comunes:

  • ItemNotFound: el servidor no encuentra el elemento solicitado.

  • UnknownError: se produjo un error.

Ejemplos

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

Solicitud de ejemplo

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"
    }
  }
}

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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"
    }
  }
}

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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"
    }
  }
}

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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"
    }
  }
}

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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"
    }
  }
}

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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"
    }
  }
}

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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"
    }
  }
}

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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"
    }
  }
}

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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"
    }
  }
}

Respuesta de muestra

status code:
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"
    }
  }
}

Definiciones

Nombre Description
AdlsGen2

Objeto que contiene las propiedades del origen de datos de ADLS Gen2 de destino.
AmazonS3

Objeto que contiene las propiedades del origen de datos de Amazon S3 de destino.
AzureBlobStorage

Objeto que contiene las propiedades del origen de datos de Azure Blob Storage de destino.
CreatableShortcutTarget

Objeto que contiene el origen de datos de destino y debe especificar exactamente uno de los destinos admitidos, tal como se describe en la tabla siguiente.
CreateShortcutRequest

Solicitud de creación de acceso directo con un objeto que representa una referencia a otra ubicación de almacenamiento.
CsvToDeltaTransform

CSV a transformación Delta.
CsvToDeltaTransformProperties

Propiedades de la transformación CSV a Delta.
Dataverse

Objeto que contiene las propiedades del origen de datos de Dataverse de destino.
ErrorRelatedResource

Objeto de detalles del recurso relacionado con el error.
ErrorResponse

Respuesta de error.
ErrorResponseDetails

Detalles de la respuesta de error.
ExternalDataShareTarget

Objeto que contiene las propiedades del recurso compartido de datos externo de destino.
GoogleCloudStorage

Objeto que contiene las propiedades del origen de datos de Google Cloud Storage de destino.
OneDriveSharePoint

Objeto que contiene las propiedades del origen de datos de OneDrive para la Empresa o SharePoint Online de destino.
OneLake

Objeto que contiene las propiedades del origen de datos de OneLake de destino.
S3Compatible

Objeto que contiene las propiedades del origen de datos compatible con S3 de destino.
Shortcut

Objeto que representa una referencia que apunta a otras ubicaciones de almacenamiento que pueden ser internas o externas a OneLake. El acceso directo se define por nombre, ruta de acceso donde se crea el acceso directo y el destino que especifica la ubicación de almacenamiento de destino.
ShortcutConflictPolicy

Cuando se proporciona, define la acción que se debe realizar cuando ya existe un acceso directo con el mismo nombre y ruta de acceso. La acción predeterminada es "Anular". Se pueden agregar tipos de ShortcutConflictPolicy adicionales a lo largo del tiempo.
Target

Objeto que contiene el origen de datos de destino y debe especificar exactamente uno de los destinos admitidos, tal como se describe en la tabla siguiente.
Type

El objeto de tipo contiene propiedades como el tipo de cuenta de acceso directo de destino. Se pueden agregar tipos adicionales a lo largo del tiempo.

AdlsGen2

Objeto

Objeto que contiene las propiedades del origen de datos de ADLS Gen2 de destino.

Nombre Tipo Description
connectionId

string (uuid)

Cadena que representa la conexión enlazada con el acceso directo. ConnectionId es un identificador único que se usa para establecer una conexión entre el acceso directo y el origen de datos de destino. Para encontrar este identificador de conexión, cree primero una conexión en la nube que usará el acceso directo al conectarse a la ubicación de datos de ADLS. Abra la vista Configuración de la conexión en la nube y copie el identificador de conexión; se trata de un GUID.
location

string (uri)

Especifica la ubicación del contenedor de ADLS de destino. El URI debe tener el formato https://[account-name].dfs.core.windows.net, donde [account-name] es el nombre de la cuenta de ADLS de destino.
subpath

string

Especifica el contenedor y la subcarpeta dentro de la cuenta de ADLS donde se encuentra la carpeta de destino. Debe ser del formato [contenedor]/[subcarpeta] donde [contenedor] es el nombre del contenedor que contiene los archivos y carpetas; [subcarpeta] es el nombre de la subcarpeta dentro del contenedor (opcional). Por ejemplo: /mycontainer/mysubfolder

AmazonS3

Objeto

Objeto que contiene las propiedades del origen de datos de Amazon S3 de destino.

Nombre Tipo Description
connectionId

string (uuid)

Cadena que representa la conexión enlazada con el acceso directo. ConnectionId es un identificador único que se usa para establecer una conexión entre el acceso directo y el origen de datos de destino. Para encontrar este identificador de conexión, cree primero una conexión en la nube que usará el acceso directo al conectarse a la ubicación de datos de Amazon S3. Abra la vista Configuración de la conexión en la nube y copie el identificador de conexión; se trata de un GUID.
location

string (uri)

Dirección URL HTTP que apunta al cubo de destino en S3. La dirección URL debe tener el formato https://[bucket-name].s3. [region-code].amazonaws.com, donde "bucket-name" es el nombre del cubo S3 al que quiere apuntar y "region-code" es el código de la región donde se encuentra el cubo. Por ejemplo: https://my-s3-bucket.s3.us-west-2.amazonaws.com
subpath

string

Especifica una carpeta de destino o una subcarpeta dentro del cubo S3.

AzureBlobStorage

Objeto

Objeto que contiene las propiedades del origen de datos de Azure Blob Storage de destino.

Nombre Tipo Description
connectionId

string (uuid)

Cadena que representa la conexión enlazada con el acceso directo. ConnectionId es un identificador único que se usa para establecer una conexión entre el acceso directo y el origen de datos de destino. Para encontrar este identificador de conexión, cree primero una conexión en la nube que usará el acceso directo al conectarse a la ubicación de datos de Azure Blob Storage. Abra la vista de configuración de la conexión en la nube y copie el GUID que es el identificador de conexión.
location

string (uri)

Especifica la ubicación del contenedor de Azure Blob Storage de destino. El URI debe estar en el formato https://[account-name].blob.core.windows.net donde [account-name] es el nombre de la cuenta de Azure Blob Storage de destino.
subpath

string

Especifica el contenedor y la subcarpeta dentro de la cuenta de Azure Blob Storage donde se encuentra la carpeta de destino. Debe ser del formato [contenedor]/[subcarpeta]. [Contenedor] es el nombre del contenedor que contiene los archivos y carpetas. [Subcarpeta] es el nombre de la subcarpeta dentro del contenedor y es opcional. Por ejemplo: /mycontainer/mysubfolder

CreatableShortcutTarget

Objeto

Objeto que contiene el origen de datos de destino y debe especificar exactamente uno de los destinos admitidos, tal como se describe en la tabla siguiente.

Nombre Tipo Description
adlsGen2

AdlsGen2

Objeto que contiene las propiedades del origen de datos de ADLS Gen2 de destino.
amazonS3

AmazonS3

Objeto que contiene las propiedades del origen de datos de Amazon S3 de destino.
azureBlobStorage

AzureBlobStorage

Objeto que contiene las propiedades del origen de datos de Azure Blob Storage de destino.
dataverse

Dataverse

Objeto que contiene las propiedades del origen de datos de Dataverse de destino.
googleCloudStorage

GoogleCloudStorage

Objeto que contiene las propiedades del origen de datos de Google Cloud Storage de destino.
oneDriveSharePoint

OneDriveSharePoint

Objeto que contiene las propiedades del origen de datos de OneDrive para la Empresa y SharePoint Online de destino.
oneLake

OneLake

Objeto que contiene las propiedades del origen de datos de OneLake de destino.
s3Compatible

S3Compatible

Objeto que contiene las propiedades del origen de datos compatible con S3 de destino.

CreateShortcutRequest

Objeto

Solicitud de creación de acceso directo con un objeto que representa una referencia a otra ubicación de almacenamiento.

Nombre Tipo Description
name

string

Nombre del acceso directo.
path

string

Cadena que representa la ruta de acceso completa donde se crea el acceso directo, incluidos "Archivos" o "Tablas".
target

CreatableShortcutTarget

Objeto que contiene el origen de datos de destino y debe especificar exactamente uno de los destinos admitidos: OneLake, Amazon S3, ADLS Gen2, Google Cloud Storage, S3 compatible, Dataverse, Azure Blob Storage o OneDrive SharePoint.

CsvToDeltaTransform

Objeto

CSV a transformación Delta.

Nombre Tipo Description
properties

CsvToDeltaTransformProperties

CSV a propiedades de transformación delta.
type string:

csvToDelta

Tipo de transformación. Se pueden agregar tipos de transformación adicionales a lo largo del tiempo.

CsvToDeltaTransformProperties

Objeto

Propiedades de la transformación CSV a Delta.

Nombre Tipo Valor predeterminado Description
delimiter

string

,

Especifica el carácter usado para separar los valores de una fila en el archivo CSV y debe especificar exactamente uno de los valores admitidos: ,, , \t, |, , &. ; El valor predeterminado es ,.
skipFilesWithErrors

boolean

True

Si se omiten los archivos con errores. True: omitir archivos con errores, False: no omitir archivos con errores. El valor predeterminado es True.
useFirstRowAsHeader

boolean

True

Si la primera fila del archivo CSV debe usarse como encabezado. True: use la primera fila como encabezado. False: no use la primera fila como encabezado. El valor predeterminado es True.

Dataverse

Objeto

Objeto que contiene las propiedades del origen de datos de Dataverse de destino.

Nombre Tipo Description
connectionId

string (uuid)

Cadena que representa la conexión enlazada con el acceso directo. ConnectionId es un identificador único que se usa para establecer una conexión entre el acceso directo y el origen de datos de destino. Para buscar este identificador de conexión, cree primero una conexión en la nube que usará el acceso directo al conectarse a la ubicación de datos de Dataverse. Abra la vista Configuración de la conexión en la nube y copie el identificador de conexión; se trata de un GUID.
deltaLakeFolder

string

Especifica la ruta de acceso de la carpeta DeltaLake donde se almacenan los datos de destino.
environmentDomain

string (uri)

URI que indica el nombre de dominio del entorno de destino de Dataverse. El URI debe tener el formato "https://[orgname].crm[xx].dynamics.com", donde [orgname] representa el nombre de la organización de Dataverse.
tableName

string

Especifica el nombre de la tabla de destino en Dataverse.

ErrorRelatedResource

Objeto

Objeto de detalles del recurso relacionado con el error.

Nombre Tipo Description
resourceId

string

Identificador de recurso implicado en el error.
resourceType

string

Tipo del recurso implicado en el error.

ErrorResponse

Objeto

Respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message

string

Representación legible del error.
moreDetails

ErrorResponseDetails[]

Lista de detalles de error adicionales.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.
requestId

string

Identificador de la solicitud asociada al error.

ErrorResponseDetails

Objeto

Detalles de la respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message

string

Representación legible del error.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.

ExternalDataShareTarget

Objeto

Objeto que contiene las propiedades del recurso compartido de datos externo de destino.

Nombre Tipo Description
connectionId

string (uuid)

Cadena que representa la conexión enlazada con el acceso directo. ConnectionId es un identificador único que se usa para establecer una conexión entre el acceso directo y el origen de datos de destino.

GoogleCloudStorage

Objeto

Objeto que contiene las propiedades del origen de datos de Google Cloud Storage de destino.

Nombre Tipo Description
connectionId

string (uuid)

Cadena que representa la conexión enlazada con el acceso directo. ConnectionId es un identificador único que se usa para establecer una conexión entre el acceso directo y el origen de datos de destino.
location

string (uri)

Dirección URL HTTP que apunta al cubo de destino en GCS. La dirección URL debe tener el formato https://[bucket-name].storage.googleapis.com, donde [bucket-name] es el nombre del cubo al que desea apuntar. Por ejemplo: https://my-gcs-bucket.storage.googleapis.com
subpath

string

Especifica una carpeta o subcarpeta de destino dentro del cubo GCS. Por ejemplo: /folder

OneDriveSharePoint

Objeto

Objeto que contiene las propiedades del origen de datos de OneDrive para la Empresa o SharePoint Online de destino.

Nombre Tipo Description
connectionId

string (uuid)

Cadena que representa la conexión enlazada con el acceso directo. ConnectionId es un identificador único que se usa para establecer una conexión entre el acceso directo y el origen de datos de destino. Para encontrar este identificador de conexión, cree primero una conexión en la nube que usará el acceso directo al conectarse a la ubicación de datos de SharePoint de OneDrive. Abra la vista de configuración de la conexión en la nube y copie el GUID que es el identificador de conexión.
location

string (uri)

Especifica la ubicación del contenedor de SharePoint de OneDrive de destino. El URI debe estar en el formato https://microsoft.sharepoint.com que es la ruta de acceso de la cuenta de SharePoint de OneDrive de destino.
subpath

string

Especifica el contenedor y la subcarpeta dentro de la cuenta de SharePoint de OneDrive donde se encuentra la carpeta de destino. Debe ser del formato [contenedor]/[subcarpeta]. [Contenedor] es el nombre del contenedor que contiene los archivos y carpetas. [Subcarpeta] es el nombre de la subcarpeta dentro del contenedor y es opcional. Por ejemplo: /mycontainer/mysubfolder

OneLake

Objeto

Objeto que contiene las propiedades del origen de datos de OneLake de destino.

Nombre Tipo Description
connectionId

string (uuid)

Cadena que representa la conexión enlazada con el acceso directo. ConnectionId es un identificador único que se usa para establecer una conexión entre el acceso directo y el origen de datos de destino. Para encontrar este identificador de conexión, cree primero una conexión en la nube que usará el acceso directo al conectarse a la ubicación de datos de Amazon S3. Abra la vista Configuración de la conexión en la nube y copie el identificador de conexión; se trata de un GUID.
itemId

string (uuid)

Identificador del destino en OneLake. El destino puede ser un elemento de Lakehouse, KQLDatabase o Warehouse.
path

string

Cadena que representa la ruta de acceso completa a la carpeta de destino dentro del elemento. Esta ruta de acceso debe ser relativa a la raíz de la estructura de directorios de OneLake. Por ejemplo: "Tables/myTablesFolder/someTableSubFolder".
workspaceId

string (uuid)

Identificador del área de trabajo de destino.

S3Compatible

Objeto

Objeto que contiene las propiedades del origen de datos compatible con S3 de destino.

Nombre Tipo Description
bucket

string

Especifica el cubo de destino dentro de la ubicación compatible con S3.
connectionId

string (uuid)

Cadena que representa la conexión enlazada con el acceso directo. ConnectionId es un identificador único que se usa para establecer una conexión entre el acceso directo y el origen de datos de destino.
location

string (uri)

Dirección URL HTTP del punto de conexión compatible con S3. Este punto de conexión debe poder recibir llamadas API de ListBuckets S3. La dirección URL debe estar en el formato no específico del cubo; no se debe especificar ningún cubo aquí. Por ejemplo: https://s3endpoint.contoso.com
subpath

string

Especifica una carpeta de destino o una subcarpeta dentro del cubo compatible con S3. Por ejemplo: /folder

Shortcut

Objeto

Objeto que representa una referencia que apunta a otras ubicaciones de almacenamiento que pueden ser internas o externas a OneLake. El acceso directo se define por nombre, ruta de acceso donde se crea el acceso directo y el destino que especifica la ubicación de almacenamiento de destino.

Nombre Tipo Description
name

string

Nombre del acceso directo.
path

string

Cadena que representa la ruta de acceso completa donde se crea el acceso directo, incluidos "Archivos" o "Tablas".
target

Target

Objeto que contiene el origen de datos de destino y debe especificar exactamente uno de los destinos admitidos.
transform Transform:

CsvToDeltaTransform

Objeto que contiene el nombre de transformación y sus propiedades correspondientes que se van a aplicar a los datos de destino y debe especificar exactamente una de las transformaciones admitidas.

ShortcutConflictPolicy

Enumeración

Cuando se proporciona, define la acción que se debe realizar cuando ya existe un acceso directo con el mismo nombre y ruta de acceso. La acción predeterminada es "Anular". Se pueden agregar tipos de ShortcutConflictPolicy adicionales a lo largo del tiempo.

Valor Description
Abort

Cuando ya exista un acceso directo con el mismo nombre y ruta de acceso, se cancelará la creación del acceso directo.
GenerateUniqueName

Cuando ya exista un acceso directo con el mismo nombre y ruta de acceso, la creación del acceso directo continuará con un nuevo nombre de acceso directo único.
CreateOrOverwrite

Cuando ya existe un acceso directo con el mismo nombre y ruta de acceso, la creación del acceso directo sobrescribirá el acceso directo existente. Cree el acceso directo si no existe.
OverwriteOnly

Cuando ya existe un acceso directo con el mismo nombre y ruta de acceso, la creación del acceso directo sobrescribirá el acceso directo existente.

Target

Objeto

Objeto que contiene el origen de datos de destino y debe especificar exactamente uno de los destinos admitidos, tal como se describe en la tabla siguiente.

Nombre Tipo Description
adlsGen2

AdlsGen2

Objeto que contiene las propiedades del origen de datos de ADLS Gen2 de destino.
amazonS3

AmazonS3

Objeto que contiene las propiedades del origen de datos de Amazon S3 de destino.
azureBlobStorage

AzureBlobStorage

Objeto que contiene las propiedades del origen de datos de Azure Blob Storage de destino.
dataverse

Dataverse

Objeto que contiene las propiedades del origen de datos de Dataverse de destino.
externalDataShare

ExternalDataShareTarget

Objeto que contiene las propiedades del recurso compartido de datos externo de destino.
googleCloudStorage

GoogleCloudStorage

Objeto que contiene las propiedades del origen de datos de Google Cloud Storage de destino.
oneDriveSharePoint

OneDriveSharePoint

Objeto que contiene las propiedades del origen de datos de OneDrive para la Empresa y SharePoint Online de destino.
oneLake

OneLake

Objeto que contiene las propiedades del origen de datos de OneLake de destino.
s3Compatible

S3Compatible

Objeto que contiene las propiedades del origen de datos compatible con S3 de destino.
type

Type

El objeto de tipo contiene propiedades como el tipo de cuenta de acceso directo de destino. Se pueden agregar tipos adicionales a lo largo del tiempo.

Type

Enumeración

El objeto de tipo contiene propiedades como el tipo de cuenta de acceso directo de destino. Se pueden agregar tipos adicionales a lo largo del tiempo.

Valor Description
OneLake

OneLake
AmazonS3

AmazonS3
AdlsGen2

AdlsGen2
GoogleCloudStorage

GoogleCloudStorage
S3Compatible

S3Compatible
Dataverse

Dataverse
ExternalDataShare

ExternalDataShare
AzureBlobStorage

AzureBlobStorage
OneDriveSharePoint

OneDriveSharePoint