Items - Get Connection String

Usługa:: SQLEndpoint

Wersja interfejsu API:: v1

Zwraca parametry połączenia SQL określonego magazynu.

Permissions

Obiekt wywołujący musi mieć uprawnienia do odczytu dla magazynu. Obiekt wywołujący musi mieć rolę przeglądającego lub nowszego obszaru roboczego.

Wymagane zakresy delegowane

SQLEndpoint.Read.All lub SQLEndpoint.ReadWrite.All lub Item.Read.All lub Item.ReadWrite.All

Tożsamości obsługiwane przez firmę Microsoft

Ten interfejs API obsługuje tożsamości firmy Microsoft wymienione w tej sekcji.

Tożsamość	Support
User	Tak
Jednostka usługi i tożsamości zarządzane	Tak

Interfejs

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwisko	W	Wymagane	Typ	Opis
sqlEndpointId	path	True	string (uuid)	Identyfikator punktu końcowego SQL.
workspaceId	path	True	string (uuid)	Identyfikator obszaru roboczego.
guestTenantId	query		string (uuid)	Identyfikator dzierżawy gościa, jeśli dzierżawa użytkownika końcowego różni się od dzierżawy punktu końcowego SQL.
privateLinkType	query		PrivateLinkType	Wskazuje typ łącza prywatnego używany przez te parametry połączenia. Dodatkowe `privateLinkType` typy mogą być dodawane w czasie.

Odpowiedzi

Nazwisko Typ Opis

200 OK

Nazwisko	Typ	Opis
200 OK	ConnectionStringResponse	Żądanie zostało ukończone pomyślnie.
429 Too Many Requests	ErrorResponse	Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący `Retry-After` w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań. Nagłówki Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: ItemNotFound — żądany element nie został znaleziony. InvalidGuestTenantId — podany identyfikator nie istnieje.

ConnectionStringResponse

Żądanie zostało ukończone pomyślnie.

429 Too Many Requests

ErrorResponse

Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Retry-After w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań.

Nagłówki

Retry-After: integer

Other Status Codes

ErrorResponse

Typowe kody błędów:

ItemNotFound — żądany element nie został znaleziony.
InvalidGuestTenantId — podany identyfikator nie istnieje.

Przykłady

Get connection string example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 200

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

Definicje

Nazwisko	Opis
ConnectionStringResponse	Parametry połączenia SQL dla obszaru roboczego zawierającego ten punkt końcowy SQL.
ErrorParameter	Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
PrivateLinkType	Wskazuje typ łącza prywatnego używany przez te parametry połączenia. Dodatkowe `privateLinkType` typy mogą być dodawane w czasie.

ConnectionStringResponse

Objekt

Parametry połączenia SQL dla obszaru roboczego zawierającego ten punkt końcowy SQL.

Nazwisko	Typ	Opis
connectionString	string	Parametry połączenia SQL dla obszaru roboczego zawierającego ten punkt końcowy SQL.

ErrorParameter

Objekt

Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.

Nazwisko	Typ	Opis
message	string	Czytelny dla człowieka opis znaczenia parametru.
name	string	Identyfikator parametru.
value	string	Wartość parametru.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwisko	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwisko	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
isRetriable	boolean	Jeśli to prawda, żądanie można ponowić. Użyj nagłówka `Retry-After` odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string (uuid)	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwisko	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

PrivateLinkType

Wyliczenie

Wskazuje typ łącza prywatnego używany przez te parametry połączenia. Dodatkowe privateLinkType typy mogą być dodawane w czasie.

Wartość	Opis
None	Brak łącza prywatnego (ustawienie domyślne).
Workspace	Łącze prywatne obszaru roboczego.