Items - Get Warehouse Definition

Tjeneste:: Warehouse

API-version:: v1

Returnerer den angivne offentlige definition af lageret.
Denne API understøtter LRO-handlinger (Long Running Operations).

Når du får et lagers offentlige definition, er følsomhedsmærkaten ikke en del af definitionen.

Permissions

Den, der ringer op, skal have læse- og skrivetilladelser til lageret.

Påkrævede delegerede områder

Warehouse.ReadWrite.All eller Item.ReadWrite.All

Begrænsninger

Hvis du vil hente definitionen af et lagerelement, der er beskyttet af en krypteret følsomhedsmærkat, skal kalderen have tilstrækkelige brugsrettigheder til at fjerne mærkaten som konfigureret i Microsoft Purview.

Microsoft Entra understøttede identiteter

Denne API understøtter de Microsoft identities, der er angivet i dette afsnit.

Identity	Support
User	Ja
tjenesteprincipal og administrerede identiteter	Ja

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses/{warehouseId}/getDefinition

Med valgfrie parametre:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses/{warehouseId}/getDefinition?format={format}

URI-parametre

Navn	I	Påkrævet	Type	Beskrivelse
warehouseId	path	True	string (uuid)	Lager-id'et.
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.
format	query		WarehouseDefinitionFormat	Formatet for den offentlige definition af lageret. Understøttede formater: `dacpac` og `sqlproj`. Hvis der ikke er angivet et format, `sqlproj` bruges . Der kan tilføjes flere lagerdefinitionsformater over tid.

Svar

Navn	Type	Beskrivelse
200 OK	WarehouseDefinitionResponse	Anmodningen blev fuldført.
202 Accepted		Anmodningen blev accepteret. Hentning af definitionen er i gang. Headere Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: OperationNotSupportedForItem – Handlingen understøttes ikke for det ønskede element.

Eksempler

Get a warehouse public definition in DACPAC format example

Get a warehouse public definition in SQL project format example

Get a warehouse public definition in DACPAC format example

Eksempelanmodning

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/warehouses/5b218778-e7a5-4d73-8187-f10824047715/getDefinition?format=dacpac

Eksempelsvar

Statuskode:: 200

{
  "definition": {
    "parts": [
      {
        "path": "definition.dacpac",
        "payload": "UEsDBBQAAAAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAGRlZmluaXRpb24uZGFjcGFj",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIldhcmVob3VzZSIsCiAgICAiZGlzcGxheU5hbWUiOiAiV2FyZWhvdXNlXzEiCiAgfSwKICAiY29uZmlnIjogewogICAgInZlcnNpb24iOiAiMi4wIiwKICAgICJsb2dpY2FsSWQiOiAiMDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAwIgogIH0KfQ==",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Statuskode:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Get a warehouse public definition in SQL project format example

Eksempelanmodning

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/warehouses/5b218778-e7a5-4d73-8187-f10824047715/getDefinition?format=sqlproj

Eksempelsvar

Statuskode:: 200

{
  "definition": {
    "parts": [
      {
        "path": "sqldw.sqlproj",
        "payload": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjxQcm9qZWN0IERlZmF1bHRUYXJnZXRzPSJCdWlsZCI+DQogIDxTZGs+TWljcm9zb2Z0LkJ1aWxkLlNxbC9TZGsNCiAgPC9TZGs+DQo8L1Byb2plY3Q+",
        "payloadType": "InlineBase64"
      },
      {
        "path": "dbo/Tables/Table1.sql",
        "payload": "Q1JFQVRFIFRBQkxFIFtkYm9dLltUYWJsZTFdIChbSWRdIElOVCBOT1QgTlVMTCwgW05hbWVdIE5WQVJDSEFSKDEwMCkp",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".sharedqueries/query.sql",
        "payload": "U0VMRUNUIFtJZF0sIFtOYW1lXSBGUk9NIFtkYm9dLltUYWJsZTFd",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Statuskode:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definitioner

Navn	Beskrivelse
ErrorParameter	En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
PayloadType	Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.
WarehouseDefinition	Objektet til offentlig definition af lageret. Se denne artikel for at få flere oplysninger om strukturen i lagerdefinitionen.
WarehouseDefinitionFormat	Formatet for den offentlige definition af lageret. Understøttede formater: `dacpac` og `sqlproj`. Hvis der ikke er angivet et format, `sqlproj` bruges . Der kan tilføjes flere lagerdefinitionsformater over tid.
WarehouseDefinitionPart	Objekt for lagerdefinitionsdel.
WarehouseDefinitionResponse	Svaret på den offentlige definition af lageret.

ErrorParameter

Objekt

En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.

Navn	Type	Beskrivelse
message	string	En læsevenlig beskrivelse af parameterens betydning.
name	string	Parameter-id'et.
value	string	Parameterens værdi.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Navn	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Navn	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable	boolean	Når sand, kan anmodningen prøves igen. Brug svarheaderen `Retry-After` til at bestemme forsinkelsen, hvis den er tilgængelig.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Navn	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

PayloadType

Optælling

Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.

Værdi	Beskrivelse
InlineBase64	Indbygget grundlinje 64.

WarehouseDefinition

Objekt

Objektet til offentlig definition af lageret. Se denne artikel for at få flere oplysninger om strukturen i lagerdefinitionen.

Navn	Type	Beskrivelse
format	string	Formatet af lagerdefinitionen. Understøttede formater: `dacpac` og `sqlproj`. Hvis der ikke er angivet et format, `sqlproj` bruges .
parts	WarehouseDefinitionPart[]	En liste over definitionsdele.

WarehouseDefinitionFormat

Optælling

Formatet for den offentlige definition af lageret. Understøttede formater: dacpac og sqlproj. Hvis der ikke er angivet et format, sqlproj bruges . Der kan tilføjes flere lagerdefinitionsformater over tid.

Værdi	Beskrivelse
dacpac	Lagerdefinitionen i DACPAC-format.
sqlproj	Lagerdefinitionen i SQL-projektformat.

WarehouseDefinitionPart

Objekt

Objekt for lagerdefinitionsdel.

Navn	Type	Beskrivelse
path	string	Stien til den offentlige definition af lageret.
payload	string	Nyttedata for den offentlige definition af lageret.
payloadType	PayloadType	Nyttedatatypen.

WarehouseDefinitionResponse

Objekt

Svaret på den offentlige definition af lageret.

Navn	Type	Beskrivelse
definition	WarehouseDefinition	Objektet til offentlig definition af lageret. Se denne artikel for at få flere oplysninger om strukturen i lagerdefinitionen.