Domains - Get Domain

サービス:

Core

API バージョン:

v1

指定したドメイン情報を返します。

必要な委任されたスコープ

Domain.Read.All

Microsoft Entra でサポートされている ID

この API では、このセクションに記載されている Microsoft ID がサポートされています。

アイデンティティ	Support
User	イエス
サービス プリンシパルとマネージド ID	イエス

インターフェイス

GET https://api.fabric.microsoft.com/v1/domains/{domainId}

URI パラメーター

名前	/	必須	型	説明
domainId	path	True	string (uuid)	ドメイン ID。

応答

名前	型	説明
200 OK	Domain	要求は成功しました。
429 Too Many Requests	ErrorResponse	サービス レートの制限を超えました。 サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す Retry-After ヘッダーを返します。 ヘッダー Retry-After: integer
Other Status Codes	ErrorResponse	一般的なエラー コード: DomainNotFound - 指定されたドメインが見つかりませんでした UnknownError - エラーが発生しました

例

Get domain example

要求のサンプル

HTTP

GET https://api.fabric.microsoft.com/v1/domains/20acb9a8-d54a-4ecd-ae60-27fc226668b6

応答のサンプル

状態コード:

200

{
  "id": "20acb9a8-d54a-4ecd-ae60-27fc226668b6",
  "displayName": "Finance",
  "description": "This domain is used for identifying financial data and reports.",
  "parentDomainId": "541488c9-eb1f-4ee1-8997-10bb2fe6d58c"
}

定義

名前	説明
Domain	ドメインを表します。
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。

Domain

Object

ドメインを表します。

名前	型	説明
description	string	ドメインの説明。
displayName	string	ドメインの名前。
id	string (uuid)	ドメイン ID。
parentDomainId	string (uuid)	サブドメインの親ドメイン ID。

ErrorRelatedResource

Object

エラー関連のリソース詳細オブジェクト。

名前	型	説明
resourceId	string	エラーに関係するリソース ID。
resourceType	string	エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が判読できる表現。
moreDetails	ErrorResponseDetails[]	その他のエラーの詳細の一覧。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。
requestId	string (uuid)	エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が判読できる表現。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。