Items - Get Environment Definition

Service:

Environment

API-versie:

v1

Retourneert de opgegeven openbare omgevingsdefinitie.
Deze API ondersteunt langlopende bewerkingen (LRO).

Wanneer u de openbare definitie van een omgeving krijgt, maakt het vertrouwelijkheidslabel geen deel uit van de definitie.

Permissions

De aanroeper moet lees- en schrijfmachtigingen hebben voor de omgeving.

Vereiste gedelegeerde bereiken

Environment.ReadWrite.All of Item.ReadWrite.All

Beperkingen

Deze API wordt geblokkeerd voor een omgeving met een versleuteld vertrouwelijkheidslabel.

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identiteit	Support
User	Yes
serviceprincipal en beheerde identiteiten	Yes

gebruikersinterface

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
environmentId	path	True	string (uuid)	De omgevings-id.
workspaceId	path	True	string (uuid)	De werkruimte-ID.
format	query		string	De indeling van de openbare omgevingsdefinitie.

Antwoorden

Name	Type	Description
200 OK	EnvironmentDefinitionResponse	De aanvraag is voltooid.
202 Accepted		Aanvraag geaccepteerd. Het ophalen van de definitie wordt uitgevoerd. Kopteksten Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: OperationNotSupportedForItem - Bewerking wordt niet ondersteund voor aangevraagd item.

Voorbeelden

Get a environment definition example

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

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"
      }
    ]
  }
}

Statuscode:

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

Definities

Name	Description
EnvironmentDefinition	Object voor openbare definitie van omgeving. Raadpleeg dit artikel voor meer informatie over het maken van een openbare definitie van een omgeving.
EnvironmentDefinitionPart	Object van het onderdeel omgevingsdefinitie.
EnvironmentDefinitionResponse	Antwoord van openbare definitie van omgeving.
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
PayloadType	Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.

EnvironmentDefinition

Object

Object voor openbare definitie van omgeving. Raadpleeg dit artikel voor meer informatie over het maken van een openbare definitie van een omgeving.

Name	Type	Description
format	string	De indeling van de omgevingsdefinitie.
parts	EnvironmentDefinitionPart[]	Een lijst met definitieonderdelen.

EnvironmentDefinitionPart

Object

Object van het onderdeel omgevingsdefinitie.

Name	Type	Description
path	string	Het pad van het omgevingsonderdeel.
payload	string	De nettolading van het omgevingsonderdeel.
payloadType	PayloadType	Het nettoladingstype.

EnvironmentDefinitionResponse

Object

Antwoord van openbare definitie van omgeving.

Name	Type	Description
definition	EnvironmentDefinition	Object voor openbare definitie van omgeving. Raadpleeg dit artikel voor meer informatie over het maken van een openbare definitie van een omgeving.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

PayloadType

Inventarisatie

Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.

Waarde	Description
InlineBase64	Inline base 64.