Items - Get Connection String

Vrátí připojovací řetězec SQL zadaného skladu.

Dovolení

Volající musí mít oprávnění ke čtení pro sklad. Volající musí mít roli čtenáře nebo vyššího pracovního prostoru.

Požadované delegovaná rozsahy

Warehouse.Read.All nebo Warehouse.ReadWrite.All nebo Item.Read.All nebo Item.ReadWrite.All

Podporované identity Microsoft Entra

Toto rozhraní API podporuje identity Microsoftu uvedené v této části.

Identita Support
Uživatel Ano
Instanční objekt a spravované identity Ano

Rozhraní

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

Parametry identifikátoru URI

Název V Vyžadováno Typ Description
warehouseId
path True

string (uuid)

ID skladu.

workspaceId
path True

string (uuid)

ID pracovního prostoru.

guestTenantId
query

string (uuid)

ID tenanta hosta, pokud se tenant koncového uživatele liší od tenanta skladu.

privateLinkType
query

PrivateLinkType

Určuje typ privátního propojení, který tento připojovací řetězec používá. V průběhu času je možné přidat další privateLinkType typy.

Odpovědi

Název Typ Description
200 OK

ConnectionStringResponse

Žádost byla úspěšně dokončena.

429 Too Many Requests

ErrorResponse

Byl překročen limit přenosové rychlosti služby. Server vrátí hlavičku označující Retry-After , jak dlouho musí klient čekat před odesláním dalších požadavků.

Hlavičky

Retry-After: integer

Other Status Codes

ErrorResponse

Běžné kódy chyb:

  • ItemNotFound – Požadovaná položka nebyla nalezena.

  • InvalidGuestTenantId – Zadané ID tenanta hosta neexistuje.

Příklady

Get connection string example

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Název Description
ConnectionStringResponse

Připojovací řetězec SQL pro pracovní prostor obsahující tento sklad.

ErrorParameter

Strukturovaný parametr poskytující další strojově čitelný kontext chyby.

ErrorRelatedResource

Chyba související s objektem podrobností o prostředku.

ErrorResponse

Odpověď na chybu.

ErrorResponseDetails

Podrobnosti o odpovědi na chybu.

PrivateLinkType

Určuje typ privátního propojení, který tento připojovací řetězec používá. V průběhu času je možné přidat další privateLinkType typy.

ConnectionStringResponse

Připojovací řetězec SQL pro pracovní prostor obsahující tento sklad.

Název Typ Description
connectionString

string

Připojovací řetězec SQL pro pracovní prostor obsahující tento sklad.

ErrorParameter

Strukturovaný parametr poskytující další strojově čitelný kontext chyby.

Název Typ Description
message

string

Popis významu parametru čitelný člověkem.

name

string

Identifikátor parametru.

value

string

Hodnota parametru.

ErrorRelatedResource

Chyba související s objektem podrobností o prostředku.

Název Typ Description
resourceId

string

ID prostředku, které je součástí chyby.

resourceType

string

Typ prostředku, který je součástí chyby.

ErrorResponse

Odpověď na chybu.

Název Typ Description
errorCode

string

Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.

isRetriable

boolean

Pokud je hodnota true, je možné požadavek opakovat. Pomocí hlavičky Retry-After odpovědi určete zpoždění, pokud je k dispozici.

message

string

Lidské čitelné vyjádření chyby.

moreDetails

ErrorResponseDetails[]

Seznam dalších podrobností o chybě

parameters

ErrorParameter[]

Strukturované parametry poskytují další strojově čitelný kontext chyby.

relatedResource

ErrorRelatedResource

Podrobnosti o prostředku souvisejícím s chybou

requestId

string (uuid)

ID požadavku přidruženého k chybě.

ErrorResponseDetails

Podrobnosti o odpovědi na chybu.

Název Typ Description
errorCode

string

Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.

message

string

Lidské čitelné vyjádření chyby.

parameters

ErrorParameter[]

Strukturované parametry poskytují další strojově čitelný kontext chyby.

relatedResource

ErrorRelatedResource

Podrobnosti o prostředku souvisejícím s chybou

PrivateLinkType

Určuje typ privátního propojení, který tento připojovací řetězec používá. V průběhu času je možné přidat další privateLinkType typy.

Hodnota Description
None

Bez privátního propojení (výchozí).

Workspace

Private Link pracovního prostoru