Compartilhar via

Items - Cancel Publish Environment

Serviço:
Environment
Versão da API:
v1

Disparar um cancelamento de publicação de ambiente.

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/cancelPublish

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.

Respostas

Nome Tipo Description
200 OK

EnvironmentProperties

Solicitação concluída com êxito.
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • InvalidEnvironmentCancel – Falha na operação de cancelamento de ambiente para a versão <GUID do cancelamento de publicação> com falha devido a um erro: Code = EnvironmentUpsupportedStateForCancel.

Exemplos

Publish environment cancellation example

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
200 
{
  "publishDetails": {
    "state": "Cancelled",
    "targetVersion": "d9d95b01-248f-4ef4-bd7e-9d3f1f6447be",
    "startTime": "2024-03-29T14:17:09.0697022Z",
    "endTime": "2024-03-29T14:48:18.0697022Z",
    "componentPublishInfo": {
      "sparkLibraries": {
        "state": "Cancelled"
      },
      "sparkSettings": {
        "state": "Cancelled"
      }
    }
  }
}

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.