Items - Create Environment

Serviço:: Environment

Versão da API:: v1

Cria um ambiente no workspace especificado.
Essa API dá suporte a LRO (operações de execução longa).

Permissões

O chamador deve ter uma função de workspace de colaborador .

Escopos delegados necessários

Environment.ReadWrite.All ou Item.ReadWrite.All

Limitações

Para criar um ambiente, o workspace deve estar em uma capacidade do Fabric com suporte.

Identidades com suporte do Microsoft Entra

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

Identidade	Apoio
Utilizador	Sim
entidade de serviço e identidades gerenciadas	Sim

Interfase

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
workspaceId	path	True	string (uuid)	A ID do workspace.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
displayName	True	string	O nome de exibição do ambiente.
definition		EnvironmentDefinition	A definição pública do ambiente.
description		string	A descrição do ambiente. O comprimento máximo é de 256 caracteres.
folderId		string (uuid)	A ID da pasta. Se não for especificado ou nulo, o ambiente será criado com o workspace como sua pasta.

Respostas

Nome	Tipo	Description
201 Created	Environment	Criado com êxito
202 Accepted		Solicitação aceita, provisionamento de ambiente em andamento Cabeçalhos Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: InvalidItemType – O tipo de item é inválido ItemDisplayNameAlreadyInUse – O nome de exibição do item já está sendo usado CorruptedPayload – O conteúdo fornecido está corrompido. WorkspaceItemsLimitExceeded - Limite de itens do workspace excedido.

Nome

Tipo

Description

201 Created

Environment

Criado com êxito

202 Accepted

Solicitação aceita, provisionamento de ambiente em andamento

Cabeçalhos

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

Other Status Codes

ErrorResponse

Códigos de erro comuns:

InvalidItemType – O tipo de item é inválido
ItemDisplayNameAlreadyInUse – O nome de exibição do item já está sendo usado
CorruptedPayload – O conteúdo fornecido está corrompido.
WorkspaceItemsLimitExceeded - Limite de itens do workspace excedido.

Exemplos

Create an environment example

Create an environment with public definition example

Create an environment example

Solicitação de exemplo

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments

{
  "displayName": "Environment_1",
  "description": "An environment description."
}

Resposta de exemplo

Código de status:: 201

{
  "displayName": "Environment_1",
  "description": "An environment description.",
  "type": "Environment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Código de status:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create an environment with public definition example

Solicitação de exemplo

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments

{
  "displayName": "Environment_1",
  "description": "An environment description.",
  "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 de exemplo

Código de status:: 201

{
  "displayName": "Environment_1",
  "description": "An environment description.",
  "type": "Environment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Código de status:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definições

Nome	Description
ComponentPublishInfo	Publicar informações para cada componente no ambiente.
CreateEnvironmentRequest	Criar conteúdo de solicitação de ambiente.
Environment	Um item de Ambiente.
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.
EnvironmentProperties	Propriedades de ambiente.
EnvironmentPublishState	Estado de publicação. Tipos de estado adicionais podem ser adicionados ao longo do tempo.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
ItemTag	Representa uma marca aplicada em um item.
ItemType	O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.
PayloadType	O tipo da carga da parte de definição. Tipos de conteúdo adicionais podem ser adicionados ao longo do tempo.
PublishDetails	Detalhes da operação de publicação.
SparkLibraries	Bibliotecas do Spark.
SparkSettings	Configurações do Spark.

ComponentPublishInfo

Objeto

Publicar informações para cada componente no ambiente.

Nome	Tipo	Description
sparkLibraries	SparkLibraries	As bibliotecas do Spark publicam informações.
sparkSettings	SparkSettings	As configurações do Spark publicam informações.

CreateEnvironmentRequest

Objeto

Criar conteúdo de solicitação de ambiente.

Nome	Tipo	Description
definition	EnvironmentDefinition	A definição pública do ambiente.
description	string	A descrição do ambiente. O comprimento máximo é de 256 caracteres.
displayName	string	O nome de exibição do ambiente.
folderId	string (uuid)	A ID da pasta. Se não for especificado ou nulo, o ambiente será criado com o workspace como sua pasta.

Environment

Objeto

Um item de Ambiente.

Nome	Tipo	Description
description	string	A descrição do item.
displayName	string	O nome de exibição do item.
folderId	string (uuid)	A ID da pasta.
id	string (uuid)	A ID do item.
properties	EnvironmentProperties	As propriedades do ambiente.
tags	ItemTag[]	Lista de marcas aplicadas.
type	ItemType	O tipo de item.
workspaceId	string (uuid)	A ID do workspace.

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.

EnvironmentProperties

Objeto

Propriedades de ambiente.

Nome	Tipo	Description
publishDetails	PublishDetails	Detalhes da operação de publicação do ambiente.

EnvironmentPublishState

Enumeração

Estado de publicação. Tipos de estado adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Success	A publicação do ambiente está em estado de êxito.
Cancelled	A publicação do ambiente está no estado cancelado.
Failed	A publicação do ambiente está em estado de falha.
Cancelling	A publicação do ambiente está no estado de cancelamento.
Running	A publicação do ambiente está em estado de execução.
Waiting	A publicação do ambiente está em estado de espera.

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.

ItemTag

Objeto

Representa uma marca aplicada em um item.

Nome	Tipo	Description
displayName	string	O nome da marca.
id	string (uuid)	A ID da marca.

ItemType

Enumeração

O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Dashboard	Painel do PowerBI.
Report	Relatório do PowerBI.
SemanticModel	Modelo semântico do PowerBI.
PaginatedReport	Relatório paginado do PowerBI.
Datamart	Datamart do PowerBI.
Lakehouse	Uma casa no lago.
Eventhouse	Uma casa de eventos.
Environment	Um ambiente.
KQLDatabase	Um banco de dados KQL.
KQLQueryset	Um conjunto de consultas KQL.
KQLDashboard	Um painel KQL.
DataPipeline	Um pipeline de dados.
Notebook	Um bloco de anotações.
SparkJobDefinition	Uma definição de trabalho do Spark.
MLExperiment	Um experimento de aprendizado de máquina.
MLModel	Um modelo de machine learning.
Warehouse	Um armazém.
Eventstream	Um fluxo de eventos.
SQLEndpoint	Um ponto de extremidade SQL.
MirroredWarehouse	Um armazém espelhado.
MirroredDatabase	Um banco de dados espelhado.
Reflex	Um Reflexo.
GraphQLApi	Um item de API para GraphQL.
MountedDataFactory	Um MountedDataFactory.
SQLDatabase	Um SQLDatabase.
CopyJob	Um trabalho de cópia.
VariableLibrary	Um VariableLibrary.
Dataflow	Um fluxo de dados.
ApacheAirflowJob	Um ApacheAirflowJob.
WarehouseSnapshot	Um instantâneo do Warehouse.
DigitalTwinBuilder	Um DigitalTwinBuilder.
DigitalTwinBuilderFlow	Um fluxo do Construtor de Gêmeos Digitais.
MirroredAzureDatabricksCatalog	Um catálogo espelhado do Azure Databricks.
Map	Um mapa.
AnomalyDetector	Um Detector de Anomalias.
UserDataFunction	Uma função de dados do usuário.
GraphModel	Um GraphModel.
GraphQuerySet	Um Graph QuerySet.
SnowflakeDatabase	Um Banco de Dados Snowflake para armazenar tabelas iceberg criadas a partir da conta snowflake.
OperationsAgent	Um OperationsAgent.
CosmosDBDatabase	Um banco de dados do Cosmos DB.
Ontology	Uma ontologia.
EventSchemaSet	Um EventSchemaSet.

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.

PublishDetails

Objeto

Detalhes da operação de publicação.

Nome	Tipo	Description
componentPublishInfo	ComponentPublishInfo	Informações de publicação do componente de ambiente.
endTime	string (date-time)	Hora de término da operação de publicação em UTC, usando o formato YYYY-MM-DDTHH:mm:sss.ssssssZ.
startTime	string (date-time)	Hora de início da operação de publicação em UTC, usando o formato YYYY-MM-DDTHH:mm:sss.ssssZ.
state	EnvironmentPublishState	Estado de publicação. Tipos de estado adicionais podem ser adicionados ao longo do tempo.
targetVersion	string (uuid)	Vértices de destino a serem publicados.

SparkLibraries

Objeto

Bibliotecas do Spark.

Nome	Tipo	Description
state	EnvironmentPublishState	Estado de publicação. Tipos de estado adicionais podem ser adicionados ao longo do tempo.

SparkSettings

Objeto

Configurações do Spark.

Nome	Tipo	Description
state	EnvironmentPublishState	Estado de publicação. Tipos de estado adicionais podem ser adicionados ao longo do tempo.

Compartilhar via

Items - Create Environment

Permissões

Escopos delegados necessários

Limitações

Identidades com suporte do Microsoft Entra

Interfase

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

Create an environment example

Solicitação de exemplo

Resposta de exemplo

Create an environment with public definition example

Solicitação de exemplo

Resposta de exemplo

Definições

ComponentPublishInfo

CreateEnvironmentRequest

Environment

EnvironmentDefinition

EnvironmentDefinitionPart

EnvironmentProperties

EnvironmentPublishState

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PayloadType

PublishDetails

SparkLibraries

SparkSettings