Items - Get Connection String

Tjeneste:
Warehouse
API-versjon:
v1

Returnerer SQL-tilkoblingsstrengen for det angitte lageret.

Tillatelser

Innringeren må ha lesetillatelser for lageret. Innringeren må ha visnings- eller høyere arbeidsområderolle.

Nødvendige delegerte omfang

Warehouse.Read.All eller Warehouse.ReadWrite.All eller Item.Read.All eller Item.ReadWrite.All

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft-identitetene som er oppført i denne delen.

Identitet Støtte
Bruker Ja
Tjenestekontohaver og administrerte identiteter Ja

Grensesnitt

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses/{warehouseId}/connectionString
Med valgfrie parametere: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses/{warehouseId}/connectionString?guestTenantId={guestTenantId}&privateLinkType={privateLinkType}

URI-parametere

Name I Obligatorisk Type Beskrivelse
warehouseId
 path True

string (uuid)

Lager-ID-en.
workspaceId
 path True

string (uuid)

Arbeidsområde-ID-en.
guestTenantId
 query

string (uuid)

Gjesteleierens ID hvis sluttbrukerens leier er forskjellig fra lagerleieren.
privateLinkType
 query

PrivateLinkType

Angir typen privat kobling denne tilkoblingsstrengen bruker. Flere privateLinkType typer kan legges til over tid.

Svar

Name Type Beskrivelse
200 OK

ConnectionStringResponse

Forespørselen er fullført.
429 Too Many Requests

ErrorResponse

Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

Retry-After: integer
Other Status Codes

ErrorResponse

Vanlige feilkoder:

  • ItemNotFound – Finner ikke det forespurte elementet.

  • InvalidGuestTenantId – den angitte gjesteleierens ID finnes ikke.

Eksempler

Get connection string example

Eksempelforespørsel

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

Eksempelsvar

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

Definisjoner

Name Beskrivelse
ConnectionStringResponse

SQL-tilkoblingsstrengen for arbeidsområdet som inneholder dette lageret.
ErrorParameter

En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.
ErrorRelatedResource

Objektet for feilrelaterte ressursdetaljer.
ErrorResponse

Feilsvaret.
ErrorResponseDetails

Feilsvardetaljene.
PrivateLinkType

Angir typen privat kobling denne tilkoblingsstrengen bruker. Flere privateLinkType typer kan legges til over tid.

ConnectionStringResponse

Objekt

SQL-tilkoblingsstrengen for arbeidsområdet som inneholder dette lageret.

Name Type Beskrivelse
connectionString

string

SQL-tilkoblingsstrengen for arbeidsområdet som inneholder dette lageret.

ErrorParameter

Objekt

En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.

Name Type Beskrivelse
message

string

En lesbar beskrivelse av parameterens betydning.
name

string

Parameteridentifikatoren.
value

string

Parameterverdien.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Name Type Beskrivelse
resourceId

string

Ressurs-ID-en som er involvert i feilen.
resourceType

string

Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Name Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
isRetriable

boolean

Når sann, kan forespørselen prøves på nytt. Retry-After Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message

string

En menneskelig lesbar representasjon av feilen.
moreDetails

ErrorResponseDetails[]

Liste over flere feildetaljer.
parameters

ErrorParameter[]

Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.
requestId

string (uuid)

ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Name Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message

string

En menneskelig lesbar representasjon av feilen.
parameters

ErrorParameter[]

Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.

PrivateLinkType

Opplisting

Angir typen privat kobling denne tilkoblingsstrengen bruker. Flere privateLinkType typer kan legges til over tid.

Verdi Beskrivelse
None

Ingen privat kobling (standard).
Workspace

Privat kobling for arbeidsområde.