Delen via

Items - Update Environment

  • Referentie
Service:
Environment
API-versie:
v1

Hiermee worden de eigenschappen van de opgegeven omgeving bijgewerkt.

Machtigingen

De aanroeper moet inzender hebben of een hogere werkruimterol.

Vereiste gedelegeerde bereiken

Environment.ReadWrite.All of Item.ReadWrite.All

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.

Identiteit Steunen
Gebruiker Ja
service-principal en beheerde identiteiten Ja

Interface

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

URI-parameters

Name In Vereist Type Description
environmentId
 path True

string

uuid

De omgevings-id.
workspaceId
 path True

string

uuid

De werkruimte-id.

Aanvraagbody

Name Type Description
description

string

De beschrijving van de omgeving. De maximale lengte is 256 tekens.
displayName

string

De weergavenaam van de omgeving.

Antwoorden

Name Type Description
200 OK

Environment

De aanvraag is voltooid.
Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • ItemNotFound : het aangevraagde item is niet gevonden.

  • InvalidRequest - Ongeldige updateaanvraag

Voorbeelden

Update a environment example

Voorbeeldaanvraag

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments/5b218778-e7a5-4d73-8187-f10824047715

{
  "displayName": "Environment_New_Name",
  "description": "A new description for environment."
}

Voorbeeldrespons

Statuscode:
200 
{
  "displayName": "Environment_New_Name",
  "description": "A new description for environment.",
  "type": "Environment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Definities

Name Description
ComponentPublishInfo

Publiceer informatie voor elke onderdelen in de omgeving.
Environment

Een omgevingsitem.
EnvironmentPublishInfo

Informatie over het publiceren van de omgeving.
EnvironmentPublishState

Publicatiestatus. Er kunnen in de loop van de tijd extra statustypen worden toegevoegd.
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

Het foutbericht.
ErrorResponseDetails

De details van het foutbericht.
ItemType

Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.
PublishDetails

Details van de publicatiebewerking.
SparkLibraries

Spark-bibliotheken.
SparkSettings

Spark-instellingen.
UpdateEnvironmentRequest

Omgevingsaanvraag bijwerken.

ComponentPublishInfo

Object

Publiceer informatie voor elke onderdelen in de omgeving.

Name Type Description
sparkLibraries

SparkLibraries

Spark-bibliotheken publiceren informatie.
sparkSettings

SparkSettings

Spark-instellingen publiceren informatie.

Environment

Object

Een omgevingsitem.

Name Type Description
description

string

De beschrijving van het item.
displayName

string

De weergavenaam van het item.
id

string

uuid

De item-id.
properties

EnvironmentPublishInfo

De omgevingseigenschappen.
type

ItemType

Het itemtype.
workspaceId

string

uuid

De werkruimte-id.

EnvironmentPublishInfo

Object

Informatie over het publiceren van de omgeving.

Name Type Description
publishDetails

PublishDetails

Details van de publicatiebewerking in de omgeving.

EnvironmentPublishState

Inventarisatie

Publicatiestatus. Er kunnen in de loop van de tijd extra statustypen worden toegevoegd.

Waarde Description
Cancelled

Het publiceren van de omgeving heeft de status Geannuleerd.
Cancelling

Het publiceren van de omgeving heeft de status Annuleren.
Failed

Het publiceren van de omgeving heeft de status Mislukt.
Running

Het publiceren van de omgeving heeft de status Actief.
Success

Het publiceren van de omgeving heeft de status Geslaagd.
Waiting

Het publiceren van de omgeving heeft een wachtstatus.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name Type Description
resourceId

string

De resource-id die betrokken is bij de fout.
resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.
requestId

string

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.

ItemType

Inventarisatie

Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.

Waarde Description
Dashboard

PowerBI-dashboard.
DataPipeline

Een gegevenspijplijn.
Datamart

PowerBI-datamart.
Environment

Een omgeving.
Eventhouse

Een eventhouse.
Eventstream

Een eventstream.
GraphQLApi

Een API voor GraphQL-item.
KQLDashboard

Een KQL-dashboard.
KQLDatabase

Een KQL-database.
KQLQueryset

Een KQL-queryset.
Lakehouse

Een lakehouse.
MLExperiment

Een machine learning-experiment.
MLModel

Een machine learning-model.
MirroredDatabase

Een gespiegelde database.
MirroredWarehouse

Een gespiegeld magazijn.
MountedDataFactory

Een MountedDataFactory.
Notebook

Een notitieblok.
PaginatedReport

Gepagineerd Power BI-rapport.
Reflex

Een reflex.
Report

PowerBI-rapport.
SQLDatabase

Een SQLDatabase.
SQLEndpoint

Een SQL-eindpunt.
SemanticModel

Semantisch Power BI-model.
SparkJobDefinition

Een Spark-taakdefinitie.
Warehouse

Een magazijn.

PublishDetails

Object

Details van de publicatiebewerking.

Name Type Description
componentPublishInfo

ComponentPublishInfo

Informatie over het publiceren van omgevingsonderdelen.
endTime

string

date-time

Eindtijd van de publicatiebewerking.
startTime

string

date-time

Begintijd van de publicatiebewerking.
state

EnvironmentPublishState

Publicatiestatus. Er kunnen in de loop van de tijd extra statustypen worden toegevoegd.
targetVersion

string

uuid

Doelversie die moet worden gepubliceerd.

SparkLibraries

Object

Spark-bibliotheken.

Name Type Description
state

EnvironmentPublishState

Publicatiestatus. Er kunnen in de loop van de tijd extra statustypen worden toegevoegd.

SparkSettings

Object

Spark-instellingen.

Name Type Description
state

EnvironmentPublishState

Publicatiestatus. Er kunnen in de loop van de tijd extra statustypen worden toegevoegd.

UpdateEnvironmentRequest

Object

Omgevingsaanvraag bijwerken.

Name Type Description
description

string

De beschrijving van de omgeving. De maximale lengte is 256 tekens.
displayName

string

De weergavenaam van de omgeving.