Items - Update Environment Definition

Service:

Environment

API-versie:

v1

Hiermee wordt de definitie voor de opgegeven omgeving overschreven.
Deze API ondersteunt langlopende bewerkingen (LRO).

Het bijwerken van de definitie van de omgeving heeft geen invloed op het vertrouwelijkheidslabel.

Permissions

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

Vereiste gedelegeerde bereiken

Environment.ReadWrite.All of Item.ReadWrite.All

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}/updateDefinition

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
environmentId	path	True	string (uuid)	De omgevings-id.
workspaceId	path	True	string (uuid)	De werkruimte-ID.
updateMetadata	query		boolean	Als deze is ingesteld op true en het .platform-bestand wordt opgegeven als onderdeel van de definitie, worden de metagegevens van het item bijgewerkt met behulp van de metagegevens in het PLATFORM-bestand

Aanvraagbody

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

Antwoorden

Name	Type	Description
200 OK		De aanvraag is voltooid.
202 Accepted		Aanvraag geaccepteerd. De definitie van de update 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. CorruptedPayload: de opgegeven nettolading is beschadigd.

Voorbeelden

Update a environment definition example

Voorbeeldaanvraag

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

Voorbeeldrespons

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

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.
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.
UpdateEnvironmentDefinitionRequest	Werk de nettolading van aanvragen voor openbare definities van de omgeving bij.

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.

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.

UpdateEnvironmentDefinitionRequest

Object

Werk de nettolading van aanvragen voor openbare definities van de omgeving bij.

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.