ドメイン リソースの種類

  • [アーティクル]

名前空間: microsoft.graph

テナントに関連付けられているドメインを表します。

ドメイン操作を使用して、ドメインをテナントに関連付け、ドメインの所有権を確認し、サポートされているサービスを構成します。 ドメイン操作によって Office 365 などといったサービスでのドメインの関連付けを自動化するレジストラーを有効にします。 たとえば、ドメインサインアップの一環として、レジストラーは電子メール、Web サイト、認証などのバニティ ドメインを有効にすることができます。

ドメインをテナントに関連付けるには:

  1. ドメインをテナントに関連付けます。

  2. ドメイン検証レコードを取得します。 ドメイン レジストラーまたは DNS サーバー構成を使用して、検証レコードの詳細をドメインのゾーン ファイルに追加します。

  3. ドメインの所有権を確認します。 これにより、ドメインが検証され、isVerified プロパティがtrueに設定されます。

  4. ドメインで使用する予定のサポートされているサービスを示します。

  5. ドメインのサービスを有効にするために必要なレコードの一覧を取得して、サポートされているサービスを構成します。 ドメイン レジストラーまたは 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 フェデレーション サービスを介してテナントのオンプレミス 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.com) によって作成された初期ドメインである場合。 会社ごとに最初のドメインは 1 つだけです。 null 許容ではありません
isRoot ブール型 true ドメインが検証済みルート ドメインの場合。 それ以外の場合は、ドメインがサブドメインまたは未検証の場合に false します。 null 許容ではありません
isVerified ブール型 true ドメインがドメイン所有権の検証を完了した場合。 null 許容ではありません
passwordNotificationWindowInDays Int32 ユーザーがパスワードの有効期限が切れるという通知を受け取るまでの日数を指定します。 プロパティが設定されていない場合は、既定値の 14 日が使用されます。
passwordValidityPeriodInDays Int32 パスワードを変更する前に有効な時間の長さを指定します。 プロパティが設定されていない場合は、既定値の 90 日が使用されます。
state domainState ドメインに対してスケジュールされた非同期操作の状態。
supportedServices String collection ドメインに割り当てられた機能。 Email、Sharepoint、EmailInternalRelayOnly、OfficeCommunicationsOnline、SharePointDefaultDomain、FullRedelegation、SharePointPublic、OrgIdAuthentication、Yammer、Intuneの0、1以上の値を含めることができます。 API を使用して追加または削除できる値は、 Email、 OfficeCommunicationsOnline、 Yammerです。 null 許容型ではありません。

リレーションシップ

ドメインとディレクトリ内の他のオブジェクト (検証レコードやサービス構成レコードなど) 間のリレーションシップは、ナビゲーション プロパティを介して公開されます。 これらのリレーションシップは、要求でこれらのナビゲーション プロパティをターゲットにすることで読み取ることができます。

リレーションシップ 型 説明
domainNameReferences directoryObject コレクション ドメイン ID を参照するユーザーやグループなどのオブジェクト。 読み取り専用、Null 許容。 返されるオブジェクトの OData 型による $expand と $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"]
}