Items - Get Variable Library Definition
Palauttaa määritetyn muuttujakirjaston julkisen määrityksen.
Tämä ohjelmointirajapinta tukee pitkäkestoisia toimintoja.
Kun saat VariableLibrary-ohjausobjektin julkisen määrityksen, luottamuksellisuustunniste ei ole osa määritelmää.
Käyttöoikeudet
Soittajalla on oltava muuttujakirjaston luku- ja kirjoitusoikeudet .
Vaaditut delegoidut vaikutusalueet
VariableLibrary.ReadWrite.All tai Item.ReadWrite.All
Rajoitukset
Jotta soittaja voi noutaa salatulla luottamuksellisuustunnisteellä suojatun muuttujakirjastokohteen määrityksen, hänellä on oltava riittävät käyttöoikeudet tunnisteen poistamiseen, kuten Microsoft Purview on määritetty.
Microsoft Entran tukemat käyttäjätiedot
Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.
| Käyttäjätiedot | Tuki |
|---|---|
| Käyttäjä | Kyllä |
| palvelun päänimen ja Hallittujen käyttäjätietojen | Kyllä |
Liittymä
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-parametrit
| Nimi | Kohteessa | Pakollinen | Tyyppi | Kuvaus |
|---|---|---|---|---|
|
variable
|
path | True |
string (uuid) |
VariableLibrary-tunnus. |
|
workspace
|
path | True |
string (uuid) |
Työtilan tunnus. |
|
format
|
query |
string |
Muuttujalibraryn julkisen määrityksen muoto. |
Vastaukset
| Nimi | Tyyppi | Kuvaus |
|---|---|---|
| 200 OK |
Pyynnön valmistuttua. |
|
| 202 Accepted |
Pyyntö hyväksytty. Määrityksen noutaminen on kesken. Otsikot
|
|
| 429 Too Many Requests |
Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka Otsikot Retry-After: integer |
|
| Other Status Codes |
Yleiset virhekoodit:
|
Esimerkit
Get a VariableLibrary public definition example
Mallipyyntö
POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/variableLibraries/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition
Mallivastaus
{
"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
Määritelmät
| Nimi | Kuvaus |
|---|---|
|
Error |
Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä. |
|
Error |
Virheeseen liittyvä resurssitieto-objekti. |
|
Error |
Virhevastaus. |
|
Error |
Virheen vastauksen tiedot. |
|
Payload |
Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa. |
|
Variable |
VariableLibrary-määrityksen vastaus. |
|
Variable |
VariableLibrary public definition object. Lisätietoja VariableLibrary-määrityksen rakenteesta on tässä artikkelissa . |
|
Variable |
VariableLibrary-määritelmäosaobjekti. |
ErrorParameter
Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä.
| Nimi | Tyyppi | Kuvaus |
|---|---|---|
| message |
string |
Ihmisen luettavissa oleva kuvaus parametrin merkityksestä. |
| name |
string |
Parametritunniste. |
| value |
string |
Parametriarvo. |
ErrorRelatedResource
Virheeseen liittyvä resurssitieto-objekti.
| Nimi | Tyyppi | Kuvaus |
|---|---|---|
| resourceId |
string |
Virheestä liittyvä resurssitunnus. |
| resourceType |
string |
Virheestä liittyvän resurssin tyyppi. |
ErrorResponse
Virhevastaus.
| Nimi | Tyyppi | Kuvaus |
|---|---|---|
| errorCode |
string |
Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä. |
| isRetriable |
boolean |
Kun arvo on tosi, pyyntöä voidaan yrittää uudelleen. Määritä viive vastausotsikon |
| message |
string |
Ihmisen luettavissa oleva esitys virheestä. |
| moreDetails |
Luettelo virheiden lisätiedoista. |
|
| parameters |
Jäsennettyjä parametreja, jotka antavat koneluettavaa lisäkontekstia virheestä. |
|
| relatedResource |
Virheisiin liittyvät resurssitiedot. |
|
| requestId |
string (uuid) |
Virheeseen liittyvän pyynnön tunnus. |
ErrorResponseDetails
Virheen vastauksen tiedot.
| Nimi | Tyyppi | Kuvaus |
|---|---|---|
| errorCode |
string |
Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä. |
| message |
string |
Ihmisen luettavissa oleva esitys virheestä. |
| parameters |
Jäsennettyjä parametreja, jotka antavat koneluettavaa lisäkontekstia virheestä. |
|
| relatedResource |
Virheisiin liittyvät resurssitiedot. |
PayloadType
Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.
| Arvo | Kuvaus |
|---|---|
| InlineBase64 |
Inline Base 64. |
VariableLibraryDefinitionResponse
VariableLibrary-määrityksen vastaus.
| Nimi | Tyyppi | Kuvaus |
|---|---|---|
| definition |
VariableLibrary public definition object. Lisätietoja VariableLibrary-määrityksen rakenteesta on tässä artikkelissa . |
VariableLibraryPublicDefinition
VariableLibrary public definition object. Lisätietoja VariableLibrary-määrityksen rakenteesta on tässä artikkelissa .
| Nimi | Tyyppi | Kuvaus |
|---|---|---|
| format |
string |
Muuttujakirjaston määrityksen muoto. Tuettu muoto: |
| parts |
Luettelo määritysosista. |
VariableLibraryPublicDefinitionPart
VariableLibrary-määritelmäosaobjekti.
| Nimi | Tyyppi | Kuvaus |
|---|---|---|
| path |
string |
VariableLibrary-julkisen määrityksen osan polku. |
| payload |
string |
VariableLibrary-julkisen määritelmän osakuormitus. |
| payloadType |
Hyötykuorman tyyppi. |