Domains - Update Domain
手記
この API はプレビュー段階です。
指定したドメイン情報を更新します。
権限
呼び出し元は Fabric 管理者である必要があります。
必要な委任されたスコープ
Tenant.ReadWrite.All。
制限
プリンシパルあたり 1 分あたり最大 25 個の要求。
Microsoft Entra でサポートされている ID
この API では、このセクションに記載されている Microsoft ID がサポートされています。
同一性 | 支える |
---|---|
利用者 | はい |
サービス プリンシパルの とマネージド ID の | はい |
インターフェイス
PATCH https://api.fabric.microsoft.com/v1/admin/domains/{domainId}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
domain
|
path | True |
string uuid |
ドメイン ID。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
contributorsScope |
ドメイン共同作成者のスコープ。 |
|
description |
string |
ドメインの説明。 説明には、256 文字を超える文字を含めることはできません。 |
displayName |
string |
ドメインの表示名。 表示名には 40 文字を超えることはできません。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
要求は正常に完了しました。 |
|
Other Status Codes |
一般的なエラー コード:
|
例
Update a domain example
要求のサンプル
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"
}
応答のサンプル
{
"id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
"displayName": "Domain's new name",
"description": "Domain's new description",
"parentDomainId": null,
"contributorsScope": "SpecificUsersAndGroups"
}
定義
名前 | 説明 |
---|---|
Contributors |
共同作成者スコープ。 追加の共同作成者スコープは、時間の経過と同時に追加される場合があります。 |
Domain |
ドメインまたはサブドメインを表します。 |
Error |
エラー関連のリソース詳細オブジェクト。 |
Error |
エラー応答。 |
Error |
エラー応答の詳細。 |
Update |
ドメインを更新するための要求ペイロード。 |
ContributorsScopeType
共同作成者スコープ。 追加の共同作成者スコープは、時間の経過と同時に追加される場合があります。
値 | 説明 |
---|---|
AdminsOnly |
テナント管理者とドメイン管理者のみ。 |
AllTenant |
テナントのすべてのユーザー。 |
SpecificUsersAndGroups |
特定のユーザーとグループ。 |
Domain
ドメインまたはサブドメインを表します。
名前 | 型 | 説明 |
---|---|---|
contributorsScope |
ドメイン共同作成者のスコープ。 |
|
description |
string |
ドメインの説明。 |
displayName |
string |
ドメインの名前。 |
id |
string uuid |
ドメイン オブジェクト ID。 |
parentDomainId |
string uuid |
ドメイン親オブジェクト ID。 |
ErrorRelatedResource
エラー関連のリソース詳細オブジェクト。
名前 | 型 | 説明 |
---|---|---|
resourceId |
string |
エラーに関係するリソース ID。 |
resourceType |
string |
エラーに関係するリソースの種類。 |
ErrorResponse
エラー応答。
名前 | 型 | 説明 |
---|---|---|
errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
message |
string |
エラーの人間が判読できる表現。 |
moreDetails |
その他のエラーの詳細の一覧。 |
|
relatedResource |
エラー関連のリソースの詳細。 |
|
requestId |
string |
エラーに関連付けられている要求の ID。 |
ErrorResponseDetails
エラー応答の詳細。
名前 | 型 | 説明 |
---|---|---|
errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
message |
string |
エラーの人間が判読できる表現。 |
relatedResource |
エラー関連のリソースの詳細。 |
UpdateDomainRequest
ドメインを更新するための要求ペイロード。
名前 | 型 | 説明 |
---|---|---|
contributorsScope |
ドメイン共同作成者のスコープ。 |
|
description |
string |
ドメインの説明。 説明には、256 文字を超える文字を含めることはできません。 |
displayName |
string |
ドメインの表示名。 表示名には 40 文字を超えることはできません。 |