Compartir a través de

Items - Create Environment

  • Referencia
Servicio:
Environment
Versión de la API:
v1

Crea un entorno en el área de trabajo especificada.
Esta API admite operaciones de larga duración (LRO).

Esta API no admite la creación de un entorno con definición.

Permisos

El autor de la llamada debe tener rol de colaborador o superior.

Ámbitos delegados necesarios

Environment.ReadWrite.All o Item.ReadWrite.All

Limitaciones

  • Para crear un entorno, el área de trabajo debe estar en una capacidad de Fabric compatible.

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

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
workspaceId
 path True

string

uuid

Identificador del área de trabajo.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
displayName True

string

Nombre para mostrar del entorno.
description

string

Descripción del entorno. La longitud máxima es de 256 caracteres.

Respuestas

Nombre Tipo Description
201 Created

Environment

Creado correctamente
202 Accepted

Solicitud aceptada, aprovisionamiento del entorno en curso

Encabezados

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Códigos de error comunes:

  • InvalidItemType: el tipo de elemento no es válido

  • ItemDisplayNameAlreadyInUse: ya se usa el nombre para mostrar del elemento

  • CorruptedPayload: la carga proporcionada está dañada.

Ejemplos

Create a environment example

Solicitud de ejemplo

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

{
  "displayName": "Environment_1",
  "description": "An environment description"
}

Respuesta de muestra

status code:
201 
{
  "displayName": "Environment_1",
  "description": "An environment description",
  "type": "Environment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
status code:
202 
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definiciones

Nombre Description
ComponentPublishInfo

Publicar información para cada componente del entorno.
CreateEnvironmentRequest

Cree una carga de solicitud de 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.
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.

CreateEnvironmentRequest

Object

Cree una carga de solicitud de entorno.

Nombre Tipo Description
description

string

Descripción del entorno. La longitud máxima es de 256 caracteres.
displayName

string

Nombre para mostrar del entorno.

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.

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.