Items - List Environments

Referencia

Servicio:: Environment

Versión de la API:: v1

Devuelve una lista de entornos del área de trabajo especificada.
Esta API admite paginación.

Permisos

El autor de la llamada debe tener rol de área de trabajo o superior del visor.

Ámbitos delegados necesarios

Workspace.Read.All o Workspace.ReadWrite.All

Identidades admitidas de Microsoft Entra

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

Identidad	Apoyo
Usuario	Sí
de entidad de servicio y identidades administradas	Sí

Interfaz

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments

Con parámetros opcionales:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments?continuationToken={continuationToken}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
workspaceId	path	True	string uuid	Identificador del área de trabajo.
continuationToken	query		string	Token para recuperar la siguiente página de resultados.

Respuestas

Nombre	Tipo	Description
200 OK	Environments	Solicitud completada correctamente.
Other Status Codes	ErrorResponse	Códigos de error comunes: InvalidItemType: tipo de elemento no válido

Nombre

Tipo

Description

200 OK

Environments

Solicitud completada correctamente.

Other Status Codes

ErrorResponse

Códigos de error comunes:

InvalidItemType: tipo de elemento no válido

Ejemplos

List environments in workspace example

Solicitud de ejemplo

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Environment_1",
      "description": "A environment description.",
      "type": "Environment",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "publishDetails": {
          "state": "Failed",
          "targetVersion": "14ece8b5-68a1-4130-a9e7-074c04537588",
          "startTime": "2024-03-30T14:17:09.0697022Z",
          "endTime": "2024-03-30T14:48:09.0697022Z",
          "componentPublishInfo": {
            "sparkLibraries": {
              "state": "Failed"
            },
            "sparkSettings": {
              "state": "Success"
            }
          }
        }
      }
    },
    {
      "id": "a8a1bffa-7eea-49dc-a1d2-6281c1d031f1",
      "displayName": "Environment_2",
      "description": "A environment description.",
      "type": "Environment",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "publishDetails": {
          "state": "Success",
          "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
          "startTime": "2024-03-29T14:17:09.0697022Z",
          "endTime": "2024-03-29T14:48:09.0697022Z",
          "componentPublishInfo": {
            "sparkLibraries": {
              "state": "Success"
            },
            "sparkSettings": {
              "state": "Success"
            }
          }
        }
      }
    }
  ]
}

Definiciones

Nombre	Description
ComponentPublishInfo	Publicar información para cada componente del entorno.
Environment	Un elemento Entorno.
EnvironmentPublishInfo	Información de publicación del entorno.
EnvironmentPublishState	Estado de publicación. Se pueden agregar tipos de estado adicionales a lo largo del tiempo.
Environments	Lista de entornos.
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
ItemType	Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.
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.

Environment

Object

Un elemento Entorno.

Nombre	Tipo	Description
description	string	Descripción del elemento.
displayName	string	Nombre para mostrar del elemento.
id	string uuid	Identificador del elemento.
properties	EnvironmentPublishInfo	Propiedades del entorno.
type	ItemType	Tipo de elemento.
workspaceId	string uuid	Identificador del área de trabajo.

EnvironmentPublishInfo

Object

Información de publicación 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
Cancelled	La publicación del entorno está en estado cancelado.
Cancelling	La publicación del entorno está en estado de cancelación.
Failed	La publicación del entorno está en estado de error.
Running	La publicación del entorno está en estado de ejecución.
Success	La publicación del entorno está en estado correcto.
Waiting	La publicación del entorno está en estado de espera.

Environments

Object

Lista de entornos.

Nombre	Tipo	Description
continuationToken	string	Token del siguiente lote del conjunto de resultados. Si no hay más registros, se quita de la respuesta.
continuationUri	string	Identificador URI del siguiente lote del conjunto de resultados. Si no hay más registros, se quita de la respuesta.
value	Environment[]	Lista de entornos.

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.

ItemType

Enumeración

Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.

Valor	Description
Dashboard	Panel de PowerBI.
DataPipeline	Una canalización de datos.
Datamart	Datamart de PowerBI.
Environment	Un entorno.
Eventhouse	Un centro de eventos.
Eventstream	Una secuencia de eventos.
GraphQLApi	Una API para el elemento GraphQL.
KQLDashboard	Un panel de KQL.
KQLDatabase	Una base de datos KQL.
KQLQueryset	Un conjunto de consultas KQL.
Lakehouse	Una casa de lago.
MLExperiment	Un experimento de aprendizaje automático.
MLModel	Un modelo de aprendizaje automático.
MirroredDatabase	Una base de datos reflejada.
MirroredWarehouse	Un almacén reflejado.
MountedDataFactory	A MountedDataFactory.
Notebook	Un cuaderno.
PaginatedReport	Informe paginado de PowerBI.
Reflex	Un reflejo.
Report	Informe de PowerBI.
SQLDatabase	A SQLDatabase.
SQLEndpoint	Un punto de conexión de SQL.
SemanticModel	Modelo semántico de PowerBI.
SparkJobDefinition	Una definición de trabajo de Spark.
Warehouse	Un almacén.

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.
startTime	string date-time	Hora de inicio de la operación de publicación.
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.

Compartir a través de

Items - List Environments

Permisos

Ámbitos delegados necesarios

Identidades admitidas de Microsoft Entra

Interfaz

Parámetros de identificador URI

Respuestas

Ejemplos

List environments in workspace example

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ComponentPublishInfo

Environment

EnvironmentPublishInfo

EnvironmentPublishState

Environments

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

PublishDetails

SparkLibraries

SparkSettings

Recursos adicionales