Tenants - Update Tenant Setting

บริการ:: Admin

เวอร์ชัน API:: v1

อัปเดตการตั้งค่าผู้เช่าที่กําหนด

Permissions

ผู้เรียกต้องเป็นผู้ดูแลระบบ Fabric หรือรับรองความถูกต้องโดยใช้โครงร่างสําคัญของบริการ

จําเป็นต้องมีขอบเขตที่ได้รับมอบสิทธิ์

Tenant.ReadWrite.All

Limitations

สูงสุด 25 คําขอต่อนาที

ข้อมูลประจําตัวที่สนับสนุนของ Microsoft Entra

API นี้สนับสนุนข้อมูลประจําตัวของ Microsoft แสดงรายการในส่วนนี้

Identity	Support
User	Yes
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ	Yes

Interface

POST https://api.fabric.microsoft.com/v1/admin/tenantsettings/{tenantSettingName}/update

พารามิเตอร์ URI

ชื่อ	ใน	จำเป็น	พิมพ์	คำอธิบาย
tenantSettingName	path	True	string	ชื่อของการตั้งค่าผู้เช่า

เนื้อความของคำขอ

ชื่อ	จำเป็น	พิมพ์	คำอธิบาย
enabled	True	boolean	สถานะของการตั้งค่าผู้เช่า False - ปิดใช้งาน จริง - เปิดใช้งาน
delegateToCapacity		boolean	ระบุว่าการตั้งค่าผู้เช่าสามารถมอบหมายให้กับผู้ดูแลความจุ False - ผู้ดูแลระบบความจุไม่สามารถแทนที่การตั้งค่าผู้เช่าได้หรือไม่ True - ผู้ดูแลระบบความจุสามารถแทนที่การตั้งค่าผู้เช่าได้
delegateToDomain		boolean	ระบุว่าการตั้งค่าผู้เช่าสามารถมอบสิทธิ์ให้กับผู้ดูแลระบบโดเมนได้หรือไม่ เท็จ - ผู้ดูแลระบบโดเมนไม่สามารถแทนที่การตั้งค่าผู้เช่าได้ True - ผู้ดูแลระบบโดเมนสามารถแทนที่การตั้งค่าผู้เช่าได้
delegateToWorkspace		boolean	ระบุว่าการตั้งค่าผู้เช่าสามารถมอบสิทธิ์ให้กับผู้ดูแลระบบพื้นที่ทํางานได้หรือไม่ เท็จ - ผู้ดูแลระบบพื้นที่ทํางานไม่สามารถแทนที่การตั้งค่าผู้เช่าได้ True - ผู้ดูแลระบบพื้นที่ทํางานสามารถแทนที่การตั้งค่าผู้เช่าได้
enabledSecurityGroups		TenantSettingSecurityGroup[]	รายการกลุ่มความปลอดภัยที่เปิดใช้งาน
excludedSecurityGroups		TenantSettingSecurityGroup[]	รายการกลุ่มความปลอดภัยที่ถูกแยกออก
properties		TenantSettingProperty[]	คุณสมบัติการตั้งค่าผู้เช่า

การตอบสนอง

ชื่อ พิมพ์ คำอธิบาย

200 OK

ชื่อ	พิมพ์	คำอธิบาย
200 OK	UpdateTenantSettingResponse	OK. การดําเนินการสําเร็จ
429 Too Many Requests	ErrorResponse	เกินขีดจํากัดอัตราการบริการ เซิร์ฟเวอร์จะส่งกลับ `Retry-After` ส่วนหัวที่ระบุ ภายในไม่กี่วินาที ระยะเวลาที่ไคลเอ็นต์ต้องรอก่อนที่จะส่งคําขอเพิ่มเติม ส่วนหัว Retry-After: integer
Other Status Codes	ErrorResponse	รหัสข้อผิดพลาดทั่วไป: ห้าม - ผู้เรียกไม่มีสิทธิ์ในการเรียกใช้ API

UpdateTenantSettingResponse

OK. การดําเนินการสําเร็จ

429 Too Many Requests

ErrorResponse

เกินขีดจํากัดอัตราการบริการ เซิร์ฟเวอร์จะส่งกลับ Retry-After ส่วนหัวที่ระบุ ภายในไม่กี่วินาที ระยะเวลาที่ไคลเอ็นต์ต้องรอก่อนที่จะส่งคําขอเพิ่มเติม

ส่วนหัว

Retry-After: integer

Other Status Codes

ErrorResponse

รหัสข้อผิดพลาดทั่วไป:

ห้าม - ผู้เรียกไม่มีสิทธิ์ในการเรียกใช้ API

ตัวอย่าง

Update tenant setting example

คำขอตัวอย่าง

HTTP

POST https://api.fabric.microsoft.com/v1/admin/tenantsettings/PublishToWeb/update

{
  "enabled": true,
  "enabledSecurityGroups": [
    {
      "graphId": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
      "name": "TestComputeCdsa"
    }
  ],
  "properties": [
    {
      "name": "CreateP2w",
      "value": "true",
      "type": "Boolean"
    }
  ]
}

คำตอบตัวอย่าง

รหัสสถานะ:: 200

{
  "tenantSettings": [
    {
      "settingName": "PublishToWeb",
      "title": "Sample test tenant setting",
      "enabled": true,
      "canSpecifySecurityGroups": true,
      "enabledSecurityGroups": [
        {
          "graphId": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
          "name": "TestComputeCdsa"
        }
      ],
      "properties": [
        {
          "name": "CreateP2w",
          "value": "true",
          "type": "Boolean"
        }
      ],
      "tenantSettingGroup": "TestSetting"
    }
  ]
}

คำจำกัดความ

ชื่อ	คำอธิบาย
ErrorParameter	พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด
ErrorRelatedResource	ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse	การตอบสนองข้อผิดพลาด
ErrorResponseDetails	รายละเอียดการตอบสนองข้อผิดพลาด
TenantSetting	รายละเอียดการตั้งค่าระดับผู้เช่า
TenantSettingProperty	คุณสมบัติการตั้งค่าผู้เช่า
TenantSettingPropertyType	ชนิดของคุณสมบัติการตั้งค่าผู้เช่า อาจมีการเพิ่มชนิดคุณสมบัติการตั้งค่าผู้เช่าเพิ่มเติมเมื่อเวลาผ่านไป
TenantSettingSecurityGroup	กลุ่มความปลอดภัยการตั้งค่าผู้เช่า
UpdateTenantSettingRequest	คําขออัปเดตการตั้งค่าผู้เช่า
UpdateTenantSettingResponse	การตั้งค่าผู้เช่าอัปเดตการตอบสนอง

ErrorParameter

วัตถุ

พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด

ชื่อ	พิมพ์	คำอธิบาย
message	string	คําอธิบายที่มนุษย์สามารถอ่านได้ของความหมายของพารามิเตอร์
name	string	ตัวระบุพารามิเตอร์
value	string	ค่าพารามิเตอร์

ErrorRelatedResource

วัตถุ

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ชื่อ	พิมพ์	คำอธิบาย
resourceId	string	ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
resourceType	string	ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

วัตถุ

การตอบสนองข้อผิดพลาด

ชื่อ	พิมพ์	คำอธิบาย
errorCode	string	ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
isRetriable	boolean	เมื่อเป็นจริง สามารถลองคําขอใหม่ได้ ใช้ส่วนหัวการตอบสนอง `Retry-After` เพื่อกําหนดความล่าช้า ถ้ามี
message	string	การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
moreDetails	ErrorResponseDetails[]	รายการรายละเอียดข้อผิดพลาดเพิ่มเติม
parameters	ErrorParameter[]	พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด
relatedResource	ErrorRelatedResource	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
requestId	string (uuid)	รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponseDetails

วัตถุ

รายละเอียดการตอบสนองข้อผิดพลาด

ชื่อ	พิมพ์	คำอธิบาย
errorCode	string	ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message	string	การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
parameters	ErrorParameter[]	พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด
relatedResource	ErrorRelatedResource	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

TenantSetting

วัตถุ

รายละเอียดการตั้งค่าระดับผู้เช่า

ชื่อ	พิมพ์	คำอธิบาย
canSpecifySecurityGroups	boolean	ระบุว่าการตั้งค่าผู้เช่าจะเปิดใช้งานสําหรับกลุ่มความปลอดภัยหรือไม่ False - การตั้งค่าผู้เช่าจะเปิดใช้งานสําหรับทั้งองค์กร True - การตั้งค่าผู้เช่าจะเปิดใช้งานสําหรับกลุ่มความปลอดภัย
delegateToCapacity	boolean	ระบุว่าการตั้งค่าผู้เช่าสามารถมอบหมายให้กับผู้ดูแลความจุ False - ผู้ดูแลระบบความจุไม่สามารถแทนที่การตั้งค่าผู้เช่าได้หรือไม่ True - ผู้ดูแลระบบความจุสามารถแทนที่การตั้งค่าผู้เช่าได้
delegateToDomain	boolean	ระบุว่าการตั้งค่าผู้เช่าสามารถมอบสิทธิ์ให้กับผู้ดูแลระบบโดเมนได้หรือไม่ เท็จ - ผู้ดูแลระบบโดเมนไม่สามารถแทนที่การตั้งค่าผู้เช่าได้ True - ผู้ดูแลระบบโดเมนสามารถแทนที่การตั้งค่าผู้เช่าได้
delegateToWorkspace	boolean	ระบุว่าการตั้งค่าผู้เช่าสามารถมอบสิทธิ์ให้กับผู้ดูแลระบบพื้นที่ทํางานได้หรือไม่ เท็จ - ผู้ดูแลระบบพื้นที่ทํางานไม่สามารถแทนที่การตั้งค่าผู้เช่าได้ True - ผู้ดูแลระบบพื้นที่ทํางานสามารถแทนที่การตั้งค่าผู้เช่าได้
enabled	boolean	สถานะของการตั้งค่าผู้เช่า False - ปิดใช้งาน จริง - เปิดใช้งาน
enabledSecurityGroups	TenantSettingSecurityGroup[]	รายการกลุ่มความปลอดภัยที่เปิดใช้งาน
excludedSecurityGroups	TenantSettingSecurityGroup[]	รายการกลุ่มความปลอดภัยที่ถูกแยกออก
properties	TenantSettingProperty[]	คุณสมบัติการตั้งค่าผู้เช่า
settingName	string	ชื่อของการตั้งค่าผู้เช่า
tenantSettingGroup	string	ชื่อกลุ่มการตั้งค่าผู้เช่า
title	string	ชื่อของการตั้งค่าผู้เช่า

TenantSettingProperty

วัตถุ

คุณสมบัติการตั้งค่าผู้เช่า

ชื่อ	พิมพ์	คำอธิบาย
name	string	ชื่อของคุณสมบัติ
type	TenantSettingPropertyType	ชนิดของคุณสมบัติ
value	string	ค่าของคุณสมบัติ

TenantSettingPropertyType

การแจงนับ

ชนิดของคุณสมบัติการตั้งค่าผู้เช่า อาจมีการเพิ่มชนิดคุณสมบัติการตั้งค่าผู้เช่าเพิ่มเติมเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
FreeText	UI ยอมรับสตริงใด ๆ สําหรับกล่องข้อความ
Url	UI ยอมรับเฉพาะ URL สําหรับกล่องข้อความ
Boolean	กล่องกาเครื่องหมายใน UI
MailEnabledSecurityGroup	UI ยอมรับเฉพาะกลุ่มความปลอดภัยที่เปิดใช้งานอีเมลสําหรับกล่องข้อความ
Integer	UI ยอมรับเฉพาะจํานวนเต็มสําหรับกล่องข้อความ

TenantSettingSecurityGroup

วัตถุ

กลุ่มความปลอดภัยการตั้งค่าผู้เช่า

ชื่อ	พิมพ์	คำอธิบาย
graphId	string	รหัสกราฟของกลุ่มความปลอดภัย
name	string	ชื่อของกลุ่มความปลอดภัย

UpdateTenantSettingRequest

วัตถุ

คําขออัปเดตการตั้งค่าผู้เช่า

ชื่อ	พิมพ์	คำอธิบาย
delegateToCapacity	boolean	ระบุว่าการตั้งค่าผู้เช่าสามารถมอบหมายให้กับผู้ดูแลความจุ False - ผู้ดูแลระบบความจุไม่สามารถแทนที่การตั้งค่าผู้เช่าได้หรือไม่ True - ผู้ดูแลระบบความจุสามารถแทนที่การตั้งค่าผู้เช่าได้
delegateToDomain	boolean	ระบุว่าการตั้งค่าผู้เช่าสามารถมอบสิทธิ์ให้กับผู้ดูแลระบบโดเมนได้หรือไม่ เท็จ - ผู้ดูแลระบบโดเมนไม่สามารถแทนที่การตั้งค่าผู้เช่าได้ True - ผู้ดูแลระบบโดเมนสามารถแทนที่การตั้งค่าผู้เช่าได้
delegateToWorkspace	boolean	ระบุว่าการตั้งค่าผู้เช่าสามารถมอบสิทธิ์ให้กับผู้ดูแลระบบพื้นที่ทํางานได้หรือไม่ เท็จ - ผู้ดูแลระบบพื้นที่ทํางานไม่สามารถแทนที่การตั้งค่าผู้เช่าได้ True - ผู้ดูแลระบบพื้นที่ทํางานสามารถแทนที่การตั้งค่าผู้เช่าได้
enabled	boolean	สถานะของการตั้งค่าผู้เช่า False - ปิดใช้งาน จริง - เปิดใช้งาน
enabledSecurityGroups	TenantSettingSecurityGroup[]	รายการกลุ่มความปลอดภัยที่เปิดใช้งาน
excludedSecurityGroups	TenantSettingSecurityGroup[]	รายการกลุ่มความปลอดภัยที่ถูกแยกออก
properties	TenantSettingProperty[]	คุณสมบัติการตั้งค่าผู้เช่า

UpdateTenantSettingResponse

วัตถุ

การตั้งค่าผู้เช่าอัปเดตการตอบสนอง

ชื่อ	พิมพ์	คำอธิบาย
tenantSettings	TenantSetting[]	รายการการตั้งค่าผู้เช่าที่มีการอัปเดต