Condividi tramite

Items - Create Environment

  • Riferimento
Servizio:
Environment
Versione API:
v1

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

Questa API non supporta la creazione di un ambiente con definizione.

Autorizzazioni

Il chiamante deve avere ruolo collaboratore o superiore dell'area di lavoro.

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

string

Descrizione dell'ambiente. La lunghezza massima è di 256 caratteri.

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

Esempio

Create a environment example

Esempio di richiesta

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

Definizioni

Nome Descrizione
ComponentPublishInfo

Pubblicare informazioni per ogni componente nell'ambiente.
CreateEnvironmentRequest

Creare il payload della richiesta di ambiente.
Environment

Elemento Environment.
EnvironmentPublishInfo

Informazioni sulla pubblicazione 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.
ItemType

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

Dettagli dell'operazione di pubblicazione.
SparkLibraries

Librerie Spark.
SparkSettings

Impostazioni di Spark.

ComponentPublishInfo

Object

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

Object

Creare il payload della richiesta di ambiente.

Nome Tipo Descrizione
description

string

Descrizione dell'ambiente. La lunghezza massima è di 256 caratteri.
displayName

string

Nome visualizzato dell'ambiente.

Environment

Object

Elemento Environment.

Nome Tipo Descrizione
description

string

Descrizione dell'elemento.
displayName

string

Nome visualizzato dell'elemento.
id

string

uuid

ID elemento.
properties

EnvironmentPublishInfo

Proprietà dell'ambiente.
type

ItemType

Tipo di elemento.
workspaceId

string

uuid

ID dell'area di lavoro.

EnvironmentPublishInfo

Object

Informazioni sulla pubblicazione dell'ambiente.

Nome Tipo Descrizione
publishDetails

PublishDetails

Dettagli dell'operazione di pubblicazione dell'ambiente.

EnvironmentPublishState

Enumeration

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

Valore Descrizione
Cancelled

La pubblicazione dell'ambiente è in stato annullato.
Cancelling

La pubblicazione dell'ambiente è in stato di annullamento.
Failed

Lo stato di pubblicazione dell'ambiente non è riuscito.
Running

La pubblicazione dell'ambiente è in esecuzione.
Success

La pubblicazione dell'ambiente è in stato di esito positivo.
Waiting

La pubblicazione dell'ambiente è in stato di attesa.

ErrorRelatedResource

Object

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

Object

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

Object

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.

ItemType

Enumeration

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

Valore Descrizione
Dashboard

Dashboard di Power BI.
DataPipeline

Una pipeline di dati.
Datamart

Datamart di PowerBI.
Environment

Un ambiente.
Eventhouse

Una casa eventi.
Eventstream

Flusso di eventi.
GraphQLApi

API per l'elemento GraphQL.
KQLDashboard

Dashboard KQL.
KQLDatabase

Un database KQL.
KQLQueryset

Set di query KQL.
Lakehouse

Una lakehouse.
MLExperiment

Esperimento di Machine Learning.
MLModel

Modello di Machine Learning.
MirroredDatabase

Database con mirroring.
MirroredWarehouse

Magazzino con mirroring.
MountedDataFactory

Oggetto MountedDataFactory.
Notebook

Un notebook.
PaginatedReport

Report impaginato di Power BI.
Reflex

Un riflesso.
Report

Report di Power BI.
SQLDatabase

A SQLDatabase.
SQLEndpoint

Endpoint SQL.
SemanticModel

Modello semantico di PowerBI.
SparkJobDefinition

Definizione di processo Spark.
Warehouse

Un magazzino.

PublishDetails

Object

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

string

date-time

Ora di inizio dell'operazione di pubblicazione.
state

EnvironmentPublishState

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

string

uuid

Verifica di destinazione da pubblicare.

SparkLibraries

Object

Librerie Spark.

Nome Tipo Descrizione
state

EnvironmentPublishState

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

SparkSettings

Object

Impostazioni di Spark.

Nome Tipo Descrizione
state

EnvironmentPublishState

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