Items - Create Environment

Serviço:: Environment

Versão API:: v1

Cria um ambiente no espaço de trabalho especificado.
Esta API suporta operações de longa duração (LRO).

Permissões

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

Escopos delegados necessários

Environment.ReadWrite.All ou Item.ReadWrite.All

Limitações

Para criar um ambiente, o espaço de trabalho deve estar em uma capacidade de malha suportada.

Identidades suportadas pelo Microsoft Entra

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

Identidade	Suporte
Utilizador	Sim
da entidade de serviço e identidades gerenciadas	Sim

Interfaz

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

Parâmetros URI

Nome	Em	Necessário	Tipo	Descrição
workspaceId	path	True	string (uuid)	O ID do espaço de trabalho.

Órgão do Pedido

Nome	Necessário	Tipo	Descrição
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)	O ID da pasta. Se não especificado ou nulo, o ambiente é criado com o espaço de trabalho como sua pasta.

Respostas

Nome	Tipo	Descrição
201 Created	Environment	Criado com sucesso
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á é usado CorruptedPayload - A carga fornecida está corrompida. WorkspaceItemsLimitExceeded - Limite de itens do espaço de trabalho excedido.

Nome

Tipo

Descrição

201 Created

Environment

Criado com sucesso

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á é usado
CorruptedPayload - A carga fornecida está corrompida.
WorkspaceItemsLimitExceeded - Limite de itens do espaço de trabalho excedido.

Exemplos

Create an environment example

Create an environment with public definition example

Create an environment example

Pedido 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 estado:: 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 estado:: 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

Pedido 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 estado:: 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 estado:: 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	Descrição
ComponentPublishInfo	Publique informações para cada componente no ambiente.
CreateEnvironmentRequest	Crie carga útil de solicitação de ambiente.
Environment	Um item 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 do 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 tag aplicada em um item.
ItemType	O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.
PayloadType	O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.
PublishDetails	Detalhes da operação de publicação.
SparkLibraries	Bibliotecas Spark.
SparkSettings	Configurações de faísca.

ComponentPublishInfo

Objetivo

Publique informações para cada componente no ambiente.

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

CreateEnvironmentRequest

Objetivo

Crie carga útil de solicitação de ambiente.

Nome	Tipo	Descrição
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)	O ID da pasta. Se não especificado ou nulo, o ambiente é criado com o espaço de trabalho como sua pasta.

Environment

Objetivo

Um item Ambiente.

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

EnvironmentDefinition

Objetivo

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	Descrição
format	string	O formato da definição de Ambiente.
parts	EnvironmentDefinitionPart[]	Uma lista de partes de definição.

EnvironmentDefinitionPart

Objetivo

Objeto de parte de definição de ambiente.

Nome	Tipo	Descrição
path	string	O caminho da parte do ambiente.
payload	string	A carga útil da parte do ambiente.
payloadType	PayloadType	O tipo de carga útil.

EnvironmentProperties

Objetivo

Propriedades do ambiente.

Nome	Tipo	Descrição
publishDetails	PublishDetails	Ambiente publicar detalhes da operação.

EnvironmentPublishState

Enumeração

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

Valor	Descrição
Success	A publicação do ambiente está em estado de sucesso.
Cancelled	A publicação do ambiente está em estado cancelado.
Failed	A publicação do ambiente está em estado de falha.
Cancelling	A publicação do ambiente está em 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

Objetivo

O objeto de detalhes do recurso relacionado ao erro.

Nome	Tipo	Descrição
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo de recurso envolvido no erro.

ErrorResponse

Objetivo

A resposta de erro.

Nome	Tipo	Descrição
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

Objetivo

Os detalhes da resposta de erro.

Nome	Tipo	Descrição
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.

ItemTag

Objetivo

Representa uma tag aplicada em um item.

Nome	Tipo	Descrição
displayName	string	O nome da tag.
id	string (uuid)	O ID da tag.

ItemType

Enumeração

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

Valor	Descrição
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 caderno.
SparkJobDefinition	Uma definição de trabalho de faísca.
MLExperiment	Uma experiência de aprendizagem automática.
MLModel	Um modelo de aprendizagem automática.
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	Uma API para o item GraphQL.
MountedDataFactory	Um MountedDataFactory.
SQLDatabase	Um SQLDatabase.
CopyJob	Um trabalho de cópia.
VariableLibrary	Uma VariableLibrary.
Dataflow	Um fluxo de dados.
ApacheAirflowJob	Um ApacheAirflowJob.
WarehouseSnapshot	Um instantâneo do Warehouse.
DigitalTwinBuilder	Um DigitalTwinBuilder.
DigitalTwinBuilderFlow	Um fluxo de construtor de gêmeos digitais.
MirroredAzureDatabricksCatalog	Um catálogo de databricks azure espelhado.
Map	Um mapa.
AnomalyDetector	Um detetor de anomalias.
UserDataFunction	Uma função de dados do usuário.
GraphModel	Um GraphModel.
GraphQuerySet	Um Graph QuerySet.
SnowflakeDatabase	Uma base de dados Snowflake para armazenar tabelas Iceberg criadas a partir da conta Snowflake.
OperationsAgent	Um Agente de Operações.
CosmosDBDatabase	Uma base de dados Cosmos DB.
Ontology	Uma ontologia.
EventSchemaSet	Um EventoSchemaSet.

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	Descrição
InlineBase64	Base em linha 64.

PublishDetails

Objetivo

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

Nome	Tipo	Descrição
componentPublishInfo	ComponentPublishInfo	Componente Ambiente publicar informações.
endTime	string (date-time)	Hora de término da operação de publicação em UTC, usando o formato AAAA-MM-DDTHH:mm:ss.ssssssssZ .
startTime	string (date-time)	Hora de início da operação de publicação em UTC, usando o formato AAAA-MM-DDTHH:mm:ss.ssssssssZ .
state	EnvironmentPublishState	Estado de publicação. Tipos de estado adicionais podem ser adicionados ao longo do tempo.
targetVersion	string (uuid)	Target verion a ser publicado.

SparkLibraries

Objetivo

Bibliotecas Spark.

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

SparkSettings

Objetivo

Configurações de faísca.

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

Partilhar via

Items - Create Environment

Permissões

Escopos delegados necessários

Limitações

Identidades suportadas pelo Microsoft Entra

Interfaz

Parâmetros URI

Órgão do Pedido

Respostas

Exemplos

Create an environment example

Pedido de exemplo

Resposta de exemplo

Create an environment with public definition example

Pedido de exemplo

Resposta de exemplo

Definições

ComponentPublishInfo

CreateEnvironmentRequest

Environment

EnvironmentDefinition

EnvironmentDefinitionPart

EnvironmentProperties

EnvironmentPublishState

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PayloadType

PublishDetails

SparkLibraries

SparkSettings