Items - Get Connection String

Služba:
Warehouse
Verzia rozhrania API:
v1

Vráti reťazec pripojenia SQL zadaného skladu.

Povolenia

Volajúci musí mať povolenia na čítanie pre sklad. Volajúci musí mať rolu čitateľa alebo vyššieho pracovného priestoru.

Povinné delegované rozsahy

Warehouse.Read.All alebo Warehouse.ReadWrite.All alebo Item.Read.All alebo Item.ReadWrite.All

Podporované identity v aplikácii Microsoft Entra

Toto rozhranie API podporuje identity Microsoft uvedené v tejto časti.

Identita Podporovať
Užívateľ Áno
Objekt služby a spravované identity Áno

Rozhranie

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses/{warehouseId}/connectionString
S voliteľnými parametrami: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses/{warehouseId}/connectionString?guestTenantId={guestTenantId}&privateLinkType={privateLinkType}

Parametre URI

Name V Povinné Typ Description
warehouseId
 path True

string (uuid)

ID skladu.
workspaceId
 path True

string (uuid)

ID pracovného priestoru.
guestTenantId
 query

string (uuid)

ID hosťovského nájomníka, ak je nájomník koncového používateľa iný ako nájomník skladu.
privateLinkType
 query

PrivateLinkType

Označuje typ súkromného prepojenia, ktoré tento reťazec pripojenia používa. V priebehu času je možné pridať ďalšie privateLinkType typy.

Odpovede

Name Typ Description
200 OK

ConnectionStringResponse

Požiadavka sa úspešne dokončila.
429 Too Many Requests

ErrorResponse

Prekročil sa limit rýchlosti služby. Server vráti hlavičku Retry-After v sekundách, ako dlho musí klient počkať, kým odošle ďalšie požiadavky.

Hlavičky

Retry-After: integer
Other Status Codes

ErrorResponse

Bežné kódy chýb:

  • ItemNotFound – požadovaná položka sa nenašla.

  • InvalidGuestTenantId – zadané ID hosťovského nájomníka neexistuje.

Príklady

Get connection string example

Vzorová požiadavka

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

Vzorová odpoveď

Kód stavu:
200 
{
  "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m-jh0bi.zcf.datawarehouse.fabric.microsoft.com"
}

Definície

Name Description
ConnectionStringResponse

Reťazec pripojenia SQL pre pracovný priestor obsahujúci tento sklad.
ErrorRelatedResource

Objekt s podrobnosťami o zdroji súvisiacej s chybou.
ErrorResponse

Odpoveď na chybu.
ErrorResponseDetails

Podrobnosti o chybovej odpovedi.
PrivateLinkType

Označuje typ súkromného prepojenia, ktoré tento reťazec pripojenia používa. V priebehu času je možné pridať ďalšie privateLinkType typy.

ConnectionStringResponse

Object

Reťazec pripojenia SQL pre pracovný priestor obsahujúci tento sklad.

Name Typ Description
connectionString

string

Reťazec pripojenia SQL pre pracovný priestor obsahujúci tento sklad.

ErrorRelatedResource

Object

Objekt s podrobnosťami o zdroji súvisiacej s chybou.

Name Typ Description
resourceId

string

ID prostriedku, ktoré je súčasťou chyby.
resourceType

string

Typ prostriedku, ktorý je zapojený do chyby.

ErrorResponse

Object

Odpoveď na chybu.

Name Typ Description
errorCode

string

Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
isRetriable

boolean

Ak je hodnota true, žiadosť sa môže zopakovať. Retry-After Ak je k dispozícii, oneskorenie môžete určiť pomocou hlavičky odpovede.
message

string

Zobrazenie chyby čitateľné ľuďmi.
moreDetails

ErrorResponseDetails[]

Zoznam ďalších podrobností o chybe.
relatedResource

ErrorRelatedResource

Podrobnosti o zdrojoch súvisiacich s chybou.
requestId

string (uuid)

ID požiadavky súvisiacej s chybou.

ErrorResponseDetails

Object

Podrobnosti o chybovej odpovedi.

Name Typ Description
errorCode

string

Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message

string

Zobrazenie chyby čitateľné ľuďmi.
relatedResource

ErrorRelatedResource

Podrobnosti o zdrojoch súvisiacich s chybou.

PrivateLinkType

Enumerácia

Označuje typ súkromného prepojenia, ktoré tento reťazec pripojenia používa. V priebehu času je možné pridať ďalšie privateLinkType typy.

Hodnota Description
None

Žiadne súkromné prepojenie (predvolené).
Workspace

Súkromné prepojenie pracovného priestoru.