Freigeben über

Items - Get Connection String

Dienst:
Warehouse
API-Version:
v1

Gibt die SQL-Verbindungszeichenfolge des angegebenen Lagers zurück.

Erlaubnisse

Der Aufrufer muss über Leseberechtigungen für das Lager verfügen. Der Anrufer muss über die Rolle "Viewer " oder einen höheren Arbeitsbereich verfügen.

Erforderliche delegierte Bereiche

Warehouse.Read.All oder Warehouse.ReadWrite.All oder Item.Read.All oder Item.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft-Identitäten .

Identität Support
Benutzer Yes
Dienstprinzipal und verwaltete Identitäten Yes

Schnittstelle

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses/{warehouseId}/connectionString
Mit optionalen Parametern: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses/{warehouseId}/connectionString?guestTenantId={guestTenantId}&privateLinkType={privateLinkType}

URI-Parameter

Name In Erforderlich Typ Beschreibung
warehouseId
 path True

string (uuid)

Die Lager-ID.
workspaceId
 path True

string (uuid)

Die Arbeitsbereichs-ID.
guestTenantId
 query

string (uuid)

Die Gastmandanten-ID, wenn sich der Mandanten des Endbenutzers vom Lagermandanten unterscheidet.
privateLinkType
 query

PrivateLinkType

Gibt den Typ der privaten Verknüpfung an, die diese Verbindungszeichenfolge verwendet. Zusätzliche privateLinkType Typen können im Laufe der Zeit hinzugefügt werden.

Antworten

Name Typ Beschreibung
200 OK

ConnectionStringResponse

Die Anforderung wurde erfolgreich abgeschlossen.
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • ItemNotFound – Das angeforderte Element wurde nicht gefunden.

  • InvalidGuestTenantId – Die angegebene Gastmandanten-ID ist nicht vorhanden.

Beispiele

Get connection string example

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200 
{
  "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m-jh0bi.zcf.datawarehouse.fabric.microsoft.com"
}

Definitionen

Name Beschreibung
ConnectionStringResponse

Die SQL-Verbindungszeichenfolge für den Arbeitsbereich, der dieses Lager enthält.
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
PrivateLinkType

Gibt den Typ der privaten Verknüpfung an, die diese Verbindungszeichenfolge verwendet. Zusätzliche privateLinkType Typen können im Laufe der Zeit hinzugefügt werden.

ConnectionStringResponse

Objekt

Die SQL-Verbindungszeichenfolge für den Arbeitsbereich, der dieses Lager enthält.

Name Typ Beschreibung
connectionString

string

Die SQL-Verbindungszeichenfolge für den Arbeitsbereich, der dieses Lager enthält.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

PrivateLinkType

Enumeration

Gibt den Typ der privaten Verknüpfung an, die diese Verbindungszeichenfolge verwendet. Zusätzliche privateLinkType Typen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
None

Kein privater Link (Standard).
Workspace

Privater Arbeitsbereichslink.