Items - Get Variable Library Definition
Returnerer den angitte fellesdefinisjonen for variabelbiblioteket.
Denne API-en støtter langvarige operasjoner (LRO).
Når du får en variabellibrarys offentlige definisjon, er ikke følsomhetsetiketten en del av definisjonen.
Tillatelser
Innringeren må ha lese- og skrivetillatelser for variabelbiblioteket.
Nødvendige delegerte omfang
VariableLibrary.ReadWrite.All eller Item.ReadWrite.All
Begrensninger
Hvis du vil hente definisjonen av et variabelbibliotekelement som er beskyttet av en kryptert følsomhetsetikett, må innringeren ha tilstrekkelige bruksrettigheter til å fjerne etiketten, som konfigurert i Microsoft Purview.
Microsoft Entra-støttede identiteter
Denne API-en støtter Microsoft -identiteter oppført i denne delen.
| Identitet | Støtte |
|---|---|
| Bruker | Ja |
| tjenestekontohaver og administrerte identiteter | Ja |
Grensesnitt
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/variableLibraries/{variableLibraryId}/getDefinition
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/variableLibraries/{variableLibraryId}/getDefinition?format={format}
URI-parametere
| Name | I | Obligatorisk | Type | Beskrivelse |
|---|---|---|---|---|
|
variable
|
path | True |
string (uuid) |
VariableLibrary-ID-en. |
|
workspace
|
path | True |
string (uuid) |
Arbeidsområde-ID-en. |
|
format
|
query |
string |
Formatet for den offentlige definisjonen variablelibrary. |
Svar
| Name | Type | Beskrivelse |
|---|---|---|
| 200 OK |
Forespørselen er fullført. |
|
| 202 Accepted |
Forespørselen er godtatt. Henting av definisjonen pågår. Overskrifter
|
|
| 429 Too Many Requests |
Grensen for tjenestesats ble overskredet. Serveren returnerer en Overskrifter Retry-After: integer |
|
| Other Status Codes |
Vanlige feilkoder:
|
Eksempler
Get a VariableLibrary public definition example
Eksempelforespørsel
POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/variableLibraries/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition
Eksempelsvar
{
"definition": {
"parts": [
{
"path": "variables.json",
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
"payloadType": "InlineBase64"
},
{
"path": "valueSets/valueSet1.json",
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
"payloadType": "InlineBase64"
},
{
"path": "settings.json",
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30
Definisjoner
| Name | Beskrivelse |
|---|---|
|
Error |
En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil. |
|
Error |
Objektet for feilrelaterte ressursdetaljer. |
|
Error |
Feilsvaret. |
|
Error |
Feilsvardetaljene. |
|
Payload |
Typen nyttelast for definisjonsdelen. Flere nyttelasttyper kan legges til over tid. |
|
Variable |
VariableLibrary public definition response. |
|
Variable |
VariableLibrary public definition object. Se denne artikkelen for mer informasjon om strukturen i VariableLibrary-definisjonen. |
|
Variable |
VariableLibrary definition part object. |
ErrorParameter
En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.
| Name | Type | Beskrivelse |
|---|---|---|
| message |
string |
En lesbar beskrivelse av parameterens betydning. |
| name |
string |
Parameteridentifikatoren. |
| value |
string |
Parameterverdien. |
ErrorRelatedResource
Objektet for feilrelaterte ressursdetaljer.
| Name | Type | Beskrivelse |
|---|---|---|
| resourceId |
string |
Ressurs-ID-en som er involvert i feilen. |
| resourceType |
string |
Typen ressurs som er involvert i feilen. |
ErrorResponse
Feilsvaret.
| Name | Type | Beskrivelse |
|---|---|---|
| errorCode |
string |
En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne. |
| isRetriable |
boolean |
Når sann, kan forespørselen prøves på nytt.
|
| message |
string |
En menneskelig lesbar representasjon av feilen. |
| moreDetails |
Liste over flere feildetaljer. |
|
| parameters |
Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen. |
|
| relatedResource |
Feilrelaterte ressursdetaljer. |
|
| requestId |
string (uuid) |
ID for forespørselen som er knyttet til feilen. |
ErrorResponseDetails
Feilsvardetaljene.
| Name | Type | Beskrivelse |
|---|---|---|
| errorCode |
string |
En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne. |
| message |
string |
En menneskelig lesbar representasjon av feilen. |
| parameters |
Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen. |
|
| relatedResource |
Feilrelaterte ressursdetaljer. |
PayloadType
Typen nyttelast for definisjonsdelen. Flere nyttelasttyper kan legges til over tid.
| Verdi | Beskrivelse |
|---|---|
| InlineBase64 |
Innebygd grunntall 64. |
VariableLibraryDefinitionResponse
VariableLibrary public definition response.
| Name | Type | Beskrivelse |
|---|---|---|
| definition |
VariableLibrary public definition object. Se denne artikkelen for mer informasjon om strukturen i VariableLibrary-definisjonen. |
VariableLibraryPublicDefinition
VariableLibrary public definition object. Se denne artikkelen for mer informasjon om strukturen i VariableLibrary-definisjonen.
| Name | Type | Beskrivelse |
|---|---|---|
| format |
string |
Formatet for definisjonen av variabelbiblioteket. Støttet format: |
| parts |
En liste over definisjonsdeler. |
VariableLibraryPublicDefinitionPart
VariableLibrary definition part object.
| Name | Type | Beskrivelse |
|---|---|---|
| path |
string |
Den offentlige definisjonsdelbanen for VariableLibrary. |
| payload |
string |
VariableLibrary public definition part payload. |
| payloadType |
Nyttelasttypen. |