Compartilhar via

Items - Get Environment Definition

Serviço:
Environment
Versão da API:
v1

Retorna a definição pública de ambiente especificada.
Essa API dá suporte a LRO (operações de execução longa).

Quando você obtém a definição pública de um ambiente, o rótulo de confidencialidade não faz parte da definição.

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

Limitações

Essa API é bloqueada para um ambiente com um rótulo de confidencialidade criptografado.

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade Support
Utilizador Yes
Entidade de serviço e identidades gerenciadas Yes

Interfase

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
environmentId
 path True

string (uuid)

A ID do ambiente.
workspaceId
 path True

string (uuid)

O identificador do espaço de trabalho.
format
 query

string

O formato da definição pública do ambiente.

Respostas

Nome Tipo Description
200 OK

EnvironmentDefinitionResponse

Solicitação concluída com êxito.
202 Accepted

Solicitação aceita. A recuperação da definiçã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 sem suporte para o item solicitado.

Exemplos

Get a environment definition example

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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"
      }
    ]
  }
}
Código de status:
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

Definições

Nome 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.
EnvironmentDefinitionResponse

Resposta de definição pública do 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 da carga da parte de definição. Tipos de conteúdo adicionais podem ser adicionados ao longo do tempo.

EnvironmentDefinition

Objeto

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.

Nome Tipo Description
format

string

O formato da definição de Ambiente.
parts

EnvironmentDefinitionPart[]

Uma lista de partes de definição.

EnvironmentDefinitionPart

Objeto

Objeto de parte de definição de ambiente.

Nome Tipo Description
path

string

O caminho da parte do ambiente.
payload

string

O conteúdo da parte do ambiente.
payloadType

PayloadType

O tipo de conteúdo.

EnvironmentDefinitionResponse

Objeto

Resposta de definição pública do ambiente.

Nome 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.

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível humana do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível humana do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.

PayloadType

Enumeração

O tipo da carga da parte de definição. Tipos de conteúdo adicionais podem ser adicionados ao longo do tempo.

Valor Description
InlineBase64

Base 64 embutida.