Bagikan melalui

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

Identitas yang didukung Microsoft Entra

API ini mendukung identitas Microsoft yang tercantum di bagian ini.

Identitas Dukung
Pengguna Ya
perwakilan 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.
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.
Environment

Item Lingkungan.
EnvironmentProperties

Properti lingkungan.
EnvironmentPublishState

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

Objek detail sumber daya terkait kesalahan.
ErrorResponse

Respons kesalahan.
ErrorResponseDetails

Detail respons kesalahan.
ItemTag

Mewakili tag yang diterapkan pada item.
ItemType

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

Detail operasi penerbitan.
SparkLibraries

Pustaka Spark.
SparkSettings

Pengaturan Spark.
UpdateEnvironmentRequest

Memperbarui permintaan lingkungan.

ComponentPublishInfo

Objek

Terbitkan info untuk setiap komponen di lingkungan.

Nama Jenis Deskripsi
sparkLibraries

SparkLibraries

Pustaka Spark menerbitkan informasi.
sparkSettings

SparkSettings

Pengaturan Spark menerbitkan informasi.

Environment

Objek

Item Lingkungan.

Nama Jenis Deskripsi
description

string

Deskripsi item.
displayName

string

Nama tampilan item.
folderId

string (uuid)

ID folder.
id

string (uuid)

ID item.
properties

EnvironmentProperties

Properti lingkungan.
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.

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

string

Representasi kesalahan yang dapat dibaca manusia.
moreDetails

ErrorResponseDetails[]

Daftar detail kesalahan tambahan.
relatedResource

ErrorRelatedResource

Detail sumber daya terkait kesalahan.
requestId

string

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

ErrorRelatedResource

Detail sumber daya terkait kesalahan.

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.

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.

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.