Compartilhar via

Items - Create Environment

  • Referência
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).

Essa API não dá suporte à criação de um ambiente com definição.

Permissões

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

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

Interface

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

string

A descrição do ambiente. O comprimento máximo é de 256 caracteres.

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

Exemplos

Create a environment example

Solicitação de exemplo

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

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

Informações de publicação 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.
ItemType

O tipo do item. Tipos de item 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
description

string

A descrição do ambiente. O comprimento máximo é de 256 caracteres.
displayName

string

O nome de exibição do ambiente.

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

string

uuid

A ID do item.
properties

EnvironmentPublishInfo

As propriedades do ambiente.
type

ItemType

O tipo de item.
workspaceId

string

uuid

A ID do workspace.

EnvironmentPublishInfo

Objeto

Informações de publicação do 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
Cancelled

A publicação do ambiente está no estado cancelado.
Cancelling

A publicação do ambiente está no estado de cancelamento.
Failed

A publicação do ambiente está em estado de falha.
Running

A publicação do ambiente está em estado de execução.
Success

A publicação do ambiente está em estado de êxito.
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.

ItemType

Enumeração

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

Valor Description
Dashboard

Painel do PowerBI.
DataPipeline

Um pipeline de dados.
Datamart

Datamart do PowerBI.
Environment

Um ambiente.
Eventhouse

Uma casa de eventos.
Eventstream

Um fluxo de eventos.
GraphQLApi

Um item de API para GraphQL.
KQLDashboard

Um painel KQL.
KQLDatabase

Um banco de dados KQL.
KQLQueryset

Um conjunto de consultas KQL.
Lakehouse

Uma casa no lago.
MLExperiment

Um experimento de aprendizado de máquina.
MLModel

Um modelo de machine learning.
MirroredDatabase

Um banco de dados espelhado.
MirroredWarehouse

Um armazém espelhado.
MountedDataFactory

Um MountedDataFactory.
Notebook

Um bloco de anotações.
PaginatedReport

Relatório paginado do PowerBI.
Reflex

Um Reflexo.
Report

Relatório do PowerBI.
SQLDatabase

Um SQLDatabase.
SQLEndpoint

Um ponto de extremidade SQL.
SemanticModel

Modelo semântico do PowerBI.
SparkJobDefinition

Uma definição de trabalho do Spark.
Warehouse

Um armazém.

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

string

date-time

Hora de início da operação de publicação.
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.