Items - Get Connection String

Tjeneste:

Warehouse

API-version:

v1

Returnerer SQL-forbindelsesstrengen for det angivne lager.

Tilladelser

Den, der ringer op, skal have læserettigheder til lageret. Den, der ringer op, skal have en seerrolle eller en rolle på et højere niveau.

Påkrævede delegerede områder

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

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft-identiteter, der er angivet i dette afsnit.

Identitet	Støtte
Bruger	Ja
Tjenesteprincipal og administrerede identiteter	Ja

Grænseflade

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses/{warehouseId}/connectionString

Med valgfrie parametre:

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

URI-parametre

Navn	I	Påkrævet	Type	Beskrivelse
warehouseId	path	True	string (uuid)	Lager-id'et.
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.
guestTenantId	query		string (uuid)	Gæstelejer-id'et, hvis slutbrugerens lejer er forskellig fra lagerlejer.
privateLinkType	query		PrivateLinkType	Angiver den type privat link, som denne forbindelsesstreng bruger. Der kan tilføjes flere privateLinkType typer over tid.

Svar

Navn	Type	Beskrivelse
200 OK	ConnectionStringResponse	Anmodningen blev fuldført.
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: ItemNotFound – Det ønskede element blev ikke fundet. InvalidGuestTenantId – Det angivne gæstelejer-id findes ikke.

Eksempler

Get connection string example

Eksempelanmodning

HTTP

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

Definitioner

Navn	Beskrivelse
ConnectionStringResponse	SQL-forbindelsesstrengen for det arbejdsområde, der indeholder dette lager.
ErrorParameter	En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
PrivateLinkType	Angiver den type privat link, som denne forbindelsesstreng bruger. Der kan tilføjes flere privateLinkType typer over tid.

ConnectionStringResponse

Objekt

SQL-forbindelsesstrengen for det arbejdsområde, der indeholder dette lager.

Navn	Type	Beskrivelse
connectionString	string	SQL-forbindelsesstrengen for det arbejdsområde, der indeholder dette lager.

ErrorParameter

Objekt

En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.

Navn	Type	Beskrivelse
message	string	En læsevenlig beskrivelse af parameterens betydning.
name	string	Parameter-id'et.
value	string	Parameterens værdi.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Navn	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Navn	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable	boolean	Når sand, kan anmodningen prøves igen. Brug svarheaderen Retry-After til at bestemme forsinkelsen, hvis den er tilgængelig.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Navn	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

PrivateLinkType

Optælling

Angiver den type privat link, som denne forbindelsesstreng bruger. Der kan tilføjes flere privateLinkType typer over tid.

Værdi	Beskrivelse
None	Intet privat link (standard).
Workspace	Privat link til arbejdsområde.