Items - Update Environment Definition

Serviço:: Environment

Versão da API:: v1

Substitui a definição para o ambiente especificado.
Esta API suporta operações de longa duração (LRO).

A atualização da definição do ambiente não afeta seu rótulo de sensibilidade.

Permissions

O chamador deve ter permissões de leitura e gravação para o ambiente.

Escopos delegados necessários

Environment.ReadWrite.All ou Item.ReadWrite.All

Identidades suportadas pelo Entra da Microsoft

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade	Support
User	Yes
Entidade de serviço e identidades geridas	Yes

Interfaz

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
environmentId	path	True	string (uuid)	O ID do ambiente.
workspaceId	path	True	string (uuid)	O ID do espaço de trabalho.
updateMetadata	query		boolean	Quando definido como true e o arquivo .platform é fornecido como parte da definição, os metadados do item são atualizados usando os metadados no arquivo .platform

Corpo do Pedido

Name	Necessário	Tipo	Description
definition	True	EnvironmentDefinition	Objeto de definição pública de ambiente. Consulte este artigo para obter mais detalhes sobre como criar uma definição pública de ambiente.

Respostas

Name	Tipo	Description
200 OK		Pedido concluído com sucesso.
202 Accepted		Pedido aceite. A definição de atualização está em andamento. Cabeçalhos Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: OperationNotSupportedForItem - Operação não suportada para o item solicitado. CorruptedPayload - A carga fornecida está corrompida.

Name

Tipo

Description

200 OK

Pedido concluído com sucesso.

202 Accepted

Pedido aceite. A definição de atualização está em andamento.

Cabeçalhos

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

Other Status Codes

ErrorResponse

Códigos de erro comuns:

OperationNotSupportedForItem - Operação não suportada para o item solicitado.
CorruptedPayload - A carga fornecida está corrompida.

Exemplos

Update a environment definition example

Pedido de amostra

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

Resposta da amostra

Código de estado:: 200

Código de estado:: 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

Definições

Name	Description
EnvironmentDefinition	Objeto de definição pública de ambiente. Consulte este artigo para obter mais detalhes sobre como criar uma definição pública de ambiente.
EnvironmentDefinitionPart	Objeto de parte de definição de ambiente.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
PayloadType	O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.
UpdateEnvironmentDefinitionRequest	Atualizar a carga útil de solicitação de definição pública do ambiente.

EnvironmentDefinition

Object

Objeto de definição pública de ambiente. Consulte este artigo para obter mais detalhes sobre como criar uma definição pública de ambiente.

Name	Tipo	Description
format	string	O formato da definição de Ambiente.
parts	EnvironmentDefinitionPart[]	Uma lista de partes de definição.

EnvironmentDefinitionPart

Object

Objeto de parte de definição de ambiente.

Name	Tipo	Description
path	string	O caminho da parte do ambiente.
payload	string	A carga útil da parte do ambiente.
payloadType	PayloadType	O tipo de carga útil.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível por humanos do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados ao erro.
requestId	string	ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível por humanos do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados ao erro.

PayloadType

Enumeração

O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.

Valor	Description
InlineBase64	Base em linha 64.

UpdateEnvironmentDefinitionRequest

Object

Atualizar a carga útil de solicitação de definição pública do ambiente.

Name	Tipo	Description
definition	EnvironmentDefinition	Objeto de definição pública de ambiente. Consulte este artigo para obter mais detalhes sobre como criar uma definição pública de ambiente.

Partilhar via

Items - Update Environment Definition

Permissions

Escopos delegados necessários

Identidades suportadas pelo Entra da Microsoft

Interfaz

Parâmetros do URI

Corpo do Pedido

Respostas

Exemplos

Update a environment definition example

Pedido de amostra

Resposta da amostra

Definições

EnvironmentDefinition

EnvironmentDefinitionPart

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

PayloadType

UpdateEnvironmentDefinitionRequest