Partager via

Items - Get Connection String

Service:
SQLEndpoint
Version d'API:
v1

Retourne la chaîne de connexion SQL de l’entrepôt spécifié.

Permissions

L’appelant doit disposer d’autorisations de lecture pour l’entrepôt. L’appelant doit avoir un rôle de visionneuse ou d’espace de travail supérieur.

Étendues déléguées requises

SqlEndpoint.Read.All ou SqlEndpoint.ReadWrite.All ou Item.Read.All ou Item.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é Support
Utilisateur Oui
Identités managées et principal de service Oui

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlEndpoints/{sqlEndpointId}/connectionString
Avec des paramètres facultatifs: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlEndpoints/{sqlEndpointId}/connectionString?guestTenantId={guestTenantId}&privateLinkType={privateLinkType}

Paramètres URI

Nom Dans Obligatoire Type Description
sqlEndpointId
 path True

string (uuid)

ID de point de terminaison SQL.
workspaceId
 path True

string (uuid)

ID de l’espace de travail.
guestTenantId
 query

string (uuid)

ID de locataire invité si le locataire de l’utilisateur final est différent du locataire du point de terminaison SQL.
privateLinkType
 query

PrivateLinkType

Indique le type de liaison privée utilisée par cette chaîne de connexion. Des types supplémentaires privateLinkType peuvent être ajoutés au fil du temps.

Réponses

Nom Type Description
200 OK

ConnectionStringResponse

La demande s’est terminée avec succès.
Other Status Codes

ErrorResponse

Codes d’erreur courants :

  • ItemNotFound : l’élément demandé n’a pas été trouvé.

  • InvalidGuestTenantId : l’ID fourni n’existe pas.

Exemples

Get connection string example

Exemple de requête

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/sqlEndpoints/5b218778-e7a5-4d73-8187-f10824047715/connectionString?guestTenantId=6e335e92-a2a2-4b5a-970a-bd6a89fbb765&privateLinkType=Workspace

Exemple de réponse

Code d’état:
200 
{
  "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m-jh0bi.zcf.datawarehouse.fabric.microsoft.com"
}

Définitions

Nom Description
ConnectionStringResponse

Chaîne de connexion SQL pour l’espace de travail contenant ce point de terminaison SQL.
ErrorRelatedResource

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

Réponse d’erreur.
ErrorResponseDetails

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

Indique le type de liaison privée utilisée par cette chaîne de connexion. Des types supplémentaires privateLinkType peuvent être ajoutés au fil du temps.

ConnectionStringResponse

Object

Chaîne de connexion SQL pour l’espace de travail contenant ce point de terminaison SQL.

Nom Type Description
connectionString

string

Chaîne de connexion SQL pour l’espace de travail contenant ce point de terminaison SQL.

ErrorRelatedResource

Object

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

Object

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

Object

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.

PrivateLinkType

Énumération

Indique le type de liaison privée utilisée par cette chaîne de connexion. Des types supplémentaires privateLinkType peuvent être ajoutés au fil du temps.

Valeur Description
None

Aucune liaison privée (valeur par défaut).
Workspace

Liaison privée de l’espace de travail.