แชร์ผ่าน

Tenants - List Tenant Settings

บริการ:
Admin
เวอร์ชัน API:
v1

แสดงรายการการตั้งค่าผู้เช่า

สิทธิ์

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

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

Tenant.Read.All หรือ Tenant.ReadWrite.All

ข้อจำกัด

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

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

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

เอกลักษณ์ การสนับสนุน
ผู้ใช้ ใช่
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ ใช่

อินเตอร์เฟซ

GET https://api.fabric.microsoft.com/v1/admin/tenantsettings
ด้วยพารามิเตอร์ที่เลือกได้: 
GET https://api.fabric.microsoft.com/v1/admin/tenantsettings?continuationToken={continuationToken}

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

ชื่อ ใน จำเป็น พิมพ์ คำอธิบาย
continuationToken
 query

string

โทเค็นสําหรับการเรียกใช้หน้าถัดไปของผลลัพธ์

การตอบสนอง

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

TenantSettings

ตกลง, ได้ การดําเนินการสําเร็จ
Other Status Codes

ErrorResponse

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

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

ตัวอย่าง

List tenant settings example

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

GET https://api.fabric.microsoft.com/v1/admin/tenantsettings

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

รหัสสถานะ:
200 
{
  "value": [
    {
      "settingName": "AdminApisIncludeDetailedMetadata",
      "title": "Enhance admin APIs responses with detailed metadata",
      "enabled": true,
      "canSpecifySecurityGroups": true,
      "tenantSettingGroup": "AdminApiSettings"
    },
    {
      "settingName": "DatamartTenant",
      "title": "Create Datamarts (Preview)",
      "enabled": true,
      "canSpecifySecurityGroups": true,
      "enabledSecurityGroups": [
        {
          "graphId": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
          "name": "TestComputeCdsa"
        },
        {
          "graphId": "1fecf19f-6e33-41b3-89fa-de8c821f3b79",
          "name": "TestComputeGroup2"
        },
        {
          "graphId": "64bc10f1-1f1b-4a7e-b7a0-c87d89cba2b4",
          "name": "TestCertifiers"
        }
      ],
      "tenantSettingGroup": "DatamartSettings"
    },
    {
      "settingName": "CertifyDatasets",
      "title": "Certification",
      "enabled": true,
      "canSpecifySecurityGroups": true,
      "tenantSettingGroup": "ExportAndSharing"
    }
  ]
}

คำจำกัดความ

ชื่อ คำอธิบาย
ErrorRelatedResource

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

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

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

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

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

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

รายการการตั้งค่าผู้เช่า
TenantSettingSecurityGroup

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

ErrorRelatedResource

ออบเจ็กต์

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

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

string

ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
resourceType

string

ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

ออบเจ็กต์

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

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

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
moreDetails

ErrorResponseDetails[]

รายการรายละเอียดข้อผิดพลาดเพิ่มเติม
relatedResource

ErrorRelatedResource

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

string

รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponseDetails

ออบเจ็กต์

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

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

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
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 ยอมรับเฉพาะจํานวนเต็มสําหรับกล่องข้อความ

TenantSettings

ออบเจ็กต์

รายการการตั้งค่าผู้เช่า

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

string

โทเค็นสําหรับชุดผลลัพธ์ชุดถัดไป ถ้าไม่มีระเบียนเพิ่มเติม จะถูกลบออกจากการตอบสนอง
continuationUri

string

URI ของชุดงานชุดผลลัพธ์ถัดไป ถ้าไม่มีระเบียนเพิ่มเติม จะถูกลบออกจากการตอบสนอง
value

TenantSetting[]

รายการการตั้งค่าผู้เช่า

TenantSettingSecurityGroup

ออบเจ็กต์

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

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

string

รหัสกราฟของกลุ่มความปลอดภัย
name

string

ชื่อของกลุ่มความปลอดภัย