Compartir a través de

Items - Cancel Publish Environment

Servicio:
Environment
Versión de la API:
v1

Desencadene una cancelación de publicación del entorno.

Permissions

Permiso de escritura para el elemento de entorno.

Ámbitos delegados necesarios

Item.ReadWrite.All o Environment.ReadWrite.All

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

identidad Support
Usuario Sí
Entidad de servicio e Identidades administradas Sí

Interfaz

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
environmentId
 path True

string (uuid)

Identificador de entorno.
workspaceId
 path True

string (uuid)

El identificador del área de trabajo.

Respuestas

Nombre Tipo Description
200 OK

EnvironmentProperties

Solicitud completada correctamente.
Other Status Codes

ErrorResponse

Códigos de error comunes:

  • InvalidEnvironmentCancel: error en la operación de cancelación del entorno para el GUID de versión < de la cancelación> de publicación con error: Code = EnvironmentUpsupportedStateForCancel.

Ejemplos

Publish environment cancellation example

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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"
      }
    }
  }
}

Definiciones

Nombre Description
ComponentPublishInfo

Publicar información para cada componente del entorno.
EnvironmentProperties

Propiedades del entorno.
EnvironmentPublishState

Estado de publicación. Se pueden agregar tipos de estado adicionales a lo largo del tiempo.
ErrorRelatedResource

Objeto de detalles del recurso relacionado con el error.
ErrorResponse

Respuesta de error.
ErrorResponseDetails

Detalles de la respuesta de error.
PublishDetails

Detalles de la operación de publicación.
SparkLibraries

Bibliotecas de Spark.
SparkSettings

Configuración de Spark.

ComponentPublishInfo

Object

Publicar información para cada componente del entorno.

Nombre Tipo Description
sparkLibraries

SparkLibraries

Las bibliotecas de Spark publican información.
sparkSettings

SparkSettings

Información de publicación de la configuración de Spark.

EnvironmentProperties

Object

Propiedades del entorno.

Nombre Tipo Description
publishDetails

PublishDetails

Detalles de la operación de publicación del entorno.

EnvironmentPublishState

Enumeración

Estado de publicación. Se pueden agregar tipos de estado adicionales a lo largo del tiempo.

Valor Description
Success

La publicación del entorno está en estado correcto.
Cancelled

La publicación del entorno está en estado cancelado.
Failed

La publicación del entorno está en estado de error.
Cancelling

La publicación del entorno está en estado de cancelación.
Running

La publicación del entorno está en estado de ejecución.
Waiting

La publicación del entorno está en estado de espera.

ErrorRelatedResource

Object

Objeto de detalles del recurso relacionado con el error.

Nombre Tipo Description
resourceId

string

Identificador de recurso implicado en el error.
resourceType

string

Tipo del recurso implicado en el error.

ErrorResponse

Object

Respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message

string

Representación legible del error.
moreDetails

ErrorResponseDetails[]

Lista de detalles de error adicionales.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.
requestId

string

Identificador de la solicitud asociada al error.

ErrorResponseDetails

Object

Detalles de la respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message

string

Representación legible del error.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.

PublishDetails

Object

Detalles de la operación de publicación.

Nombre Tipo Description
componentPublishInfo

ComponentPublishInfo

Información de publicación del componente de entorno.
endTime

string (date-time)

Hora de finalización de la operación de publicación en UTC, con el formato AAAA-MM-DDTHH:mm:ss.sssZ.
startTime

string (date-time)

Hora de inicio de la operación de publicación en UTC, con el formato AAAA-MM-DDTHH:mm:ss.sssZ.
state

EnvironmentPublishState

Estado de publicación. Se pueden agregar tipos de estado adicionales a lo largo del tiempo.
targetVersion

string (uuid)

Verion de destino que se va a publicar.

SparkLibraries

Object

Bibliotecas de Spark.

Nombre Tipo Description
state

EnvironmentPublishState

Estado de publicación. Se pueden agregar tipos de estado adicionales a lo largo del tiempo.

SparkSettings

Object

Configuración de Spark.

Nombre Tipo Description
state

EnvironmentPublishState

Estado de publicación. Se pueden agregar tipos de estado adicionales a lo largo del tiempo.