Items - Get Environment Definition

Palvelu:

Environment

Ohjelmointirajapinnan versio:

v1

Palauttaa määritetyn ympäristön julkisen määrityksen.
Tämä ohjelmointirajapinta tukee pitkäkestoisia toimintoja.

Kun saat ympäristön julkisen määrityksen, luottamuksellisuustunniste ei ole osa määritystä.

Käyttöoikeudet

Soittajalla on oltava ympäristön luku- ja kirjoitusoikeudet .

Vaaditut delegoidut vaikutusalueet

Environment.ReadWrite.All tai Item.ReadWrite.All

Rajoitukset

Tämä ohjelmointirajapinta on estetty ympäristössä, jossa on salattu luottamuksellisuustunniste.

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identity	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}/environments/{environmentId}/getDefinition

Valinnaisilla parametreilla:

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Description
environmentId	path	True	string (uuid)	Ympäristötunnus.
workspaceId	path	True	string (uuid)	Työtilan tunnus.
format	query		string	Ympäristön julkisen määrityksen muoto.

Vastaukset

Nimi	Tyyppi	Description
200 OK	EnvironmentDefinitionResponse	Pyynnön valmistuttua.
202 Accepted		Pyyntö hyväksytty. Määrityksen noutaminen on kesken. Otsikot Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Yleiset virhekoodit: OperationNotSupportedForItem – Toimintoa ei tueta pyydetylle kohteelle.

Esimerkit

Get a environment definition example

Mallipyyntö

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/environments/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Mallivastaus

Tilakoodi:

200

{
  "definition": {
    "parts": [
      {
        "path": "Libraries/CustomLibraries/samplelibrary.jar",
        "payload": "eyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/samplepython.py",
        "payload": "FyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/samplewheel-0.18.0-py2.py3-none-any.whl",
        "payload": "LyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/sampleR.tar.gz",
        "payload": "ZyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/PublicLibraries/environment.yml",
        "payload": "IyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Setting/Sparkcompute.yml",
        "payload": "GyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Tilakoodi:

202

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	Description
EnvironmentDefinition	Ympäristön julkinen määritysobjekti. Katso tästä artikkelista lisätietoja ympäristön julkisen määrityksen luomisesta.
EnvironmentDefinitionPart	Ympäristön määritelmäosan objekti.
EnvironmentDefinitionResponse	Ympäristön julkisen määrityksen vastaus.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
PayloadType	Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.

EnvironmentDefinition

Object

Ympäristön julkinen määritysobjekti. Katso tästä artikkelista lisätietoja ympäristön julkisen määrityksen luomisesta.

Nimi	Tyyppi	Description
format	string	Ympäristön määrityksen muoto.
parts	EnvironmentDefinitionPart[]	Luettelo määritysosista.

EnvironmentDefinitionPart

Object

Ympäristön määritelmäosan objekti.

Nimi	Tyyppi	Description
path	string	Ympäristöosan polku.
payload	string	Ympäristön osakuormitus.
payloadType	PayloadType	Hyötykuorman tyyppi.

EnvironmentDefinitionResponse

Object

Ympäristön julkisen määrityksen vastaus.

Nimi	Tyyppi	Description
definition	EnvironmentDefinition	Ympäristön julkinen määritysobjekti. Katso tästä artikkelista lisätietoja ympäristön julkisen määrityksen luomisesta.

ErrorRelatedResource

Object

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Description
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Object

Virhevastaus.

Nimi	Tyyppi	Description
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ä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Object

Virheen vastauksen tiedot.

Nimi	Tyyppi	Description
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ä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

PayloadType

Luettelointi

Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.

Arvo	Description
InlineBase64	Inline Base 64.