Items - Update Environment

Usługa:
Environment
Wersja interfejsu API:
v1

Aktualizuje właściwości określonego środowiska.

Uprawnienia

Obiekt wywołujący musi mieć uprawnienia do odczytu i zapisu dla środowiska.

Wymagane zakresy delegowane

Environment.ReadWrite.All lub Item.ReadWrite.All

Microsoft Entra obsługiwane tożsamości

Ten interfejs API obsługuje Microsoft identities wymienione w tej sekcji.

Tożsamość Wsparcie
Użytkownik Tak
Główne usługi i Tożsamości zarządzane Tak

Interfejs

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
environmentId
 path True

string (uuid)

Identyfikator środowiska.
workspaceId
 path True

string (uuid)

Identyfikator obszaru roboczego.

Treść żądania

Nazwa Typ Opis
description

string

Opis środowiska. Maksymalna długość to 256 znaków.
displayName

string

Nazwa wyświetlana środowiska.

Odpowiedzi

Nazwa Typ Opis
200 OK

Environment

Żądanie zostało ukończone pomyślnie.
429 Too Many Requests

ErrorResponse

Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Retry-After w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań.

Nagłówki

Retry-After: integer
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • ItemNotFound — żądany element nie został znaleziony.

  • InvalidRequest — nieprawidłowe żądanie aktualizacji

Przykłady

Update a environment example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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"
}

Definicje

Nazwa Opis
ComponentPublishInfo

Publikowanie informacji dla poszczególnych składników w środowisku.
EntireTenantPrincipal

Reprezentuje podmiot zabezpieczeń dzierżawy
Environment

Element środowisko.
EnvironmentProperties

Właściwości środowiska.
EnvironmentPublishState

Stan publikowania. W miarę upływu czasu można dodawać dodatkowe typy stanów.
ErrorRelatedResource

Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.
GroupDetails

Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń to Group.
GroupPrincipal

Reprezentuje grupę zabezpieczeń.
GroupType

Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.
ItemTag

Reprezentuje tag zastosowany w elemencie.
ItemType

Typ elementu. Dodatkowe typy elementów można dodawać w czasie.
PrincipalType

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.
PublishDetails

Szczegóły operacji publikowania.
SensitivityLabel

Reprezentuje etykietę poufności zastosowaną do elementu.
ServicePrincipalDetails

Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń to ServicePrincipal.
ServicePrincipalPrincipal

Reprezentuje Microsoft Entra jednostkę usługi.
ServicePrincipalProfileDetails

Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń to ServicePrincipalProfile.
ServicePrincipalProfilePrincipal

Reprezentuje profil jednostki usługi.
SparkLibraries

Biblioteki platformy Spark.
SparkSettings

Ustawienia platformy Spark.
UpdateEnvironmentRequest

Żądanie aktualizacji środowiska.
UserDetails

Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń to User.
UserPrincipal

Reprezentuje Microsoft Entra podmiot zabezpieczeń użytkownika.

ComponentPublishInfo

Objekt

Publikowanie informacji dla poszczególnych składników w środowisku.

Nazwa Typ Opis
sparkLibraries

SparkLibraries

Biblioteki platformy Spark publikują informacje.
sparkSettings

SparkSettings

Ustawienia platformy Spark publikują informacje.

EntireTenantPrincipal

Objekt

Reprezentuje podmiot zabezpieczeń dzierżawy

Nazwa Typ Opis
displayName

string

Nazwa wyświetlana podmiotu zabezpieczeń.
id

string (uuid)

Identyfikator podmiotu zabezpieczeń.
type string:

EntireTenant

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

Environment

Objekt

Element środowisko.

Nazwa Typ Opis
defaultIdentity Principal:

Tożsamość domyślna elementu.
description

string

Opis elementu.
displayName

string

Nazwa wyświetlana elementu.
folderId

string (uuid)

Identyfikator folderu.
id

string (uuid)

Identyfikator elementu.
properties

EnvironmentProperties

Właściwości środowiska.
sensitivityLabel

SensitivityLabel

Etykieta poufności elementu.
tags

ItemTag[]

Lista zastosowanych tagów.
type

ItemType

Typ elementu.
workspaceId

string (uuid)

Identyfikator obszaru roboczego.

EnvironmentProperties

Objekt

Właściwości środowiska.

Nazwa Typ Opis
publishDetails

PublishDetails

Szczegóły operacji publikowania środowiska.

EnvironmentPublishState

Wyliczenie

Stan publikowania. W miarę upływu czasu można dodawać dodatkowe typy stanów.

Wartość Opis
Success

Publikowanie środowiska jest w stanie powodzenia.
Cancelled

Publikowanie środowiska jest w stanie anulowania.
Failed

Publikowanie środowiska jest w stanie niepowodzenia.
Cancelling

Publikowanie środowiska jest w stanie anulowania.
Running

Publikowanie środowiska jest w stanie uruchomienia.
Waiting

Publikowanie środowiska jest w stanie oczekiwania.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa Typ Opis
resourceId

string

Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType

string

Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
moreDetails

ErrorResponseDetails[]

Lista dodatkowych szczegółów błędu.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.
requestId

string (uuid)

Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.

GroupDetails

Objekt

Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń to Group.

Nazwa Typ Opis
groupType

GroupType

Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.

GroupPrincipal

Objekt

Reprezentuje grupę zabezpieczeń.

Nazwa Typ Opis
displayName

string

Nazwa wyświetlana podmiotu zabezpieczeń.
groupDetails

GroupDetails

Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń to Group.
id

string (uuid)

Identyfikator podmiotu zabezpieczeń.
type string:

Group

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

GroupType

Wyliczenie

Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.

Wartość Opis
Unknown

Typ grupy podmiotu zabezpieczeń jest nieznany.
SecurityGroup

Podmiot zabezpieczeń jest grupą zabezpieczeń.
DistributionList

Podmiot zabezpieczeń jest listą dystrybucyjną.

ItemTag

Objekt

Reprezentuje tag zastosowany w elemencie.

Nazwa Typ Opis
displayName

string

Nazwa znacznika.
id

string (uuid)

Identyfikator tagu.

ItemType

Wyliczenie

Typ elementu. Dodatkowe typy elementów można dodawać w czasie.

Wartość Opis
Dashboard

Pulpit nawigacyjny usługi Power BI.
Report

Raport usługi Power BI.
SemanticModel

Model semantyczny usługi PowerBI.
PaginatedReport

Raport podzielony na strony usługi PowerBI.
Datamart

Datamart usługi Power BI.
Lakehouse

Jezioro.
Eventhouse

Magazyn zdarzeń.
Environment

Środowisko.
KQLDatabase

Baza danych KQL.
KQLQueryset

Zestaw zapytań KQL.
KQLDashboard

Pulpit nawigacyjny KQL.
DataPipeline

Potok danych.
Notebook

Notes.
SparkJobDefinition

Definicja zadania platformy Spark.
MLExperiment

Eksperyment uczenia maszynowego.
MLModel

Model uczenia maszynowego.
Warehouse

Magazyn.
Eventstream

Strumień zdarzeń.
SQLEndpoint

Punkt końcowy SQL.
MirroredWarehouse

Dublowany magazyn.
MirroredDatabase

Dublowana baza danych.
Reflex

Refleks.
GraphQLApi

Interfejs API dla elementu GraphQL.
MountedDataFactory

A MountedDataFactory.
SQLDatabase

Baza danych SQLDatabase.
CopyJob

Zadanie kopiowania.
VariableLibrary

ZmiennaLibrary.
Dataflow

Przepływ danych.
ApacheAirflowJob

Zadanie ApacheAirflowJob.
WarehouseSnapshot

Migawka magazynu.
DigitalTwinBuilder

A DigitalTwinBuilder.
DigitalTwinBuilderFlow

Przepływ usługi Digital Twin Builder.
MirroredAzureDatabricksCatalog

Dublowany wykaz usługi Azure Databricks.
Map

Mapa.
AnomalyDetector

Wykrywacz anomalii.
UserDataFunction

Funkcja danych użytkownika.
GraphModel

Model programu Graph.
GraphQuerySet

Zestaw zapytań programu Graph.
SnowflakeDatabase

Baza danych Snowflake do przechowywania tabel góry lodowej utworzonych na podstawie konta Snowflake.
OperationsAgent

A OperationsAgent.
CosmosDBDatabase

Baza danych usługi Cosmos DB.
Ontology

Ontologia.
EventSchemaSet

An EventSchemaSet.
DataAgent

A DataAgent.

PrincipalType

Wyliczenie

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

Wartość Opis
User

Podmiot zabezpieczeń jest podmiotem zabezpieczeń Microsoft Entra użytkownika.
ServicePrincipal

Jednostka jest jednostką usługi Microsoft Entra.
Group

Podmiot zabezpieczeń jest grupą zabezpieczeń.
ServicePrincipalProfile

Jednostka jest profilem jednostki usługi.
EntireTenant

Podmiot zabezpieczeń reprezentuje wszystkich użytkowników dzierżawy.

PublishDetails

Objekt

Szczegóły operacji publikowania.

Nazwa Typ Opis
componentPublishInfo

ComponentPublishInfo

Składnik środowiska publikuje informacje.
endTime

string (date-time)

Godzina zakończenia operacji publikowania w formacie UTC przy użyciu formatu RRRR-MM-DDTHH:mm:ss.sssssZ.
startTime

string (date-time)

Godzina rozpoczęcia operacji publikowania w formacie UTC przy użyciu formatu RRRR-MM-DDTHH:mm:ss.ssssZ.
state

EnvironmentPublishState

Stan publikowania. W miarę upływu czasu można dodawać dodatkowe typy stanów.
targetVersion

string (uuid)

Docelowa verion do opublikowania.

SensitivityLabel

Objekt

Reprezentuje etykietę poufności zastosowaną do elementu.

Nazwa Typ Opis
id

string (uuid)

Identyfikator etykiety poufności.

ServicePrincipalDetails

Objekt

Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń to ServicePrincipal.

Nazwa Typ Opis
aadAppId

string (uuid)

Microsoft Entra AppId jednostki usługi.

ServicePrincipalPrincipal

Objekt

Reprezentuje Microsoft Entra jednostkę usługi.

Nazwa Typ Opis
displayName

string

Nazwa wyświetlana podmiotu zabezpieczeń.
id

string (uuid)

Identyfikator podmiotu zabezpieczeń.
servicePrincipalDetails

ServicePrincipalDetails

Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń to ServicePrincipal.
type string:

ServicePrincipal

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

ServicePrincipalProfileDetails

Objekt

Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń to ServicePrincipalProfile.

Nazwa Typ Opis
parentPrincipal Principal:

Jednostka nadrzędna profilu jednostki usługi.

ServicePrincipalProfilePrincipal

Objekt

Reprezentuje profil jednostki usługi.

Nazwa Typ Opis
displayName

string

Nazwa wyświetlana podmiotu zabezpieczeń.
id

string (uuid)

Identyfikator podmiotu zabezpieczeń.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń to ServicePrincipalProfile.
type string:

ServicePrincipalProfile

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

SparkLibraries

Objekt

Biblioteki platformy Spark.

Nazwa Typ Opis
state

EnvironmentPublishState

Stan publikowania. W miarę upływu czasu można dodawać dodatkowe typy stanów.

SparkSettings

Objekt

Ustawienia platformy Spark.

Nazwa Typ Opis
state

EnvironmentPublishState

Stan publikowania. W miarę upływu czasu można dodawać dodatkowe typy stanów.

UpdateEnvironmentRequest

Objekt

Żądanie aktualizacji środowiska.

Nazwa Typ Opis
description

string

Opis środowiska. Maksymalna długość to 256 znaków.
displayName

string

Nazwa wyświetlana środowiska.

UserDetails

Objekt

Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń to User.

Nazwa Typ Opis
userPrincipalName

string

Główna nazwa użytkownika.

UserPrincipal

Objekt

Reprezentuje Microsoft Entra podmiot zabezpieczeń użytkownika.

Nazwa Typ Opis
displayName

string

Nazwa wyświetlana podmiotu zabezpieczeń.
id

string (uuid)

Identyfikator podmiotu zabezpieczeń.
type string:

User

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.
userDetails

UserDetails

Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń to User.