Partager via

OneLake Shortcuts - Create Shortcut

Service:
Core
Version d'API:
v1

Crée un raccourci ou met à jour un raccourci existant.

Étendues déléguées requises

OneLake.ReadWrite.All

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité Soutien
Utilisateur Oui
principal de service et identités managées Oui

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/shortcuts
Avec des paramètres facultatifs: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/shortcuts?shortcutConflictPolicy={shortcutConflictPolicy}

Paramètres URI

Nom Dans Obligatoire Type Description
itemId
 path True

string (uuid)

ID de l’élément de données.
workspaceId
 path True

string (uuid)

L'identifiant de l’espace de travail.
shortcutConflictPolicy
 query

ShortcutConflictPolicy

Lorsqu’il est fourni, il définit l’action à entreprendre lorsqu’un raccourci portant le même nom et le même chemin existe déjà. L’action par défaut est « Abandonner ». Des types ShortcutConflictPolicy supplémentaires peuvent être ajoutés au fil du temps.

Corps de la demande

Nom Obligatoire Type Description
name True

string

Nom du raccourci.
path True

string

Chaîne représentant le chemin d’accès complet où le raccourci est créé, y compris « Fichiers » ou « Tables ».
target True

CreatableShortcutTarget

Objet qui contient la source de données cible et doit spécifier exactement l’une des destinations prises en charge : OneLake, Amazon S3, ADLS Gen2, Google Cloud Storage, S3 compatible, Dataverse, Stockage Blob Azure ou OneDrive SharePoint.

Réponses

Nom Type Description
200 OK

Shortcut

Mise à jour réussie.

En-têtes

Location: string
201 Created

Shortcut

Création réussie.

En-têtes

Location: string
Other Status Codes

ErrorResponse

Codes d’erreur courants :

  • ItemNotFound - Le serveur ne trouve pas l’élément demandé.

  • UnknownError : une erreur s’est produite.

Exemples

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

Exemple de requête

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

Exemple de réponse

Code d’état:
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

Exemple de requête

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

Exemple de réponse

Code d’état:
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

Exemple de requête

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

Exemple de réponse

Code d’état:
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

Exemple de requête

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

Exemple de réponse

Code d’état:
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

Exemple de requête

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

Exemple de réponse

Code d’état:
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

Exemple de requête

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

Exemple de réponse

Code d’état:
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

Exemple de requête

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

Exemple de réponse

Code d’état:
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

Exemple de requête

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

Exemple de réponse

Code d’état:
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

Exemple de requête

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

Exemple de réponse

Code d’état:
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"
    }
  }
}

Définitions

Nom Description
AdlsGen2

Objet contenant les propriétés de la source de données ADLS Gen2 cible.
AmazonS3

Objet contenant les propriétés de la source de données Amazon S3 cible.
AzureBlobStorage

Objet contenant les propriétés de la source de données Stockage Blob Azure cible.
CreatableShortcutTarget

Objet qui contient la source de données cible et doit spécifier exactement l’une des destinations prises en charge, comme décrit dans le tableau ci-dessous.
CreateShortcutRequest

Demande de création de raccourci avec un objet représentant une référence à un autre emplacement de stockage.
CsvToDeltaTransform

Transformation CSV vers Delta.
CsvToDeltaTransformProperties

Propriétés de la transformation CSV vers Delta.
Dataverse

Objet contenant les propriétés de la source de données Dataverse cible.
ErrorRelatedResource

Objet de détails de ressource associé à l’erreur.
ErrorResponse

Réponse d’erreur.
ErrorResponseDetails

Détails de la réponse d’erreur.
ExternalDataShareTarget

Objet contenant les propriétés du partage de données externe cible.
GoogleCloudStorage

Objet contenant les propriétés de la source de données Google Cloud Storage cible.
OneDriveSharePoint

Objet contenant les propriétés de la source de données OneDrive Entreprise ou SharePoint Online cible.
OneLake

Objet contenant les propriétés de la source de données OneLake cible.
S3Compatible

Objet contenant les propriétés de la source de données compatible S3 cible.
Shortcut

Objet représentant une référence qui pointe vers d’autres emplacements de stockage qui peuvent être internes ou externes à OneLake. Le raccourci est défini par nom, chemin d’accès où le raccourci est créé et cible en spécifiant l’emplacement de stockage cible.
ShortcutConflictPolicy

Lorsqu’il est fourni, il définit l’action à entreprendre lorsqu’un raccourci portant le même nom et le même chemin existe déjà. L’action par défaut est « Abandonner ». Des types ShortcutConflictPolicy supplémentaires peuvent être ajoutés au fil du temps.
Target

Objet qui contient la source de données cible et doit spécifier exactement l’une des destinations prises en charge, comme décrit dans le tableau ci-dessous.
Type

L’objet type contient des propriétés telles que le type de compte de raccourci cible. Des types supplémentaires peuvent être ajoutés au fil du temps.

AdlsGen2

Objet

Objet contenant les propriétés de la source de données ADLS Gen2 cible.

Nom Type Description
connectionId

string (uuid)

Chaîne représentant la connexion liée au raccourci. ConnectionId est un identificateur unique utilisé pour établir une connexion entre le raccourci et la source de données cible. Pour trouver cet ID de connexion, commencez par créer une connexion cloud à utiliser par le raccourci lors de la connexion à l’emplacement de données ADLS. Ouvrez la vue Paramètres de la connexion cloud et copiez l’ID de connexion ; il s’agit d’un GUID.
location

string (uri)

Spécifie l’emplacement du conteneur ADLS cible. L’URI doit être au format https://[account-name].dfs.core.windows.net où [account-name] est le nom du compte ADLS cible.
subpath

string

Spécifie le conteneur et le sous-dossier dans le compte ADLS où se trouve le dossier cible. Doit être au format [conteneur]/[sous-dossier] où [conteneur] est le nom du conteneur qui contient les fichiers et dossiers ; [sous-dossier] est le nom du sous-dossier dans le conteneur (facultatif). Par exemple : /mycontainer/mysubfolder

AmazonS3

Objet

Objet contenant les propriétés de la source de données Amazon S3 cible.

Nom Type Description
connectionId

string (uuid)

Chaîne représentant la connexion liée au raccourci. ConnectionId est un identificateur unique utilisé pour établir une connexion entre le raccourci et la source de données cible. Pour trouver cet ID de connexion, commencez par créer une connexion cloud à utiliser par le raccourci lors de la connexion à l’emplacement de données Amazon S3. Ouvrez la vue Paramètres de la connexion cloud et copiez l’ID de connexion ; il s’agit d’un GUID.
location

string (uri)

URL HTTP qui pointe vers le compartiment cible dans S3. L’URL doit être au format https://[bucket-name].s3. [code de région].amazonaws.com, où « bucket-name » est le nom du compartiment S3 vers lequel vous souhaitez pointer, et « region-code » est le code de la région où se trouve le compartiment. Par exemple : https://my-s3-bucket.s3.us-west-2.amazonaws.com
subpath

string

Spécifie un dossier ou un sous-dossier cible dans le compartiment S3.

AzureBlobStorage

Objet

Objet contenant les propriétés de la source de données Stockage Blob Azure cible.

Nom Type Description
connectionId

string (uuid)

Chaîne représentant la connexion liée au raccourci. ConnectionId est un identificateur unique utilisé pour établir une connexion entre le raccourci et la source de données cible. Pour trouver cet ID de connexion, commencez par créer une connexion cloud à utiliser par le raccourci lors de la connexion à l’emplacement des données stockage Blob Azure. Ouvrez la vue des paramètres de la connexion cloud et copiez le GUID correspondant à l’ID de connexion.
location

string (uri)

Spécifie l’emplacement du conteneur stockage Blob Azure cible. L’URI doit être au format https://[account-name].blob.core.windows.net où [account-name] est le nom du compte de stockage Blob Azure cible.
subpath

string

Spécifie le conteneur et le sous-dossier dans le compte Stockage Blob Azure où se trouve le dossier cible. Doit être au format [conteneur]/[sous-dossier]. [Conteneur] est le nom du conteneur qui contient les fichiers et dossiers. [Sous-dossier] est le nom du sous-dossier dans le conteneur et est facultatif. Par exemple : /mycontainer/mysubfolder

CreatableShortcutTarget

Objet

Objet qui contient la source de données cible et doit spécifier exactement l’une des destinations prises en charge, comme décrit dans le tableau ci-dessous.

Nom Type Description
adlsGen2

AdlsGen2

Objet contenant les propriétés de la source de données ADLS Gen2 cible.
amazonS3

AmazonS3

Objet contenant les propriétés de la source de données Amazon S3 cible.
azureBlobStorage

AzureBlobStorage

Objet contenant les propriétés de la source de données Stockage Blob Azure cible.
dataverse

Dataverse

Objet contenant les propriétés de la source de données Dataverse cible.
googleCloudStorage

GoogleCloudStorage

Objet contenant les propriétés de la source de données Google Cloud Storage cible.
oneDriveSharePoint

OneDriveSharePoint

Objet contenant les propriétés de la source de données OneDrive Entreprise &SharePoint Online cible.
oneLake

OneLake

Objet contenant les propriétés de la source de données OneLake cible.
s3Compatible

S3Compatible

Objet contenant les propriétés de la source de données compatible S3 cible.

CreateShortcutRequest

Objet

Demande de création de raccourci avec un objet représentant une référence à un autre emplacement de stockage.

Nom Type Description
name

string

Nom du raccourci.
path

string

Chaîne représentant le chemin d’accès complet où le raccourci est créé, y compris « Fichiers » ou « Tables ».
target

CreatableShortcutTarget

Objet qui contient la source de données cible et doit spécifier exactement l’une des destinations prises en charge : OneLake, Amazon S3, ADLS Gen2, Google Cloud Storage, S3 compatible, Dataverse, Stockage Blob Azure ou OneDrive SharePoint.

CsvToDeltaTransform

Objet

Transformation CSV vers Delta.

Nom Type Description
properties

CsvToDeltaTransformProperties

Propriétés de transformation CSV vers Delta.
type string:

csvToDelta

Type de transformation. Des types de transformation supplémentaires peuvent être ajoutés au fil du temps.

CsvToDeltaTransformProperties

Objet

Propriétés de la transformation CSV vers Delta.

Nom Type Valeur par défaut Description
delimiter

string

,

Spécifie le caractère utilisé pour séparer les valeurs d’une ligne dans le fichier CSV et doit spécifier exactement l’une des valeurs prises en charge : ,, , , \t|, , . &; La valeur par défaut est ,.
skipFilesWithErrors

boolean

True

Indique s’il faut ignorer les fichiers avec des erreurs. True - Ignorer les fichiers avec des erreurs, False - Ne pas ignorer les fichiers avec des erreurs. La valeur par défaut est True.
useFirstRowAsHeader

boolean

True

Indique si la première ligne du fichier CSV doit être utilisée comme en-tête. True : utilisez la première ligne comme en-tête. False : n’utilisez pas la première ligne comme en-tête. La valeur par défaut est True.

Dataverse

Objet

Objet contenant les propriétés de la source de données Dataverse cible.

Nom Type Description
connectionId

string (uuid)

Chaîne représentant la connexion liée au raccourci. ConnectionId est un identificateur unique utilisé pour établir une connexion entre le raccourci et la source de données cible. Pour trouver cet ID de connexion, commencez par créer une connexion cloud à utiliser par le raccourci lors de la connexion à l’emplacement des données Dataverse. Ouvrez la vue Paramètres de la connexion cloud et copiez l’ID de connexion ; il s’agit d’un GUID.
deltaLakeFolder

string

Spécifie le chemin du dossier DeltaLake où les données cibles sont stockées.
environmentDomain

string (uri)

URI qui indique le nom de domaine de l’environnement cible Dataverse. L’URI doit être mis en forme sous la forme « https://[orgname].crm[xx].dynamics.com », où [orgname] représente le nom de votre organisation Dataverse.
tableName

string

Spécifie le nom de la table cible dans Dataverse

ErrorRelatedResource

Objet

Objet de détails de ressource associé à l’erreur.

Nom Type Description
resourceId

string

ID de ressource impliqué dans l’erreur.
resourceType

string

Type de la ressource impliquée dans l’erreur.

ErrorResponse

Objet

Réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
moreDetails

ErrorResponseDetails[]

Liste des détails d’erreur supplémentaires.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.
requestId

string

ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

Détails de la réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.

ExternalDataShareTarget

Objet

Objet contenant les propriétés du partage de données externe cible.

Nom Type Description
connectionId

string (uuid)

Chaîne représentant la connexion liée au raccourci. ConnectionId est un identificateur unique utilisé pour établir une connexion entre le raccourci et la source de données cible.

GoogleCloudStorage

Objet

Objet contenant les propriétés de la source de données Google Cloud Storage cible.

Nom Type Description
connectionId

string (uuid)

Chaîne représentant la connexion liée au raccourci. ConnectionId est un identificateur unique utilisé pour établir une connexion entre le raccourci et la source de données cible.
location

string (uri)

URL HTTP qui pointe vers le compartiment cible dans GCS. L’URL doit être au format https://[bucket-name].storage.googleapis.com, où [bucket-name] est le nom du compartiment à pointer. Par exemple : https://my-gcs-bucket.storage.googleapis.com
subpath

string

Spécifie un dossier cible ou un sous-dossier dans le compartiment GCS. Par exemple : /folder

OneDriveSharePoint

Objet

Objet contenant les propriétés de la source de données OneDrive Entreprise ou SharePoint Online cible.

Nom Type Description
connectionId

string (uuid)

Chaîne représentant la connexion liée au raccourci. ConnectionId est un identificateur unique utilisé pour établir une connexion entre le raccourci et la source de données cible. Pour trouver cet ID de connexion, commencez par créer une connexion cloud à utiliser par le raccourci lors de la connexion à l’emplacement des données SharePoint OneDrive. Ouvrez la vue des paramètres de la connexion cloud et copiez le GUID correspondant à l’ID de connexion.
location

string (uri)

Spécifie l’emplacement du conteneur OneDrive SharePoint cible. L’URI doit être au format https://microsoft.sharepoint.com qui est le chemin d’accès du compte SharePoint OneDrive cible.
subpath

string

Spécifie le conteneur et le sous-dossier dans le compte SharePoint OneDrive où se trouve le dossier cible. Doit être au format [conteneur]/[sous-dossier]. [Conteneur] est le nom du conteneur qui contient les fichiers et dossiers. [Sous-dossier] est le nom du sous-dossier dans le conteneur et est facultatif. Par exemple : /mycontainer/mysubfolder

OneLake

Objet

Objet contenant les propriétés de la source de données OneLake cible.

Nom Type Description
connectionId

string (uuid)

Chaîne représentant la connexion liée au raccourci. ConnectionId est un identificateur unique utilisé pour établir une connexion entre le raccourci et la source de données cible. Pour trouver cet ID de connexion, commencez par créer une connexion cloud à utiliser par le raccourci lors de la connexion à l’emplacement de données Amazon S3. Ouvrez la vue Paramètres de la connexion cloud et copiez l’ID de connexion ; il s’agit d’un GUID.
itemId

string (uuid)

ID de la cible dans OneLake. La cible peut être un élément de Lakehouse, KQLDatabase ou Warehouse.
path

string

Chaîne représentant le chemin d’accès complet au dossier cible dans l’élément. Ce chemin d’accès doit être relatif à la racine de la structure de répertoires OneLake. Par exemple : « Tables/myTablesFolder/someTableSubFolder ».
workspaceId

string (uuid)

ID de l’espace de travail cible.

S3Compatible

Objet

Objet contenant les propriétés de la source de données compatible S3 cible.

Nom Type Description
bucket

string

Spécifie le compartiment cible dans l’emplacement compatible S3.
connectionId

string (uuid)

Chaîne représentant la connexion liée au raccourci. ConnectionId est un identificateur unique utilisé pour établir une connexion entre le raccourci et la source de données cible.
location

string (uri)

URL HTTP du point de terminaison compatible S3. Ce point de terminaison doit être en mesure de recevoir des appels d’API ListBuckets S3. L’URL doit être au format spécifique au compartiment ; aucun compartiment ne doit être spécifié ici. Par exemple : https://s3endpoint.contoso.com
subpath

string

Spécifie un dossier cible ou un sous-dossier dans le compartiment compatible S3. Par exemple : /folder

Shortcut

Objet

Objet représentant une référence qui pointe vers d’autres emplacements de stockage qui peuvent être internes ou externes à OneLake. Le raccourci est défini par nom, chemin d’accès où le raccourci est créé et cible en spécifiant l’emplacement de stockage cible.

Nom Type Description
name

string

Nom du raccourci.
path

string

Chaîne représentant le chemin d’accès complet où le raccourci est créé, y compris « Fichiers » ou « Tables ».
target

Target

Objet qui contient la source de données cible et doit spécifier exactement l’une des destinations prises en charge.
transform Transform:

CsvToDeltaTransform

Objet qui contient le nom de la transformation et ses propriétés correspondantes à appliquer aux données cibles, et doit spécifier exactement l’une des transformations prises en charge.

ShortcutConflictPolicy

Énumération

Lorsqu’il est fourni, il définit l’action à entreprendre lorsqu’un raccourci portant le même nom et le même chemin existe déjà. L’action par défaut est « Abandonner ». Des types ShortcutConflictPolicy supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
Abort

Lorsqu’un raccourci portant le même nom et le même chemin existe déjà, la création de raccourcis est annulée.
GenerateUniqueName

Lorsqu’un raccourci portant le même nom et le même chemin d’accès existent déjà, la création de raccourcis se poursuit avec un nouveau nom de raccourci unique.
CreateOrOverwrite

Lorsqu’un raccourci portant le même nom et le même chemin existe déjà, la création du raccourci remplace le raccourci existant. Créez un raccourci s’il n’existe pas.
OverwriteOnly

Lorsqu’un raccourci portant le même nom et le même chemin existe déjà, la création du raccourci remplace le raccourci existant.

Target

Objet

Objet qui contient la source de données cible et doit spécifier exactement l’une des destinations prises en charge, comme décrit dans le tableau ci-dessous.

Nom Type Description
adlsGen2

AdlsGen2

Objet contenant les propriétés de la source de données ADLS Gen2 cible.
amazonS3

AmazonS3

Objet contenant les propriétés de la source de données Amazon S3 cible.
azureBlobStorage

AzureBlobStorage

Objet contenant les propriétés de la source de données Stockage Blob Azure cible.
dataverse

Dataverse

Objet contenant les propriétés de la source de données Dataverse cible.
externalDataShare

ExternalDataShareTarget

Objet contenant les propriétés du partage de données externe cible.
googleCloudStorage

GoogleCloudStorage

Objet contenant les propriétés de la source de données Google Cloud Storage cible.
oneDriveSharePoint

OneDriveSharePoint

Objet contenant les propriétés de la source de données OneDrive Entreprise &SharePoint Online cible.
oneLake

OneLake

Objet contenant les propriétés de la source de données OneLake cible.
s3Compatible

S3Compatible

Objet contenant les propriétés de la source de données compatible S3 cible.
type

Type

L’objet type contient des propriétés telles que le type de compte de raccourci cible. Des types supplémentaires peuvent être ajoutés au fil du temps.

Type

Énumération

L’objet type contient des propriétés telles que le type de compte de raccourci cible. Des types supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
OneLake

OneLake
AmazonS3

AmazonS3
AdlsGen2

AdlsGen2
GoogleCloudStorage

GoogleCloudStorage
S3Compatible

S3Compatible
Dataverse

Dataverse
ExternalDataShare

ExternalDataShare
AzureBlobStorage

AzureBlobStorage
OneDriveSharePoint

OneDriveSharePoint