ドメイン リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
テナントに関連付けられているドメインを表します。
ドメイン操作を使用して、ドメインをテナントに関連付け、ドメインの所有権を確認し、サポートされているサービスを構成します。 ドメイン操作を使用して、ドメインをテナントに関連付け、ドメインの所有権を確認し、サポートされているサービスを構成します。 Microsoft Graph を使用してドメインを確認しても、Exchange などのOffice 365 サービスで使用するドメインは構成されません。 Microsoft 365 製品と連携するようにドメインを完全に構成するには、追加の手順が必要になる場合があります。 詳細については、「 Microsoft 365 管理者セットアップ」を参照してください。
ドメインをテナントに関連付けるには:
ドメインをテナントに関連付けます。
ドメイン検証レコードを取得します。 ドメイン レジストラーまたはドメイン ネーム システム (DNS) サーバー構成を使用して、検証レコードの詳細をドメインのゾーン ファイルに追加します。
ドメインの所有権を確認し、isVerified プロパティを
trueに設定します。ドメインで使用する予定のサポートされているサービスを示します。
ドメインのサービスを有効にするために必要なレコードの一覧を取得して、サポートされているサービスを構成します。 ドメイン レジストラーまたは DNS サーバー構成を使用して、構成レコードの詳細をドメインのゾーン ファイルに追加します。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| List | domain | テナントにリンクされているすべてのドメインを取得します。 |
| Create | domain | テナントにドメインを追加します。 |
| Get | domain | ドメイン オブジェクトのプロパティとリレーションシップを読み取ります。 |
| Update | domain | ドメインを更新します。 |
| Delete | なし | ドメインを削除します。 |
| 強制的に削除する | なし | 非同期操作を使用してドメインを削除します。 |
| 検証する | domain | ドメインの所有権を検証します。 |
| 昇格 | ブール型 | 確認済みのサブドメインをルート ドメインに昇格させます。 |
| ルート ドメインを取得する | サブドメインのルート ドメインを取得します。 | |
| ドメイン名の参照を一覧表示する | directoryObject コレクション | ドメインへの参照を含むディレクトリ オブジェクトの一覧を取得します。 |
| サービス構成レコードを一覧表示する | domainDnsRecord コレクション | ドメイン構成のドメイン DNS レコードの一覧を取得します。 |
| 検証 DNS レコードを一覧表示する | domainDnsRecord コレクション | ドメイン検証用のドメイン DNS レコードの一覧を取得します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| authenticationType | String | ドメインに対して構成されている認証の種類を示します。 値は Managed または Federatedです。
Managedは、Microsoft Entra IDがユーザー認証を実行するクラウド マネージド ドメインを示します。
Federatedは、認証が、Active Directory フェデレーション サービス (AD FS)経由でテナントのオンプレミスの Active Directoryなどの ID プロバイダーとフェデレーションされていることを示します。 null 許容ではありません。 委任されたシナリオでこのプロパティを更新するには、呼び出し元のアプリに Directory.AccessAsUser.All 委任されたアクセス許可を割り当てる必要があります。 |
| availabilityStatus | String | 検証アクションが使用されている場合を除き、このプロパティは常にnullされます。
検証アクションを使用すると、応答でドメイン エンティティが返されます。 応答のドメイン エンティティの availabilityStatus プロパティは、AvailableImmediatelyまたはEmailVerifiedDomainTakeoverScheduledです。 |
| id | String | ドメインの完全修飾名。 キー、不変、null 許容ではない、一意。 |
| isAdminManaged | ブール型 | ドメインの DNS レコード管理が Microsoft 365 に委任されている場合、プロパティの値は false されます。 それ以外の場合、値は trueされます。 null 許容ではありません。 |
| isDefault | ブール型 |
true は、ユーザーの作成に使用される既定のドメインに対してです。 会社ごとに既定のドメインは 1 つだけです。 null 許容ではありません。 |
| isInitial | ブール型 |
true Microsoft Online Services によって作成された初期ドメインの場合。 たとえば、「 contoso.onmicrosoft.com 」のように入力します。 会社ごとに最初のドメインは 1 つだけです。 null 許容ではありません。 |
| isRoot | ブール型 |
true ドメインが検証済みルート ドメインの場合。 それ以外の場合は、ドメインがサブドメインまたは未検証の場合に false します。 null 許容ではありません。 |
| isVerified | ブール型 |
true 検証済みドメインの場合。 null 許容ではありません。 |
| passwordNotificationWindowInDays | Int32 | ユーザーがパスワードの有効期限の通知を受け取るまでの日数を指定します。 既定では 14 日。 |
| passwordValidityPeriodInDays | Int32 | パスワードを変更する前に有効な時間の長さを指定します。 既定では 90 日。 |
| supportedServices | String collection | ドメインに割り当てられた機能。
Email、Sharepoint、EmailInternalRelayOnly、OfficeCommunicationsOnline、SharePointDefaultDomain、FullRedelegation、SharePointPublic、OrgIdAuthentication、Yammer、Intune、CustomUrlDomainなど、0、1、または複数の値を含めることができます。 API を使用して追加または削除できる値は、 Email、 OfficeCommunicationsOnline、 Yammer、 CustomUrlDomainです。 null 許容ではありません。 CustomUrlDomainの詳細については、「外部テナントのカスタム URL ドメイン」を参照してください。 |
| state | domainState | ドメインに対してスケジュールされた非同期操作の状態。 |
リレーションシップ
ドメインとディレクトリ内の他のオブジェクト (検証レコードやサービス構成レコードなど) 間のリレーションシップは、ナビゲーション プロパティを介して公開されます。 これらのリレーションシップは、要求でこれらのナビゲーション プロパティをターゲットにすることで読み取ることができます。
| リレーションシップ | 型 | 説明 |
|---|---|---|
| domainNameReferences | directoryObject コレクション | ドメイン ID を参照するユーザーやグループなどのオブジェクト。 読み取り専用、Null 許容。
$expand はサポートしていません。 返されるオブジェクトの OData 型による $filter をサポートします。 たとえば、/domains/{domainId}/domainNameReferences/microsoft.graph.user および /domains/{domainId}/domainNameReferences/microsoft.graph.group などです。 |
| serviceConfigurationRecords | domainDnsRecord コレクション | ドメインを Microsoft Online サービスで使用する前に、顧客がドメインの DNS ゾーン ファイルに追加した DNS レコード。 読み取り専用、Null 許容。
$expand はサポートしていません。 |
| verificationDnsRecords | domainDnsRecord コレクション | 顧客がMicrosoft Entra IDでドメイン所有権の検証を完了する前に、顧客がドメインの DNS ゾーン ファイルに追加する DNS レコード。 読み取り専用、Null 許容。
$expand はサポートしていません。 |
| federationConfiguration | internalDomainFederation | Microsoft Entra IDとのフェデレーション時に顧客によって構成されたドメイン設定。
$expand はサポートしていません。 |
| rootDomain | domain | サブドメインのルート ドメイン。 読み取り専用、Null 許容。
$expand をサポートします。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"authenticationType": "String",
"availabilityStatus": "String",
"id": "String (identifier)",
"isAdminManaged": true,
"isDefault": true,
"isInitial": true,
"isRoot": true,
"isVerified": true,
"passwordNotificationWindowInDays": 14,
"passwordValidityPeriodInDays": 90,
"state": {"@odata.type": "microsoft.graph.domainState"},
"supportedServices": ["String"]
}