Items - Update Environment

Layanan:
Environment
Versi API:
v1

Memperbarui properti lingkungan yang ditentukan.

Izin

Pemanggil harus memiliki izin baca dan tulis untuk lingkungan.

Cakupan yang Didelegasikan yang Diperlukan

Environment.ReadWrite.All atau Item.ReadWrite.All

Microsoft Entra identitas yang didukung

API ini mendukung Microsoft identities yang tercantum di bagian ini.

Identitas Dukung
Pengguna Ya
Prinsipal Layanan dan Identitas Terkelola Ya

Antarmuka

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
environmentId
 path True

string (uuid)

ID lingkungan.
workspaceId
 path True

string (uuid)

ID ruang kerja.

Isi Permintaan

Nama Jenis Deskripsi
description

string

Deskripsi lingkungan. Panjang maksimum adalah 256 karakter.
displayName

string

Nama tampilan lingkungan.

Respons

Nama Jenis Deskripsi
200 OK

Environment

Permintaan berhasil diselesaikan.
429 Too Many Requests

ErrorResponse

Batas tarif layanan terlampaui. Server mengembalikan header yang Retry-After menunjukkan, dalam detik, berapa lama klien harus menunggu sebelum mengirim permintaan tambahan.

Header

Retry-After: integer
Other Status Codes

ErrorResponse

Kode kesalahan umum:

  • ItemNotFound - Item yang diminta tidak ditemukan.

  • InvalidRequest - Permintaan pembaruan tidak valid

Contoh

Update a environment example

Permintaan sampel

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

Respon sampel

Kode status:
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"
}

Definisi

Nama Deskripsi
ComponentPublishInfo

Terbitkan info untuk setiap komponen di lingkungan.
EntireTenantPrincipal

Mewakili perwakilan penyewa
Environment

Item Lingkungan.
EnvironmentProperties

Properti lingkungan.
EnvironmentPublishState

Terbitkan status. Jenis status tambahan dapat ditambahkan dari waktu ke waktu.
ErrorParameter

Parameter terstruktur yang menyediakan konteks tambahan yang dapat dibaca mesin tentang kesalahan.
ErrorRelatedResource

Objek detail sumber daya terkait kesalahan.
ErrorResponse

Respons kesalahan.
ErrorResponseDetails

Detail respons kesalahan.
GroupDetails

Mengelompokkan detail spesifik. Berlaku ketika jenis utama Group.
GroupPrincipal

Mewakili grup keamanan.
GroupType

Jenis grup. Jenis grup tambahan dapat ditambahkan dari waktu ke waktu.
ItemTag

Mewakili tag yang diterapkan pada item.
ItemType

Jenis item. Jenis item tambahan dapat ditambahkan dari waktu ke waktu.
PrincipalType

Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.
PublishDetails

Detail operasi penerbitan.
SensitivityLabel

Mewakili label sensitivitas yang diterapkan ke item.
ServicePrincipalDetails

Detail spesifik perwakilan layanan. Berlaku ketika jenis utama ServicePrincipal.
ServicePrincipalPrincipal

Mewakili perwakilan layanan Microsoft Entra.
ServicePrincipalProfileDetails

Detail profil perwakilan layanan. Berlaku ketika jenis utama ServicePrincipalProfile.
ServicePrincipalProfilePrincipal

Mewakili profil perwakilan layanan.
SparkLibraries

Pustaka Spark.
SparkSettings

Pengaturan Spark.
UpdateEnvironmentRequest

Memperbarui permintaan lingkungan.
UserDetails

Detail spesifik perwakilan pengguna. Berlaku ketika jenis utama User.
UserPrincipal

Mewakili prinsipal pengguna Microsoft Entra.

ComponentPublishInfo

Objek

Terbitkan info untuk setiap komponen di lingkungan.

Nama Jenis Deskripsi
sparkLibraries

SparkLibraries

Pustaka Spark menerbitkan informasi.
sparkSettings

SparkSettings

Pengaturan Spark menerbitkan informasi.

EntireTenantPrincipal

Objek

Mewakili perwakilan penyewa

Nama Jenis Deskripsi
displayName

string

Nama tampilan utama.
id

string (uuid)

Id utama.
type string:

EntireTenant

Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.

Environment

Objek

Item Lingkungan.

Nama Jenis Deskripsi
defaultIdentity Principal:

Identitas default item.
description

string

Deskripsi item.
displayName

string

Nama tampilan item.
folderId

string (uuid)

ID folder.
id

string (uuid)

ID item.
logicalId

string (uuid)

Pengidentifikasi logis item. Instans item yang sesuai berbagi ID logis yang sama. Nilai null ketika tidak ada ID logis yang ditetapkan.
properties

EnvironmentProperties

Properti lingkungan.
sensitivityLabel

SensitivityLabel

Label sensitivitas item.
tags

ItemTag[]

Daftar tag yang diterapkan.
type

ItemType

Jenis item.
workspaceId

string (uuid)

ID ruang kerja.

EnvironmentProperties

Objek

Properti lingkungan.

Nama Jenis Deskripsi
publishDetails

PublishDetails

Detail operasi penerbitan lingkungan.

EnvironmentPublishState

Enumerasi

Terbitkan status. Jenis status tambahan dapat ditambahkan dari waktu ke waktu.

Nilai Deskripsi
Success

Penerbitan lingkungan dalam keadaan sukses.
Cancelled

Penerbitan lingkungan dalam status dibatalkan.
Failed

Penerbitan lingkungan dalam status gagal.
Cancelling

Penerbitan lingkungan dalam status pembatalan.
Running

Penerbitan lingkungan dalam status berjalan.
Waiting

Penerbitan lingkungan dalam status menunggu.

ErrorParameter

Objek

Parameter terstruktur yang menyediakan konteks tambahan yang dapat dibaca mesin tentang kesalahan.

Nama Jenis Deskripsi
message

string

Deskripsi yang dapat dibaca manusia tentang arti parameter.
name

string

Pengidentifikasi parameter.
value

string

Nilai parameter.

ErrorRelatedResource

Objek

Objek detail sumber daya terkait kesalahan.

Nama Jenis Deskripsi
resourceId

string

ID sumber daya yang terlibat dalam kesalahan.
resourceType

string

Jenis sumber daya yang terlibat dalam kesalahan.

ErrorResponse

Objek

Respons kesalahan.

Nama Jenis Deskripsi
errorCode

string

Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
isRetriable

boolean

Jika benar, permintaan dapat dicoba kembali. Retry-After Gunakan header respons untuk menentukan penundaan, jika tersedia.
message

string

Representasi kesalahan yang dapat dibaca manusia.
moreDetails

ErrorResponseDetails[]

Daftar detail kesalahan tambahan.
parameters

ErrorParameter[]

Parameter terstruktur menyediakan konteks tambahan yang dapat dibaca mesin tentang kesalahan.
relatedResource

ErrorRelatedResource

Detail sumber daya terkait kesalahan.
requestId

string (uuid)

ID permintaan yang terkait dengan kesalahan.

ErrorResponseDetails

Objek

Detail respons kesalahan.

Nama Jenis Deskripsi
errorCode

string

Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message

string

Representasi kesalahan yang dapat dibaca manusia.
parameters

ErrorParameter[]

Parameter terstruktur menyediakan konteks tambahan yang dapat dibaca mesin tentang kesalahan.
relatedResource

ErrorRelatedResource

Detail sumber daya terkait kesalahan.

GroupDetails

Objek

Mengelompokkan detail spesifik. Berlaku ketika jenis utama Group.

Nama Jenis Deskripsi
groupType

GroupType

Jenis grup. Jenis grup tambahan dapat ditambahkan dari waktu ke waktu.

GroupPrincipal

Objek

Mewakili grup keamanan.

Nama Jenis Deskripsi
displayName

string

Nama tampilan utama.
groupDetails

GroupDetails

Mengelompokkan detail spesifik. Berlaku ketika jenis utama Group.
id

string (uuid)

Id utama.
type string:

Group

Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.

GroupType

Enumerasi

Jenis grup. Jenis grup tambahan dapat ditambahkan dari waktu ke waktu.

Nilai Deskripsi
Unknown

Jenis grup utama tidak diketahui.
SecurityGroup

Prinsipal adalah kelompok keamanan.
DistributionList

Prinsipal adalah daftar distribusi.

ItemTag

Objek

Mewakili tag yang diterapkan pada item.

Nama Jenis Deskripsi
displayName

string

Nama dari tag.
id

string (uuid)

ID tag.

ItemType

Enumerasi

Jenis item. Jenis item tambahan dapat ditambahkan dari waktu ke waktu.

Nilai Deskripsi
Dashboard

Dasbor PowerBI.
Report

Laporan PowerBI.
SemanticModel

Model semantik PowerBI.
PaginatedReport

Laporan paginasi PowerBI.
Datamart

Datamart PowerBI.
Lakehouse

Sebuah lakehouse.
Eventhouse

Sebuah rumah acara.
Environment

Lingkungan.
KQLDatabase

Database KQL.
KQLQueryset

Set kueri KQL.
KQLDashboard

Dasbor KQL.
DataPipeline

Alur data.
Notebook

Buku catatan.
SparkJobDefinition

Definisi pekerjaan spark.
MLExperiment

Eksperimen pembelajaran mesin.
MLModel

Model pembelajaran mesin.
Warehouse

Sebuah gudang.
Eventstream

Eventstream.
SQLEndpoint

Titik akhir SQL.
MirroredWarehouse

Sebuah gudang cermin.
MirroredDatabase

Database cermin.
Reflex

Sebuah Refleks.
GraphQLApi

API untuk item GraphQL.
MountedDataFactory

A MountedDataFactory.
SQLDatabase

Sebuah SQLDatabase.
CopyJob

Pekerjaan Penyalinan.
VariableLibrary

VariabelLibrary.
Dataflow

Aliran Data.
ApacheAirflowJob

An ApacheAirflowJob.
WarehouseSnapshot

Rekam jepret gudang.
DigitalTwinBuilder

Sebuah DigitalTwinBuilder.
DigitalTwinBuilderFlow

Alur Pembangun Kembar Digital.
MirroredAzureDatabricksCatalog

Katalog azure databricks cermin.
Map

Peta.
AnomalyDetector

Detektor Anomali.
UserDataFunction

Fungsi data pengguna.
GraphModel

Sebuah GraphModel.
GraphQuerySet

A Graph QuerySet.
SnowflakeDatabase

Snowflake Database untuk menyimpan tabel Iceberg yang dibuat dari akun Snowflake.
OperationsAgent

A OperationsAgent.
CosmosDBDatabase

Database Cosmos DB.
Ontology

Ontologi.
EventSchemaSet

An EventSchemaSet.
DataAgent

A DataAgent.
MirroredCatalog

A MirroredCatalog.
AppBackend

An AppBackend.
OrgApp

Aplikasi Org.
OrgAppAudience

Audiens Aplikasi Org.
DataBuildToolJob

A DataBuildToolJob.
AzureDatabricksStorage

Item penyimpanan yang didukung OneLake untuk Azure Databricks.
Plan

Sebuah rencana.

PrincipalType

Enumerasi

Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.

Nilai Deskripsi
User

Prinsipal adalah prinsipal pengguna Microsoft Entra.
ServicePrincipal

Perwakilan adalah perwakilan layanan Microsoft Entra.
Group

Prinsipal adalah kelompok keamanan.
ServicePrincipalProfile

Perwakilan adalah profil perwakilan layanan.
EntireTenant

Perwakilan mewakili semua pengguna penyewa.

PublishDetails

Objek

Detail operasi penerbitan.

Nama Jenis Deskripsi
componentPublishInfo

ComponentPublishInfo

Komponen lingkungan menerbitkan informasi.
endTime

string (date-time)

Waktu akhir operasi penerbitan dalam UTC, menggunakan format YYYY-MM-DDTHH:mm:ss.sssssssZ.
startTime

string (date-time)

Waktu mulai operasi penerbitan dalam UTC, menggunakan format YYYY-MM-DDTHH:mm:ss.sssssZ.
state

EnvironmentPublishState

Terbitkan status. Jenis status tambahan dapat ditambahkan dari waktu ke waktu.
targetVersion

string (uuid)

Verifikasi target yang akan diterbitkan.

SensitivityLabel

Objek

Mewakili label sensitivitas yang diterapkan ke item.

Nama Jenis Deskripsi
id

string (uuid)

ID label sensitivitas.

ServicePrincipalDetails

Objek

Detail spesifik perwakilan layanan. Berlaku ketika jenis utama ServicePrincipal.

Nama Jenis Deskripsi
aadAppId

string (uuid)

AppId Microsoft Entra perwakilan layanan.

ServicePrincipalPrincipal

Objek

Mewakili perwakilan layanan Microsoft Entra.

Nama Jenis Deskripsi
displayName

string

Nama tampilan utama.
id

string (uuid)

Id utama.
servicePrincipalDetails

ServicePrincipalDetails

Detail spesifik perwakilan layanan. Berlaku ketika jenis utama ServicePrincipal.
type string:

ServicePrincipal

Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.

ServicePrincipalProfileDetails

Objek

Detail profil perwakilan layanan. Berlaku ketika jenis utama ServicePrincipalProfile.

Nama Jenis Deskripsi
parentPrincipal Principal:

Perwakilan induk profil perwakilan layanan.

ServicePrincipalProfilePrincipal

Objek

Mewakili profil perwakilan layanan.

Nama Jenis Deskripsi
displayName

string

Nama tampilan utama.
id

string (uuid)

Id utama.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Detail profil perwakilan layanan. Berlaku ketika jenis utama ServicePrincipalProfile.
type string:

ServicePrincipalProfile

Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.

SparkLibraries

Objek

Pustaka Spark.

Nama Jenis Deskripsi
state

EnvironmentPublishState

Terbitkan status. Jenis status tambahan dapat ditambahkan dari waktu ke waktu.

SparkSettings

Objek

Pengaturan Spark.

Nama Jenis Deskripsi
state

EnvironmentPublishState

Terbitkan status. Jenis status tambahan dapat ditambahkan dari waktu ke waktu.

UpdateEnvironmentRequest

Objek

Memperbarui permintaan lingkungan.

Nama Jenis Deskripsi
description

string

Deskripsi lingkungan. Panjang maksimum adalah 256 karakter.
displayName

string

Nama tampilan lingkungan.

UserDetails

Objek

Detail spesifik perwakilan pengguna. Berlaku ketika jenis utama User.

Nama Jenis Deskripsi
userPrincipalName

string

Nama prinsipal pengguna.

UserPrincipal

Objek

Mewakili prinsipal pengguna Microsoft Entra.

Nama Jenis Deskripsi
displayName

string

Nama tampilan utama.
id

string (uuid)

Id utama.
type string:

User

Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.
userDetails

UserDetails

Detail spesifik perwakilan pengguna. Berlaku ketika jenis utama User.