Items - Update Environment Definition

Dienst:: Environment

API-Version:: v1

Überschreibt die Definition für die angegebene Umgebung.
Diese API unterstützt LRO-.

Das Aktualisieren der Umgebungsdefinition wirkt sich nicht auf die Vertraulichkeitsbezeichnung aus.

Erlaubnisse

Der Aufrufer muss Über Lese- und Schreibberechtigungen für die Umgebung verfügen.

Erforderliche delegierte Bereiche

Environment.ReadWrite.All oder Item.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität	Support
Benutzer	Yes
Service Principal und Verwaltete Identitäten	Yes

Schnittstelle

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
environmentId	path	True	string (uuid)	Die Umgebungs-ID.
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.
updateMetadata	query		boolean	Wenn sie auf "true" festgelegt ist und die PLATTFORM-Datei als Teil der Definition bereitgestellt wird, werden die Metadaten des Elements mithilfe der Metadaten in der PLATTFORM-Datei aktualisiert.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
definition	True	EnvironmentDefinition	Öffentliches Definitionsobjekt der Umgebung. Weitere Informationen zum Erstellen einer öffentlichen Umgebungsdefinition finden Sie in diesem Artikel .

Antworten

Name	Typ	Beschreibung
200 OK		Die Anforderung wurde erfolgreich abgeschlossen.
202 Accepted		Anforderung angenommen. Die Updatedefinition wird ausgeführt. Header Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Häufige Fehlercodes: OperationNotSupportedForItem – Vorgang für angefordertes Element nicht unterstützt. CorruptedPayload – Die bereitgestellte Nutzlast ist beschädigt.

Name

Typ

Beschreibung

200 OK

Die Anforderung wurde erfolgreich abgeschlossen.

202 Accepted

Anforderung angenommen. Die Updatedefinition wird ausgeführt.

Header

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

OperationNotSupportedForItem – Vorgang für angefordertes Element nicht unterstützt.
CorruptedPayload – Die bereitgestellte Nutzlast ist beschädigt.

Beispiele

Update a environment definition example

Beispielanforderung

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

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

Beispiel für eine Antwort

Statuscode:: 200

Statuscode:: 202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Definitionen

Name	Beschreibung
EnvironmentDefinition	Öffentliches Definitionsobjekt der Umgebung. Weitere Informationen zum Erstellen einer öffentlichen Umgebungsdefinition finden Sie in diesem Artikel .
EnvironmentDefinitionPart	Umgebungsdefinitionsteilobjekt.
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
PayloadType	Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.
UpdateEnvironmentDefinitionRequest	Aktualisieren sie die Nutzlast der öffentlichen Definitionsanforderung der Umgebung.

EnvironmentDefinition

Objekt

Öffentliches Definitionsobjekt der Umgebung. Weitere Informationen zum Erstellen einer öffentlichen Umgebungsdefinition finden Sie in diesem Artikel .

Name	Typ	Beschreibung
format	string	Das Format der Umgebungsdefinition.
parts	EnvironmentDefinitionPart[]	Eine Liste der Definitionsteile.

EnvironmentDefinitionPart

Objekt

Umgebungsdefinitionsteilobjekt.

Name	Typ	Beschreibung
path	string	Der Umgebungsteilpfad.
payload	string	Die Nutzlast des Umgebungsteils.
payloadType	PayloadType	Der Nutzlasttyp.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name	Typ	Beschreibung
resourceId	string	Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType	string	Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string	ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

PayloadType

Enumeration

Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
InlineBase64	Inlinebasis 64.

UpdateEnvironmentDefinitionRequest

Objekt

Aktualisieren sie die Nutzlast der öffentlichen Definitionsanforderung der Umgebung.

Name	Typ	Beschreibung
definition	EnvironmentDefinition	Öffentliches Definitionsobjekt der Umgebung. Weitere Informationen zum Erstellen einer öffentlichen Umgebungsdefinition finden Sie in diesem Artikel .

Freigeben über

Items - Update Environment Definition

Erlaubnisse

Erforderliche delegierte Bereiche

Von Microsoft Entra unterstützte Identitäten

Schnittstelle

URI-Parameter

Anforderungstext

Antworten

Beispiele

Update a environment definition example

Beispielanforderung

Beispiel für eine Antwort

Definitionen

EnvironmentDefinition

EnvironmentDefinitionPart

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

PayloadType

UpdateEnvironmentDefinitionRequest