Udostępnij przez

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

Nazwa 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

Nazwa Typ Opis
200 OK

ConnectionStringResponse

Żądanie zostało ukończone pomyślnie.
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

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

Nazwa Opis
ConnectionStringResponse

Parametry połączenia SQL dla obszaru roboczego zawierającego ten punkt końcowy SQL.
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.

Nazwa Typ Opis
connectionString

string

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

ErrorRelatedResource

Objekt

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

Nazwa 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.

Nazwa 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.
moreDetails

ErrorResponseDetails[]

Lista dodatkowych szczegółów błędu.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.
requestId

string

Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa 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.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.

PrivateLinkType

Wyliczanie

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.