ドメイン リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
テナントに関連付けられているドメインを表します。
ドメイン操作を使用して、ドメインをテナントに関連付け、ドメインの所有権を確認し、サポートされているサービスを構成します。 ドメイン操作によって Office 365 などといったサービスでのドメインの関連付けを自動化するレジストラーを有効にします。 たとえば、ドメインサインアップの一環として、レジストラーは電子メール、Web サイト、認証などのバニティ ドメインを有効にすることができます。
ドメインをテナントに関連付けるには:
ドメインをテナントに関連付けます。
ドメイン検証レコードを取得します。 ドメイン レジストラーまたは DNS サーバー構成を使用して、検証レコードの詳細をドメインのゾーン ファイルに追加します。
ドメインの所有権を確認します。 これにより、ドメインが検証され、 isVerified プロパティが に
true設定されます。ドメインで使用する予定のサポートされているサービスを示します。
ドメインのサービスを有効にするために必要なレコードの一覧を取得して、サポートされているサービスを構成します。 ドメイン レジストラーまたは DNS サーバー構成を使用して、構成レコードの詳細をドメインのゾーン ファイルに追加します。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| ドメインを取得する | domain | ドメイン オブジェクトのプロパティとリレーションシップを読み取ります。 |
| ドメインを作成する | domain | テナントにドメインを追加します。 |
| ドメインを一覧表示する | domain | テナントにリンクされているすべてのドメインを取得します。 |
| ドメイン名の参照を一覧表示する | directoryObject コレクション | ドメインへの参照を含むディレクトリ オブジェクトの一覧を取得します。 |
| サービス構成レコードを一覧表示する | domainDnsRecord コレクション | ドメイン構成のドメイン DNS レコードの一覧を取得します。 |
| 検証 DNS レコードを一覧表示する | domainDnsRecord コレクション | ドメイン検証用のドメイン DNS レコードの一覧を取得します。 |
| ドメインの更新 | domain | ドメインをUpdatesします。 |
| ドメインを削除する | なし | ドメインを削除します。 |
| ドメインの強制削除 | なし | 非同期操作を使用してドメインを削除します。 |
| ドメインを確認する | domain | ドメインの所有権を検証します。 |
| ドメインの昇格 | ブール型 | 確認済みのサブドメインをルート ドメインに昇格させます。 |
プロパティ
| プロパティ | 種類 | 説明 |
|---|---|---|
| authenticationType | String | ドメインに対して構成されている認証の種類を示します。 値は または FederatedですManaged。 Managedは、Microsoft Entra IDがユーザー認証を実行するクラウド マネージド ドメインを示します。 Federatedは、認証が、Active Directory フェデレーション サービス (AD FS)経由でテナントのオンプレミスの Active Directoryなどの ID プロバイダーとフェデレーションされていることを示します。 null 許容ではありません。 委任されたシナリオでこのプロパティを更新するには、呼び出し元のアプリに Directory.AccessAsUser.All 委任されたアクセス許可を割り当てる必要があります。 |
| availabilityStatus | String | このプロパティは、検証アクションが使用される場合を除き、常にnullです。 検証アクションを使用すると、応答でドメイン エンティティが返されます。 応答のドメイン エンティティの availabilityStatus プロパティは、 または のいずれかAvailableImmediatelyEmailVerifiedDomainTakeoverScheduledです。 |
| id | String | ドメインの完全修飾名。 キー、不変、null 許容ではない、一意。 |
| isAdminManaged | ブール型 | プロパティの値は、 false ドメインの DNS レコード管理が Microsoft 365 に委任されている場合です。 それ以外の場合、値は です true。 null 許容ではありません |
| isDefault | ブール型 | true これがユーザー作成に使用される既定のドメインである場合は 。 会社ごとに既定のドメインは 1 つだけです。 null 許容ではありません |
| isInitial | ブール型 | true これが Microsoft Online Services (contoso.com) によって作成された初期ドメインである場合。 会社ごとに最初のドメインは 1 つだけです。 null 許容ではありません |
| isRoot | ブール型 | true ドメインが検証済みルート ドメインの場合。 それ以外の場合、 false ドメインがサブドメインまたは未検証の場合。 null 許容ではありません |
| isVerified | ブール型 | true ドメインがドメイン所有権の検証を完了した場合。 null 許容ではありません |
| passwordNotificationWindowInDays | Int32 | ユーザーがパスワードの有効期限が切れるという通知を受け取るまでの日数を指定します。 プロパティが設定されていない場合は、既定値の 14 日が使用されます。 |
| passwordValidityPeriodInDays | Int32 | パスワードを変更する前に有効な時間の長さを指定します。 プロパティが設定されていない場合は、既定値の 90 日が使用されます。 |
| supportedServices | String collection | ドメインに割り当てられた機能。 、 の複数の値を含0めることができます。 EmailEmailInternalRelayOnlyYammerSharepointSharePointDefaultDomainIntuneOfficeCommunicationsOnlineFullRedelegationSharePointPublicOrgIdAuthentication1 API を使用して追加または削除できる値には、、OfficeCommunicationsOnline、 YammerがEmail含まれます。 null 許容ではありません。 |
| 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 をサポートします。 |
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"]
}
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示