Udostępnij przez

Items - Update Environment Definition

Usługa:
Environment
Wersja interfejsu API:
v1

Zastępuje definicję określonego środowiska.
Ten interfejs API obsługuje długotrwałych operacji (LRO).

Aktualizowanie definicji środowiska nie ma wpływu na etykietę poufności.

Permissions

Obiekt wywołujący musi mieć uprawnienia do odczytu i zapisu dla środowiska.

Wymagane zakresy delegowane

Environment.ReadWrite.All lub Item.ReadWrite.All

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Tożsamość Support
User Tak
Główne usługi i Tożsamości zarządzane Tak

Interfejs

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
environmentId
 path True

string (uuid)

Identyfikator środowiska.
workspaceId
 path True

string (uuid)

Identyfikator przestrzeni roboczej.
updateMetadata
 query

boolean

W przypadku ustawienia wartości true i pliku platformy w ramach definicji metadane elementu są aktualizowane przy użyciu metadanych w pliku platformy .

Treść żądania

Nazwa Wymagane Typ Opis
definition True

EnvironmentDefinition

Obiekt definicji publicznej środowiska. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat tworzenia definicji publicznej środowiska.

Odpowiedzi

Nazwa Typ Opis
200 OK

Żądanie zostało ukończone pomyślnie.
202 Accepted

Zaakceptowano żądanie. Trwa aktualizowanie definicji.

Nagłówki

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • OperationNotSupportedForItem — operacja nieobsługiwana dla żądanego elementu.

  • CorruptedPayload — podany ładunek jest uszkodzony.

Przykłady

Update a environment definition example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
200
Kod stanu:
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

Definicje

Nazwa Opis
EnvironmentDefinition

Obiekt definicji publicznej środowiska. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat tworzenia definicji publicznej środowiska.
EnvironmentDefinitionPart

Obiekt części definicji środowiska.
ErrorRelatedResource

Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.
PayloadType

Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.
UpdateEnvironmentDefinitionRequest

Aktualizowanie ładunku żądania definicji publicznej środowiska.

EnvironmentDefinition

Objekt

Obiekt definicji publicznej środowiska. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat tworzenia definicji publicznej środowiska.

Nazwa Typ Opis
format

string

Format definicji środowiska.
parts

EnvironmentDefinitionPart[]

Lista części definicji.

EnvironmentDefinitionPart

Objekt

Obiekt części definicji środowiska.

Nazwa Typ Opis
path

string

Ścieżka części środowiska.
payload

string

Ładunek części środowiska.
payloadType

PayloadType

Typ ładunku.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa Typ Opis
resourceId

string

Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType

string

Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
moreDetails

ErrorResponseDetails[]

Lista dodatkowych szczegółów błędu.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.
requestId

string

Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.

PayloadType

Wyliczanie

Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.

Wartość Opis
InlineBase64

Śródliniowa baza 64.

UpdateEnvironmentDefinitionRequest

Objekt

Aktualizowanie ładunku żądania definicji publicznej środowiska.

Nazwa Typ Opis
definition

EnvironmentDefinition

Obiekt definicji publicznej środowiska. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat tworzenia definicji publicznej środowiska.