Bagikan melalui

Domains - Update Domain

  • Referensi
Layanan:
Admin
Versi API:
v1

Nota

API ini dalam pratinjau.

Memperbarui info domain yang ditentukan.

Izin

Pemanggil harus menjadi administrator Fabric.

Cakupan yang Didelegasikan yang Diperlukan

Tenant.ReadWrite.All.

Keterbatasan

Maksimum 25 permintaan per satu menit per prinsipal.

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/admin/domains/{domainId}

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
domainId
 path True

string

uuid

ID domain.

Isi Permintaan

Nama Jenis Deskripsi
contributorsScope

ContributorsScopeType

Cakupan kontributor domain.
description

string

Deskripsi domain. Deskripsi tidak boleh berisi lebih dari 256 karakter.
displayName

string

Nama tampilan domain. Nama tampilan tidak boleh berisi lebih dari 40 karakter.

Respons

Nama Jenis Deskripsi
200 OK

Domain

Permintaan berhasil diselesaikan.
Other Status Codes

ErrorResponse

Kode kesalahan umum:

  • UnknownError - Terjadi kesalahan.

  • EntityConflict - Domain pembaruan gagal karena nama tampilan domain sudah ada.

Contoh

Update a domain example

Permintaan sampel

PATCH https://api.fabric.microsoft.com/v1/admin/domains/97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f

{
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "contributorsScope": "SpecificUsersAndGroups"
}

Respon sampel

Kode status:
200 
{
  "id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "parentDomainId": null,
  "contributorsScope": "SpecificUsersAndGroups"
}

Definisi

Nama Deskripsi
ContributorsScopeType

Cakupan kontributor. Cakupan kontributor tambahan dapat ditambahkan dari waktu ke waktu.
Domain

Mewakili domain atau subdomain.
ErrorRelatedResource

Objek detail sumber daya terkait kesalahan.
ErrorResponse

Respons kesalahan.
ErrorResponseDetails

Detail respons kesalahan.
UpdateDomainRequest

Payload permintaan untuk memperbarui domain.

ContributorsScopeType

Enumeration

Cakupan kontributor. Cakupan kontributor tambahan dapat ditambahkan dari waktu ke waktu.

Nilai Deskripsi
AdminsOnly

Hanya admin penyewa dan domain.
AllTenant

Semua pengguna penyewa.
SpecificUsersAndGroups

Pengguna dan grup tertentu.

Domain

Objek

Mewakili domain atau subdomain.

Nama Jenis Deskripsi
contributorsScope

ContributorsScopeType

Cakupan kontributor domain.
description

string

Deskripsi domain.
displayName

string

Nama domain.
id

string

uuid

ID objek domain.
parentDomainId

string

uuid

ID objek induk domain.

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.

UpdateDomainRequest

Objek

Payload permintaan untuk memperbarui domain.

Nama Jenis Deskripsi
contributorsScope

ContributorsScopeType

Cakupan kontributor domain.
description

string

Deskripsi domain. Deskripsi tidak boleh berisi lebih dari 256 karakter.
displayName

string

Nama tampilan domain. Nama tampilan tidak boleh berisi lebih dari 40 karakter.