Items - Get Connection String

Tjänst:

SQLEndpoint

API-versionen:

v1

Returnerar SQL-anslutningssträngen för det angivna lagret.

Permissions

Anroparen måste ha läsbehörighet för lagret. Anroparen måste ha en visningsroll eller en högre arbetsyteroll.

Obligatoriska delegerade omfång

SqlEndpoint.Read.All eller SqlEndpoint.ReadWrite.All eller Item.Read.All eller Item.ReadWrite.All

Identiteter som stöds av Microsoft Entra

Det här API:et stöder De Microsoft-identiteter som anges i det här avsnittet.

Identitet	Support
User	Yes
Tjänstens huvudnamn och hanterade identiteter	Yes

Gränssnitt

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlEndpoints/{sqlEndpointId}/connectionString

Med valfria parametrar:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlEndpoints/{sqlEndpointId}/connectionString?guestTenantId={guestTenantId}&privateLinkType={privateLinkType}

URI-parametrar

Namn	I	Krävs	Typ	Beskrivning
sqlEndpointId	path	True	string (uuid)	SQL-slutpunkts-ID.
workspaceId	path	True	string (uuid)	Arbetsytans ID.
guestTenantId	query		string (uuid)	Gästklient-ID:t om slutanvändarens klientorganisation skiljer sig från SQL-slutpunktens klientorganisation.
privateLinkType	query		PrivateLinkType	Anger vilken typ av privat länk den här anslutningssträngen använder. Ytterligare privateLinkType typer kan läggas till över tid.

Svaren

Namn	Typ	Beskrivning
200 OK	ConnectionStringResponse	Begäran har slutförts.
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Headers Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: ItemNotFound – Det begärda objektet hittades inte. InvalidGuestTenantId – det angivna ID:t finns inte.

Exempel

Get connection string example

Exempelförfrågan

HTTP

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

Exempelsvar

Statuskod:

200

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

Definitioner

Namn	Beskrivning
ConnectionStringResponse	SQL-anslutningssträngen för arbetsytan som innehåller den här SQL-slutpunkten.
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
PrivateLinkType	Anger vilken typ av privat länk den här anslutningssträngen använder. Ytterligare privateLinkType typer kan läggas till över tid.

ConnectionStringResponse

Objekt

SQL-anslutningssträngen för arbetsytan som innehåller den här SQL-slutpunkten.

Namn	Typ	Beskrivning
connectionString	string	SQL-anslutningssträngen för arbetsytan som innehåller den här SQL-slutpunkten.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Namn	Typ	Beskrivning
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Namn	Typ	Beskrivning
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string (uuid)	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Namn	Typ	Beskrivning
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

PrivateLinkType

Uppräkning

Anger vilken typ av privat länk den här anslutningssträngen använder. Ytterligare privateLinkType typer kan läggas till över tid.

Värde	Beskrivning
None	Ingen privat länk (standard).
Workspace	Privat länk för arbetsyta.