Items - Publish Environment (preview)

Serviço:: Environment

Versão da API:: v1

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

Observação

Essa API faz parte de uma versão Beta e é fornecida apenas para fins de avaliação e desenvolvimento. Ele pode mudar com base nos comentários e não é recomendado para uso em produção. Essa API beta será preterida em 1º de março de 2026 e substituída por uma versão estável, disponível aqui. A nova versão apresenta alterações interruptivas e não é compatível com versões anteriores. Ao chamar essa API, os chamadores devem especificar true como o valor do parâmetro beta de consulta (preview o parâmetro de consulta foi substituído por beta. Para compatibilidade com versões anteriores, preview ainda há suporte e se comporta da mesma betaforma que ).

Aviso de substituição

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

O beta parâmetro de consulta atualmente usa truecomo padrão .
Defina o valor do parâmetro de beta consulta para false usar a versão de versão estável dessa API.
A partir de 1º de março de 2026, o valor padrão será alterado para betafalse.

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

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

A resposta segue o padrão LRO (operações de execução prolongada) 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 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}/staging/publish?beta={beta}

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

Respostas

Nome	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 – Operação de publicação de ambiente para < de versão da operação de publicação> com falha devido a um erro: Code = EnvironmentAnotherOngoingPublishProcess.

Nome

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 – Operação de publicação de ambiente para < de versão da operação de publicação> com falha devido a um erro: Code = EnvironmentAnotherOngoingPublishProcess.

Exemplos

Publish environment example

Solicitação de exemplo

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 de exemplo

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

Nome	Description
ComponentPublishInfo	Publicar informações para cada componente no 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.
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.

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.

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 - Publish Environment (preview)

Aviso de substituição

Permissions

Escopos delegados necessários

Identidades com suporte do Microsoft Entra

Interfase

Parâmetros de URI

Respostas

Exemplos

Publish environment example

Solicitação de exemplo

Resposta de exemplo

Definições

ComponentPublishInfo

EnvironmentProperties

EnvironmentPublishState

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

PublishDetails

SparkLibraries

SparkSettings