Items - Create Environment

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).

Permisos

El autor de la llamada debe tener un rol de área de trabajo colaborador .

Ámbitos delegados necesarios

Environment.ReadWrite.All o Item.ReadWrite.All

Limitaciones

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

Microsoft Entra identidades admitidas

Esta API admite los Microsoft identities enumerados en esta sección.

Identidad	Apoyo
Usuario	Sí
Entidad de servicio e 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.
definition		EnvironmentDefinition	Definición pública del entorno.
description		string	Descripción del entorno. La longitud máxima es de 256 caracteres.
folderId		string (uuid)	Identificador de carpeta. Si no se especifica o null, el entorno se crea con el área de trabajo como carpeta.
sensitivityLabelSettings		SensitivityLabelSettings	Configuración de la etiqueta de confidencialidad para el entorno.

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
429 Too Many Requests	ErrorResponse	Se superó el límite de frecuencia de servicio. El servidor devuelve un `Retry-After` encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales. Encabezados 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. WorkspaceItemsLimitExceeded: se superó el límite de elementos del área de trabajo.

Ejemplos

Create an environment example

Create an environment with public definition example

Create an environment example

Solicitud de ejemplo

HTTP

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",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

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

Create an environment with public definition example

Solicitud de ejemplo

HTTP

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

{
  "displayName": "Environment_1",
  "description": "An environment description.",
  "definition": {
    "parts": [
      {
        "path": "Libraries/CustomLibraries/samplelibrary.jar",
        "payload": "eyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/samplepython.py",
        "payload": "FyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/samplewheel-0.18.0-py2.py3-none-any.whl",
        "payload": "LyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/sampleR.tar.gz",
        "payload": "ZyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/PublicLibraries/environment.yml",
        "payload": "IyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Setting/Sparkcompute.yml",
        "payload": "GyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

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",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

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.
EntireTenantPrincipal	Representa una entidad de seguridad de inquilino
Environment	Un elemento Entorno.
EnvironmentDefinition	Objeto de definición pública del entorno. Consulte este artículo para obtener más información sobre la estructura de la definición del entorno.
EnvironmentDefinitionPart	Objeto de parte de definición de 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.
GroupDetails	Detalles específicos del grupo. Aplicable cuando el tipo de entidad de seguridad es `Group`.
GroupPrincipal	Representa un grupo de seguridad.
GroupType	Tipo del grupo. Se pueden agregar tipos de grupo adicionales a lo largo del tiempo.
ItemTag	Representa una etiqueta aplicada en un elemento.
ItemType	Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.
PayloadType	Tipo de la carga de la parte de definición. Se pueden agregar tipos de carga adicionales a lo largo del tiempo.
PrincipalType	Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.
PublishDetails	Detalles de la operación de publicación.
SensitivityLabel	Representa una etiqueta de confidencialidad aplicada a un elemento.
SensitivityLabelApplyStrategy	Estrategia para aplicar la etiqueta de confidencialidad. El valor predeterminado es ApplyOrFail. Se pueden agregar tipos adicionales a lo largo del tiempo.
SensitivityLabelSettings	Configuración de la etiqueta de confidencialidad.
ServicePrincipalDetails	Detalles específicos de la entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es `ServicePrincipal`.
ServicePrincipalPrincipal	Representa una entidad de servicio de Microsoft Entra.
ServicePrincipalProfileDetails	Detalles del perfil de entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Representa un perfil de entidad de servicio.
SparkLibraries	Bibliotecas de Spark.
SparkSettings	Configuración de Spark.
UserDetails	Detalles específicos de la entidad de seguridad de usuario. Aplicable cuando el tipo de entidad de seguridad es `User`.
UserPrincipal	Representa una entidad de seguridad de usuario Microsoft Entra.

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.

CreateEnvironmentRequest

Objeto

Cree una carga de solicitud de entorno.

Nombre	Tipo	Description
definition	EnvironmentDefinition	Definición pública del entorno.
description	string	Descripción del entorno. La longitud máxima es de 256 caracteres.
displayName	string	Nombre para mostrar del entorno.
folderId	string (uuid)	Identificador de carpeta. Si no se especifica o null, el entorno se crea con el área de trabajo como carpeta.
sensitivityLabelSettings	SensitivityLabelSettings	Configuración de la etiqueta de confidencialidad para el entorno.

EntireTenantPrincipal

Objeto

Representa una entidad de seguridad de inquilino

Nombre	Tipo	Description
displayName	string	Nombre para mostrar de la entidad de seguridad.
id	string (uuid)	Identificador de la entidad de seguridad.
type	string: EntireTenant	Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.

Environment

Objeto

Un elemento Entorno.

Nombre	Tipo	Description
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Identidad predeterminada del elemento.
description	string	Descripción del elemento.
displayName	string	Nombre para mostrar del elemento.
folderId	string (uuid)	Identificador de carpeta.
id	string (uuid)	Identificador del elemento.
properties	EnvironmentProperties	Propiedades del entorno.
sensitivityLabel	SensitivityLabel	Etiqueta de confidencialidad del elemento.
tags	ItemTag[]	Lista de etiquetas aplicadas.
type	ItemType	Tipo de elemento.
workspaceId	string (uuid)	Identificador del área de trabajo.

EnvironmentDefinition

Objeto

Objeto de definición pública del entorno. Consulte este artículo para obtener más información sobre la estructura de la definición del entorno.

Nombre	Tipo	Description
format	string	Formato de la definición del entorno.
parts	EnvironmentDefinitionPart[]	Lista de elementos de definición.

EnvironmentDefinitionPart

Objeto

Objeto de parte de definición de entorno.

Nombre	Tipo	Description
path	string	Ruta de acceso del elemento de entorno.
payload	string	Carga útil del elemento de entorno.
payloadType	PayloadType	Tipo de carga.

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 (uuid)	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.

GroupDetails

Objeto

Detalles específicos del grupo. Aplicable cuando el tipo de entidad de seguridad es Group.

Nombre	Tipo	Description
groupType	GroupType	Tipo del grupo. Se pueden agregar tipos de grupo adicionales a lo largo del tiempo.

GroupPrincipal

Objeto

Representa un grupo de seguridad.

Nombre	Tipo	Description
displayName	string	Nombre para mostrar de la entidad de seguridad.
groupDetails	GroupDetails	Detalles específicos del grupo. Aplicable cuando el tipo de entidad de seguridad es `Group`.
id	string (uuid)	Identificador de la entidad de seguridad.
type	string: Group	Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.

GroupType

Enumeración

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

Valor	Description
Unknown	El tipo de grupo principal es desconocido.
SecurityGroup	La entidad de seguridad es un grupo de seguridad.
DistributionList	La entidad de seguridad es una lista de distribución.

ItemTag

Objeto

Representa una etiqueta aplicada en un elemento.

Nombre	Tipo	Description
displayName	string	Nombre de la etiqueta.
id	string (uuid)	Identificador de etiqueta.

ItemType

Enumeración

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

Valor	Description
Dashboard	Panel de PowerBI.
Report	Informe de PowerBI.
SemanticModel	Modelo semántico de PowerBI.
PaginatedReport	Informe paginado de PowerBI.
Datamart	Datamart de PowerBI.
Lakehouse	Una casa de lago.
Eventhouse	Un centro de eventos.
Environment	Un entorno.
KQLDatabase	Una base de datos KQL.
KQLQueryset	Un conjunto de consultas KQL.
KQLDashboard	Un panel de KQL.
DataPipeline	Una canalización de datos.
Notebook	Un cuaderno.
SparkJobDefinition	Una definición de trabajo de Spark.
MLExperiment	Un experimento de aprendizaje automático.
MLModel	Un modelo de aprendizaje automático.
Warehouse	Un almacén.
Eventstream	Una secuencia de eventos.
SQLEndpoint	Un punto de conexión de SQL.
MirroredWarehouse	Un almacén reflejado.
MirroredDatabase	Una base de datos reflejada.
Reflex	Un reflejo.
GraphQLApi	Una API para el elemento GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Un trabajo de copia.
VariableLibrary	A VariableLibrary.
Dataflow	Flujo de datos.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Una instantánea de almacenamiento.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Un flujo de Digital Twin Builder.
MirroredAzureDatabricksCatalog	Un catálogo de Azure Databricks reflejado.
Map	Un mapa.
AnomalyDetector	An Anomaly Detector.
UserDataFunction	Una función de datos de usuario.
GraphModel	Un GraphModel.
GraphQuerySet	Un conjunto de consultas de Graph.
SnowflakeDatabase	Una base de datos de Snowflake para almacenar tablas de Cosmos creadas a partir de la cuenta de Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Una base de datos de Cosmos DB.
Ontology	Una ontología.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.

PayloadType

Enumeración

Tipo de la carga de la parte de definición. Se pueden agregar tipos de carga adicionales a lo largo del tiempo.

Valor	Description
InlineBase64	Base 64 insertada.

PrincipalType

Enumeración

Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.

Valor	Description
User	La entidad de seguridad es una entidad de seguridad de usuario Microsoft Entra.
ServicePrincipal	La entidad de seguridad es una entidad de servicio Microsoft Entra.
Group	La entidad de seguridad es un grupo de seguridad.
ServicePrincipalProfile	La entidad de servicio es un perfil de entidad de servicio.
EntireTenant	La entidad de seguridad representa todos los usuarios de inquilinos.

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.

SensitivityLabel

Objeto

Representa una etiqueta de confidencialidad aplicada a un elemento.

Nombre	Tipo	Description
id	string (uuid)	Identificador de etiqueta de confidencialidad.

SensitivityLabelApplyStrategy

Enumeración

Estrategia para aplicar la etiqueta de confidencialidad. El valor predeterminado es ApplyOrFail. Se pueden agregar tipos adicionales a lo largo del tiempo.

Valor	Description
ApplyOrFail	Aplique la etiqueta de confidencialidad o produzca un error en la operación si no se puede aplicar.
Ignore	Omita la etiqueta de confidencialidad si no se puede aplicar y continúe con la operación sin aplicar la etiqueta.

SensitivityLabelSettings

Objeto

Configuración de la etiqueta de confidencialidad.

Nombre	Tipo	Description
labelId	string (uuid)	Identificador de etiqueta de confidencialidad.
sensitivityLabelApplyStrategy	SensitivityLabelApplyStrategy	Estrategia para aplicar la etiqueta de confidencialidad.

ServicePrincipalDetails

Objeto

Detalles específicos de la entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es ServicePrincipal.

Nombre	Tipo	Description
aadAppId	string (uuid)	AppId de Microsoft Entra de la entidad de servicio.

ServicePrincipalPrincipal

Objeto

Representa una entidad de servicio de Microsoft Entra.

Nombre	Tipo	Description
displayName	string	Nombre para mostrar de la entidad de seguridad.
id	string (uuid)	Identificador de la entidad de seguridad.
servicePrincipalDetails	ServicePrincipalDetails	Detalles específicos de la entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es `ServicePrincipal`.
type	string: ServicePrincipal	Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.

ServicePrincipalProfileDetails

Objeto

Detalles del perfil de entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es ServicePrincipalProfile.

Nombre	Tipo	Description
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	La entidad de seguridad principal del perfil de la entidad de servicio.

ServicePrincipalProfilePrincipal

Objeto

Representa un perfil de entidad de servicio.

Nombre	Tipo	Description
displayName	string	Nombre para mostrar de la entidad de seguridad.
id	string (uuid)	Identificador de la entidad de seguridad.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Detalles del perfil de entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.

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.

UserDetails

Objeto

Detalles específicos de la entidad de seguridad de usuario. Aplicable cuando el tipo de entidad de seguridad es User.

Nombre	Tipo	Description
userPrincipalName	string	Nombre principal de usuario.

UserPrincipal

Objeto

Representa una entidad de seguridad de usuario Microsoft Entra.

Nombre	Tipo	Description
displayName	string	Nombre para mostrar de la entidad de seguridad.
id	string (uuid)	Identificador de la entidad de seguridad.
type	string: User	Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.
userDetails	UserDetails	Detalles específicos de la entidad de seguridad de usuario. Aplicable cuando el tipo de entidad de seguridad es `User`.