Items - Publish Environment (preview)

Serviço:: Environment

Versão da API:: v1

Acione uma operação de publicação de ambiente.

Observação

Esta API faz parte de uma versão Beta e é fornecida apenas para fins de avaliação e desenvolvimento. Ele pode mudar com base no feedback e não é recomendado para uso em produção. Esta API beta será descontinuada a 1 de março de 2026 e substituída por uma versão estável, disponível aqui. A nova versão introduz alterações significativas e não é compatível com versões anteriores. Ao chamar esta API, os chamadores devem especificar true como valor para o parâmetro beta de consulta (preview o parâmetro de consulta foi substituído por beta. Para compatibilidade retroativa, preview continua a ser suportado e comporta-se da mesma forma que beta).

Aviso de descontinuação

Um novo parâmetro beta de consulta foi introduzido para facilitar essa transição:

Atualmente, o betatrueparâmetro de consulta assume como padrão .
Defina o valor do parâmetro query beta para false usar a versão estável desta API.
A partir de 1º de março de 2026, o valor padrão para beta será alterado para false.

É recomendável migrar sua integração para usar a versão Release o mais rápido possível, especificando false para o beta parâmetro query (o valor padrão para o beta parâmetro query será definido como false na data de descontinuação da API).

As seguintes alterações incompatíveis foram introduzidas na versão de lançamento:

A resposta está seguindo o padrão de operações de longa duração (LRO) e o código de resposta HTTP 202 pode ser retornado.

Permissions

Permissão de gravação para o item de ambiente.

Escopos delegados necessários

Item.ReadWrite.All ou Environment.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}/staging/publish?beta={beta}

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.
beta	query	True	boolean	Este parâmetro especifica qual versão da API deve ser usada. Defina para `true` usar a versão beta descrita nesta página, ou para `false` usar a versão de Lançamento detalhada aqui. A partir de 1º de março de 2026, o valor padrão para `beta` será alterado para `false`.

Respostas

Name	Tipo	Description
200 OK	EnvironmentProperties	A solicitação de operação de publicação foi enviada com êxito.
Other Status Codes	ErrorResponse	Códigos de erro comuns: InvalidEnvironmentPublish - A operação de publicação do ambiente para o < da versão da operação> de publicação com falha falhou devido a um erro: Code = EnvironmentAnotherOngoingPublishProcess.

Name

Tipo

Description

200 OK

EnvironmentProperties

A solicitação de operação de publicação foi enviada com êxito.

Other Status Codes

ErrorResponse

Códigos de erro comuns:

InvalidEnvironmentPublish - A operação de publicação do ambiente para o < da versão da operação> de publicação com falha falhou devido a um erro: Code = EnvironmentAnotherOngoingPublishProcess.

Exemplos

Publish environment example

Pedido de amostra

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/staging/publish?beta=True

Resposta da amostra

Código de estado:: 200

{
  "publishDetails": {
    "state": "Running",
    "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
    "startTime": "2024-03-29T14:17:09.0697022Z",
    "componentPublishInfo": {
      "sparkLibraries": {
        "state": "Running"
      },
      "sparkSettings": {
        "state": "Running"
      }
    }
  }
}

Definições

Name	Description
ComponentPublishInfo	Publique informações para cada componente no 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.
PublishDetails	Detalhes da operação de publicação.
SparkLibraries	Bibliotecas Spark.
SparkSettings	Configurações de faísca.

ComponentPublishInfo

Object

Publique informações para cada componente no ambiente.

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

EnvironmentProperties

Object

Propriedades do ambiente.

Name	Tipo	Description
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	Description
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

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.

PublishDetails

Object

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

Name	Tipo	Description
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

Object

Bibliotecas Spark.

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

SparkSettings

Object

Configurações de faísca.

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

Partilhar via

Items - Publish Environment (preview)

Aviso de descontinuação

Permissions

Escopos delegados necessários

Identidades suportadas pelo Entra da Microsoft

Interfaz

Parâmetros do URI

Respostas

Exemplos

Publish environment example

Pedido de amostra

Resposta da amostra

Definições

ComponentPublishInfo

EnvironmentProperties

EnvironmentPublishState

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

PublishDetails

SparkLibraries

SparkSettings