Library - List

Usługa:

Synapse

Wersja interfejsu API:

2020-12-01

biblioteka Listy.

GET {endpoint}/libraries?api-version=2020-12-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string uri	Punkt końcowy programowania obszaru roboczego, na przykład https://myworkspace.dev.azuresynapse.net.
api-version	query	True	string	Wersja interfejsu API klienta usługi Synapse.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	LibraryListResponse	OK.
Other Status Codes	CloudError	Odebrano odpowiedź o błędzie z usługi Azure Synapse.

Przykłady

List Libraries

Przykładowe żądanie

HTTP

GET exampleWorkspace.dev.azuresynapse.net/libraries?api-version=2020-12-01

Przykładowa odpowiedź

Kod stanu:

200

Date: Sat, 16 Jun 2018 00:37:36 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14994
x-ms-request-id: 558d0fd8-dc1f-44b6-9ca9-59fcca8af9a5
x-ms-correlation-request-id: 558d0fd8-dc1f-44b6-9ca9-59fcca8af9a5

{
  "value": [
    {
      "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraries/exampleLibraryName.jar",
      "name": "exampleLibraryName.jar",
      "type": "Microsoft.Synapse/workspaces/libraries",
      "properties": {
        "name": "exampleLibraryName.jar",
        "path": "exampleWorkspace/libraries/exampleLibraryName.jar",
        "containerName": "exampleContainer",
        "type": "jar",
        "uploadedTimestamp": "2020-10-23T07:59:29.1573546+00:00",
        "provisioningStatus": "Succeeded",
        "creatorId": "2222222e-222d-222f-2222-22a2f222d2f2"
      },
      "etag": "1500474f-0000-0200-0000-5cbe090d0000"
    }
  ]
}

Definicje

Nazwa	Opis
CloudError	Obiekt, który definiuje strukturę odpowiedzi Azure Synapse błędu.
LibraryListResponse	Lista zasobów biblioteki.
LibraryResource	Szczegóły odpowiedzi biblioteki
LibraryResourceProperties	Właściwości biblioteki/pakietu

CloudError

Obiekt, który definiuje strukturę odpowiedzi Azure Synapse błędu.

Nazwa	Typ	Opis
error.code	string	Kod błędu.
error.details	CloudError[]	Tablica z dodatkowymi szczegółami błędu.
error.message	string	Komunikat o błędzie.
error.target	string	Nazwa/ścieżka właściwości w żądaniu skojarzonym z błędem.

LibraryListResponse

Lista zasobów biblioteki.

Nazwa	Typ	Opis
nextLink	string	Link do następnej strony wyników, jeśli istnieją jakiekolwiek pozostałe wyniki.
value	LibraryResource[]	Lista biblioteki.

LibraryResource

Szczegóły odpowiedzi biblioteki

Nazwa	Typ	Opis
etag	string	Zasób Etag.
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties	LibraryResourceProperties	Właściwości biblioteki/pakietu.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

LibraryResourceProperties

Właściwości biblioteki/pakietu

Nazwa	Typ	Opis
containerName	string	Nazwa kontenera biblioteki/pakietu.
creatorId	string	Identyfikator twórcy biblioteki/pakietu.
name	string	Nazwa biblioteki/pakietu.
path	string	Lokalizacja biblioteki/pakietu na koncie magazynu.
provisioningStatus	string	Stan aprowizacji biblioteki/pakietu.
type	string	Typ biblioteki/pakietu.
uploadedTimestamp	string	Czas ostatniej aktualizacji biblioteki/pakietu.