Items - Publish Environment (preview)

Servicio:: Environment

Versión de la API:: v1

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

Nota:

Esta API forma parte de una versión beta y solo se proporciona con fines de evaluación y desarrollo. Puede cambiar en función de los comentarios y no se recomienda para su uso en producción. Esta API beta quedará en desuso el 1 de marzo de 2026 y se reemplazará por una versión estable, disponible aquí. La nueva versión presenta cambios importantes y no es compatible con versiones anteriores. Al llamar a esta API, los autores de llamadas deben especificar true como el valor del parámetro beta de consulta (preview el parámetro de consulta se ha reemplazado por beta. Para la compatibilidad con versiones anteriores, preview todavía se admite y se comporta igual que beta).

Aviso de desuso

Se ha introducido un nuevo parámetro beta de consulta para facilitar esta transición:

El beta parámetro de consulta actualmente tiene truecomo valor predeterminado .
Establezca el valor del beta parámetro de consulta en false para usar la versión estable de la versión de esta API.
A partir del 1 de marzo de 2026, el valor predeterminado de beta cambiará a false.

Se recomienda migrar la integración para usar la versión de versión lo antes posible especificando false para el beta parámetro de consulta (el valor predeterminado del beta parámetro de consulta se establecerá false en en la fecha de desuso de la API).

Los siguientes cambios incompatibles se introdujeron en la versión de lanzamiento:

La respuesta sigue el patrón de operaciones de larga duración (LRO) y se puede devolver el código de respuesta HTTP 202.

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/publish?beta={beta}

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.
beta	query	True	boolean	Este parámetro especifica la versión de la API que se va a usar. `true` Establézcalo en para usar la versión beta descrita en esta página o para `false` usar la versión de versión detallada aquí. A partir del 1 de marzo de 2026, el valor predeterminado de `beta` cambiará a `false`.

Respuestas

Nombre	Tipo	Description
200 OK	EnvironmentProperties	La solicitud de operación de publicación se ha enviado correctamente.
Other Status Codes	ErrorResponse	Códigos de error comunes: InvalidEnvironmentPublish: error en la operación de publicación del entorno para el < de versión de la operación> de publicación con error: Code = EnvironmentAnotherOngoingPublishProcess.

Nombre

Tipo

Description

200 OK

EnvironmentProperties

La solicitud de operación de publicación se ha enviado correctamente.

Other Status Codes

ErrorResponse

Códigos de error comunes:

InvalidEnvironmentPublish: error en la operación de publicación del entorno para el < de versión de la operación> de publicación con error: Code = EnvironmentAnotherOngoingPublishProcess.

Ejemplos

Publish environment example

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

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

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

Objeto

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

Objeto

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

Objeto

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

Objeto

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

Objeto

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

Objeto

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

Objeto

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

Objeto

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.

Compartir a través de

Items - Publish Environment (preview)

Aviso de desuso

Permissions

Ámbitos delegados necesarios

Identidades admitidas de Microsoft Entra

Interfaz

Parámetros de identificador URI

Respuestas

Ejemplos

Publish environment example

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ComponentPublishInfo

EnvironmentProperties

EnvironmentPublishState

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

PublishDetails

SparkLibraries

SparkSettings