Items - Create Environment

Palvelu:: Environment

Ohjelmointirajapinnan versio:: v1

Luo ympäristön määritettyyn työtilaan.
Tämä ohjelmointirajapinta tukee pitkäkestoisia toimintoja.

Käyttöoikeudet

Kutsujalla on oltava osallistujan työtilan rooli.

Vaaditut delegoidut vaikutusalueet

Environment.ReadWrite.All tai Item.ReadWrite.All

Rajoitukset

Ympäristön luomiseksi työtilan on oltava tuettua Fabric-kapasiteettia.

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identiteetti	Tuki
Käyttäjä	Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen	Kyllä

Liittymä

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Description
workspaceId	path	True	string (uuid)	Työtilan tunnus.

Pyynnön leipäteksti

Nimi	Pakollinen	Tyyppi	Description
displayName	True	string	Ympäristön näyttönimi.
definition		EnvironmentDefinition	Ympäristön julkinen määritys.
description		string	Ympäristön kuvaus. Enimmäispituus on 256 merkkiä.
folderId		string (uuid)	Kansion tunnus. Jos sitä ei määritetä tai se on tyhjäarvoinen, ympäristö luodaan niin, että työtila on sen kansio.

Vastaukset

Nimi	Tyyppi	Description
201 Created	Environment	Luonti onnistui
202 Accepted		Pyynnön hyväksyminen, keskeneräinen ympäristön valmistelu Otsikot Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Yleiset virhekoodit: InvalidItemType – Kohdetyyppi on virheellinen ItemDisplayNameAlreadyInUse – Kohteen näyttönimi on jo käytössä VioittunutPayload – Annetut tiedot ovat vioittuneet. WorkspaceItemsLimitExceeded – Työtilan kohteen raja ylitetty.

Nimi

Tyyppi

Description

201 Created

Environment

Luonti onnistui

202 Accepted

Pyynnön hyväksyminen, keskeneräinen ympäristön valmistelu

Otsikot

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

Other Status Codes

ErrorResponse

Yleiset virhekoodit:

InvalidItemType – Kohdetyyppi on virheellinen
ItemDisplayNameAlreadyInUse – Kohteen näyttönimi on jo käytössä
VioittunutPayload – Annetut tiedot ovat vioittuneet.
WorkspaceItemsLimitExceeded – Työtilan kohteen raja ylitetty.

Esimerkit

Create an environment example

Create an environment with public definition example

Create an environment example

Mallipyyntö

HTTP

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

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

Mallivastaus

Tilakoodi:: 201

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

Tilakoodi:: 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

Mallipyyntö

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

Mallivastaus

Tilakoodi:: 201

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

Tilakoodi:: 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

Määritelmät

Nimi	Description
ComponentPublishInfo	Julkaise ympäristön kunkin komponentin tiedot.
CreateEnvironmentRequest	Luo ympäristöpyyntöjen tiedot.
Environment	Ympäristö-kohde.
EnvironmentDefinition	Ympäristön julkinen määritysobjekti. Katso tästä artikkelista lisätietoja ympäristön julkisen määrityksen luomisesta.
EnvironmentDefinitionPart	Ympäristön määritelmäosan objekti.
EnvironmentProperties	Ympäristön ominaisuudet.
EnvironmentPublishState	Julkaisutila. Muita tilatyyppejä voidaan lisätä ajan kuluessa.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
ItemTag	Edustaa kohteelle käytettyä tunnistetta.
ItemType	Kohteen tyyppi. Muita kohdetyyppejä voidaan lisätä ajan kuluessa.
PayloadType	Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.
PublishDetails	Julkaisutoiminnon tiedot.
SparkLibraries	Spark-kirjastot.
SparkSettings	Spark-asetukset.

ComponentPublishInfo

Kohde

Julkaise ympäristön kunkin komponentin tiedot.

Nimi	Tyyppi	Description
sparkLibraries	SparkLibraries	Spark-kirjastot julkaisevat tietoja.
sparkSettings	SparkSettings	Spark-asetusten julkaisutiedot.

CreateEnvironmentRequest

Kohde

Luo ympäristöpyyntöjen tiedot.

Nimi	Tyyppi	Description
definition	EnvironmentDefinition	Ympäristön julkinen määritys.
description	string	Ympäristön kuvaus. Enimmäispituus on 256 merkkiä.
displayName	string	Ympäristön näyttönimi.
folderId	string (uuid)	Kansion tunnus. Jos sitä ei määritetä tai se on tyhjäarvoinen, ympäristö luodaan niin, että työtila on sen kansio.

Environment

Kohde

Ympäristö-kohde.

Nimi	Tyyppi	Description
description	string	Kohteen kuvaus.
displayName	string	Kohteen näyttönimi.
folderId	string (uuid)	Kansion tunnus.
id	string (uuid)	Kohdetunnus.
properties	EnvironmentProperties	Ympäristön ominaisuudet.
tags	ItemTag[]	Luettelo käytössä olevista tunnisteista.
type	ItemType	Kohdetyyppi.
workspaceId	string (uuid)	Työtilan tunnus.

EnvironmentDefinition

Kohde

Ympäristön julkinen määritysobjekti. Katso tästä artikkelista lisätietoja ympäristön julkisen määrityksen luomisesta.

Nimi	Tyyppi	Description
format	string	Ympäristön määrityksen muoto.
parts	EnvironmentDefinitionPart[]	Luettelo määritysosista.

EnvironmentDefinitionPart

Kohde

Ympäristön määritelmäosan objekti.

Nimi	Tyyppi	Description
path	string	Ympäristöosan polku.
payload	string	Ympäristön osakuormitus.
payloadType	PayloadType	Hyötykuorman tyyppi.

EnvironmentProperties

Kohde

Ympäristön ominaisuudet.

Nimi	Tyyppi	Description
publishDetails	PublishDetails	Ympäristön julkaisutoiminnon tiedot.

EnvironmentPublishState

Luettelointi

Julkaisutila. Muita tilatyyppejä voidaan lisätä ajan kuluessa.

Arvo	Description
Success	Ympäristön julkaiseminen on onnistumistilassa.
Cancelled	Ympäristön julkaiseminen on peruutettuna.
Failed	Ympäristön julkaisu on epäonnistuneessa tilassa.
Cancelling	Ympäristön julkaisu on peruuttamassa tilaa.
Running	Ympäristön julkaisu on käynnissä-tilassa.
Waiting	Ympäristön julkaisu on odotustilassa.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Description
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Description
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi	Tyyppi	Description
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

ItemTag

Kohde

Edustaa kohteelle käytettyä tunnistetta.

Nimi	Tyyppi	Description
displayName	string	Tunnisteen nimi.
id	string (uuid)	Tunnisteen tunnus.

ItemType

Luettelointi

Kohteen tyyppi. Muita kohdetyyppejä voidaan lisätä ajan kuluessa.

Arvo	Description
Dashboard	Power BI -koontinäyttö.
Report	PowerBI -raportti.
SemanticModel	PowerBI:n semanttinen malli.
PaginatedReport	PowerBI:n sivutettu raportti.
Datamart	PowerBI -tietomarssi.
Lakehouse	Tämä on lakehouse.
Eventhouse	Tapahtumatalo.
Environment	Ympäristö.
KQLDatabase	KQL-tietokanta.
KQLQueryset	KQL-kyselyjoukko.
KQLDashboard	KQL-koontinäyttö.
DataPipeline	Tietoputki.
Notebook	Muistikirja.
SparkJobDefinition	Spark-työn määritelmä.
MLExperiment	Koneoppimisen kokeilu.
MLModel	Koneoppimismalli.
Warehouse	Varasto.
Eventstream	Tapahtumavirta.
SQLEndpoint	SQL-päätepiste.
MirroredWarehouse	Peilattu varasto.
MirroredDatabase	Peilattu tietokanta.
Reflex	Refleksi.
GraphQLApi	Ohjelmointirajapinta GraphQL-kohteelle.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Kopiotyö.
VariableLibrary	MuuttujaLibrary.
Dataflow	Tietovuo.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Varastotilannevedos.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Digital Twin Builder -työnkulku.
MirroredAzureDatabricksCatalog	Peilattu Azure Databricks -luettelo.
Map	Kartta.
AnomalyDetector	Poikkeamien tunnistaminen.
UserDataFunction	Käyttäjätietofunktio.
GraphModel	A GraphModel.
GraphQuerySet	A Graph QuerySet.
SnowflakeDatabase	Snowflake-tietokannalla tallennetaan Snowflake-tililtä luodut Iceberg-taulukot.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Cosmos DB -tietokanta.
Ontology	Ontologia.
EventSchemaSet	An EventSchemaSet.

PayloadType

Luettelointi

Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.

Arvo	Description
InlineBase64	Inline Base 64.

PublishDetails

Kohde

Julkaisutoiminnon tiedot.

Nimi	Tyyppi	Description
componentPublishInfo	ComponentPublishInfo	Ympäristön osan julkaisutiedot.
endTime	string (date-time)	Julkaisutoiminnon päättymisaika UTC-muodossa VVVV-KK-PPTHH:mm:ss.ssssssZ.
startTime	string (date-time)	Julkaisutoiminnon alkamisaika UTC-muodossa VVVV-KK-PPTHH:mm:ss.ssssssZ.
state	EnvironmentPublishState	Julkaisutila. Muita tilatyyppejä voidaan lisätä ajan kuluessa.
targetVersion	string (uuid)	Target verion julkaistaan.

SparkLibraries

Kohde

Spark-kirjastot.

Nimi	Tyyppi	Description
state	EnvironmentPublishState	Julkaisutila. Muita tilatyyppejä voidaan lisätä ajan kuluessa.

SparkSettings

Kohde

Spark-asetukset.

Nimi	Tyyppi	Description
state	EnvironmentPublishState	Julkaisutila. Muita tilatyyppejä voidaan lisätä ajan kuluessa.

Jaa

Items - Create Environment

Käyttöoikeudet

Vaaditut delegoidut vaikutusalueet

Rajoitukset

Microsoft Entran tukemat käyttäjätiedot

Liittymä

URI-parametrit

Pyynnön leipäteksti

Vastaukset

Esimerkit

Create an environment example

Mallipyyntö

Mallivastaus

Create an environment with public definition example

Mallipyyntö

Mallivastaus

Määritelmät

ComponentPublishInfo

CreateEnvironmentRequest

Environment

EnvironmentDefinition

EnvironmentDefinitionPart

EnvironmentProperties

EnvironmentPublishState

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PayloadType

PublishDetails

SparkLibraries

SparkSettings