Items - Create Environment

Servizio:: Environment

Versione API:: v1

Crea un ambiente nell'area di lavoro specificata.
Questa API supporta operazioni con esecuzione prolungata (LRO).

Autorizzazioni

Il chiamante deve avere un ruolo di area di lavoro collaboratore .

Ambiti delegati obbligatori

Environment.ReadWrite.All o Item.ReadWrite.All

Limitazioni

Per creare un ambiente, l'area di lavoro deve essere in una capacità di Infrastruttura supportata.

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità	Appoggiare
Utente	Sì
'entità servizio e identità gestite	Sì

Interfaccia

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
workspaceId	path	True	string (uuid)	ID dell'area di lavoro.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
displayName	True	string	Nome visualizzato dell'ambiente.
definition		EnvironmentDefinition	Definizione pubblica dell'ambiente.
description		string	Descrizione dell'ambiente. La lunghezza massima è di 256 caratteri.
folderId		string (uuid)	ID cartella. Se non specificato o null, l'ambiente viene creato con l'area di lavoro come cartella.

Risposte

Nome	Tipo	Descrizione
201 Created	Environment	Creazione completata
202 Accepted		Richiesta accettata, provisioning dell'ambiente in corso Intestazioni Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: InvalidItemType - Tipo di elemento non valido ItemDisplayNameAlreadyInUse - Nome visualizzato dell'elemento già usato CorruptedPayload: il payload fornito è danneggiato. WorkspaceItemsLimitExceeded - Limite di elementi dell'area di lavoro superato.

Nome

Tipo

Descrizione

201 Created

Environment

Creazione completata

202 Accepted

Richiesta accettata, provisioning dell'ambiente in corso

Intestazioni

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Codici di errore comuni:

InvalidItemType - Tipo di elemento non valido
ItemDisplayNameAlreadyInUse - Nome visualizzato dell'elemento già usato
CorruptedPayload: il payload fornito è danneggiato.
WorkspaceItemsLimitExceeded - Limite di elementi dell'area di lavoro superato.

Esempio

Create an environment example

Create an environment with public definition example

Create an environment example

Esempio di richiesta

HTTP

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

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

Risposta di esempio

Codice di stato:: 201

{
  "displayName": "Environment_1",
  "description": "An environment description.",
  "type": "Environment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Codice di stato:: 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

Esempio di richiesta

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"
      }
    ]
  }
}

Risposta di esempio

Codice di stato:: 201

{
  "displayName": "Environment_1",
  "description": "An environment description.",
  "type": "Environment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Codice di stato:: 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

Definizioni

Nome	Descrizione
ComponentPublishInfo	Pubblicare informazioni per ogni componente nell'ambiente.
CreateEnvironmentRequest	Creare il payload della richiesta di ambiente.
Environment	Elemento Environment.
EnvironmentDefinition	Oggetto definizione pubblica dell'ambiente. Per altre informazioni su come creare una definizione pubblica dell'ambiente, vedere questo articolo .
EnvironmentDefinitionPart	Oggetto parte della definizione dell'ambiente.
EnvironmentProperties	Proprietà dell'ambiente.
EnvironmentPublishState	Stato di pubblicazione. È possibile aggiungere altri tipi di stato nel tempo.
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
ItemTag	Rappresenta un tag applicato a un elemento.
ItemType	Tipo dell'elemento. È possibile aggiungere altri tipi di elemento nel tempo.
PayloadType	Tipo del payload della parte di definizione. È possibile aggiungere altri tipi di payload nel tempo.
PublishDetails	Dettagli dell'operazione di pubblicazione.
SparkLibraries	Librerie Spark.
SparkSettings	Impostazioni di Spark.

ComponentPublishInfo

Oggetto

Pubblicare informazioni per ogni componente nell'ambiente.

Nome	Tipo	Descrizione
sparkLibraries	SparkLibraries	Le librerie Spark pubblicano informazioni.
sparkSettings	SparkSettings	Le impostazioni di Spark pubblicano informazioni.

CreateEnvironmentRequest

Oggetto

Creare il payload della richiesta di ambiente.

Nome	Tipo	Descrizione
definition	EnvironmentDefinition	Definizione pubblica dell'ambiente.
description	string	Descrizione dell'ambiente. La lunghezza massima è di 256 caratteri.
displayName	string	Nome visualizzato dell'ambiente.
folderId	string (uuid)	ID cartella. Se non specificato o null, l'ambiente viene creato con l'area di lavoro come cartella.

Environment

Oggetto

Elemento Environment.

Nome	Tipo	Descrizione
description	string	Descrizione dell'elemento.
displayName	string	Nome visualizzato dell'elemento.
folderId	string (uuid)	ID cartella.
id	string (uuid)	ID elemento.
properties	EnvironmentProperties	Proprietà dell'ambiente.
tags	ItemTag[]	Elenco di tag applicati.
type	ItemType	Tipo di elemento.
workspaceId	string (uuid)	ID dell'area di lavoro.

EnvironmentDefinition

Oggetto

Oggetto definizione pubblica dell'ambiente. Per altre informazioni su come creare una definizione pubblica dell'ambiente, vedere questo articolo .

Nome	Tipo	Descrizione
format	string	Formato della definizione dell'ambiente.
parts	EnvironmentDefinitionPart[]	Elenco di parti di definizione.

EnvironmentDefinitionPart

Oggetto

Oggetto parte della definizione dell'ambiente.

Nome	Tipo	Descrizione
path	string	Percorso della parte dell'ambiente.
payload	string	Payload della parte dell'ambiente.
payloadType	PayloadType	Tipo di payload.

EnvironmentProperties

Oggetto

Proprietà dell'ambiente.

Nome	Tipo	Descrizione
publishDetails	PublishDetails	Dettagli dell'operazione di pubblicazione dell'ambiente.

EnvironmentPublishState

Enumerazione

Stato di pubblicazione. È possibile aggiungere altri tipi di stato nel tempo.

Valore	Descrizione
Success	La pubblicazione dell'ambiente è in stato di esito positivo.
Cancelled	La pubblicazione dell'ambiente è in stato annullato.
Failed	Lo stato di pubblicazione dell'ambiente non è riuscito.
Cancelling	La pubblicazione dell'ambiente è in stato di annullamento.
Running	La pubblicazione dell'ambiente è in esecuzione.
Waiting	La pubblicazione dell'ambiente è in stato di attesa.

ErrorRelatedResource

Oggetto

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string	ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

ItemTag

Oggetto

Rappresenta un tag applicato a un elemento.

Nome	Tipo	Descrizione
displayName	string	Nome del tag.
id	string (uuid)	ID tag.

ItemType

Enumerazione

Tipo dell'elemento. È possibile aggiungere altri tipi di elemento nel tempo.

Valore	Descrizione
Dashboard	Dashboard di Power BI.
Report	Report di Power BI.
SemanticModel	Modello semantico di PowerBI.
PaginatedReport	Report impaginato di Power BI.
Datamart	Datamart di PowerBI.
Lakehouse	Una lakehouse.
Eventhouse	Una casa eventi.
Environment	Un ambiente.
KQLDatabase	Un database KQL.
KQLQueryset	Set di query KQL.
KQLDashboard	Dashboard KQL.
DataPipeline	Una pipeline di dati.
Notebook	Un notebook.
SparkJobDefinition	Definizione di processo Spark.
MLExperiment	Esperimento di Machine Learning.
MLModel	Modello di Machine Learning.
Warehouse	Un magazzino.
Eventstream	Flusso di eventi.
SQLEndpoint	Endpoint SQL.
MirroredWarehouse	Magazzino con mirroring.
MirroredDatabase	Database con mirroring.
Reflex	Un riflesso.
GraphQLApi	API per l'elemento GraphQL.
MountedDataFactory	Oggetto MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Processo di copia.
VariableLibrary	VariabileLibrary.
Dataflow	Flusso di dati.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Uno snapshot del warehouse.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Flusso di Generatore di gemelli digitali.
MirroredAzureDatabricksCatalog	Catalogo di Azure databricks con mirroring.
Map	Una mappa.
AnomalyDetector	Rilevamento anomalie.
UserDataFunction	Funzione dati utente.
GraphModel	A GraphModel.
GraphQuerySet	Oggetto Graph QuerySet.
SnowflakeDatabase	Un database Snowflake per archiviare le tabelle Iceberg create dall'account Snowflake.
OperationsAgent	Oggetto OperationsAgent.
CosmosDBDatabase	Un database Cosmos DB.

PayloadType

Enumerazione

Tipo del payload della parte di definizione. È possibile aggiungere altri tipi di payload nel tempo.

Valore	Descrizione
InlineBase64	Inline Base 64.

PublishDetails

Oggetto

Dettagli dell'operazione di pubblicazione.

Nome	Tipo	Descrizione
componentPublishInfo	ComponentPublishInfo	Informazioni sulla pubblicazione dei componenti dell'ambiente.
endTime	string (date-time)	Ora di fine dell'operazione di pubblicazione in formato UTC, utilizzando il formato YYYY-MM-DDTHH:mm:ss.ssZ.
startTime	string (date-time)	Ora di inizio dell'operazione di pubblicazione in formato UTC, usando il formato YYYY-MM-DDTHH:mm:ss.ssssZ.
state	EnvironmentPublishState	Stato di pubblicazione. È possibile aggiungere altri tipi di stato nel tempo.
targetVersion	string (uuid)	Verifica di destinazione da pubblicare.

SparkLibraries

Oggetto

Librerie Spark.

Nome	Tipo	Descrizione
state	EnvironmentPublishState	Stato di pubblicazione. È possibile aggiungere altri tipi di stato nel tempo.

SparkSettings

Oggetto

Impostazioni di Spark.

Nome	Tipo	Descrizione
state	EnvironmentPublishState	Stato di pubblicazione. È possibile aggiungere altri tipi di stato nel tempo.

Condividi tramite

Items - Create Environment

Autorizzazioni

Ambiti delegati obbligatori

Limitazioni

Identità supportate da Microsoft Entra

Interfaccia

Parametri dell'URI

Corpo della richiesta

Risposte

Esempio

Create an environment example

Esempio di richiesta

Risposta di esempio

Create an environment with public definition example

Esempio di richiesta

Risposta di esempio

Definizioni

ComponentPublishInfo

CreateEnvironmentRequest

Environment

EnvironmentDefinition

EnvironmentDefinitionPart

EnvironmentProperties

EnvironmentPublishState

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PayloadType

PublishDetails

SparkLibraries

SparkSettings