ドメイン リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。
テナントに関連付けられているドメインを表します。
ドメイン操作を使用して、ドメインをテナントに関連付け、ドメインの所有権を確認し、サポートされているサービスを構成します。 ドメイン操作によって Office 365 などといったサービスでのドメインの関連付けを自動化するレジストラーを有効にします。 たとえば、ドメインサインアップの一環として、レジストラーは電子メール、Web サイト、認証などのバニティ ドメインを有効にすることができます。
ドメインをテナントに関連付けるには:
ドメインをテナントに関連付けます。
ドメイン検証レコードを取得します。 ドメイン レジストラーまたは DNS サーバー構成を使用して、検証レコードの詳細をドメインのゾーン ファイルに追加します。
ドメインの所有権を確認します。 これにより、ドメインが検証され、 isVerified プロパティ
trueが .ドメインで使用する予定のサポートされているサービスを示します。
ドメインのサービスを有効にするために必要なレコードの一覧を取得して、サポートされているサービスを構成します。 ドメイン レジストラーまたは DNS サーバー構成を使用して、構成レコードの詳細をドメインのゾーン ファイルに追加します。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| ドメインを取得する | domain | ドメイン オブジェクトのプロパティとリレーションシップを読み取ります。 |
| ドメインを作成する | domain | テナントにドメインを追加します。 |
| ドメインを一覧表示する | domain | テナントにリンクされているすべてのドメインを取得します。 |
| domainNameReference を一覧表示する | directoryObject collection | ドメインへの参照を持つディレクトリ オブジェクトの一覧を取得します。 |
| ServiceConfigurationRecords を一覧表示する | domainDnsRecord コレクション | ドメイン構成のドメイン DNS レコードの一覧を取得します。 |
| verificationDnsRecords を一覧表示する | domainDnsRecord コレクション | ドメイン検証用のドメイン DNS レコードの一覧を取得します。 |
| ドメインを更新する | domain | ドメインを更新します。 |
| ドメインを削除する | なし | ドメインを削除します。 |
| ForceDelete ドメイン | なし | 非同期操作を使用してドメインを削除します。 |
| ドメインを確認する | domain | ドメインの所有権を検証します。 |
| ドメインの昇格 | ブール値 | 確認済みのサブドメインをルート ドメインに昇格させます。 |
プロパティ
| プロパティ | 種類 | 説明 |
|---|---|---|
| authenticationType | 文字列型 (String) | ドメインに対して構成されている認証の種類を示します。 値は次のいずれか Managed または Federated. Managed は、Azure AD がユーザー認証を実行するクラウド マネージド ドメインを示します。 Federated は、認証が Active Directory フェデレーション サービスを介してテナントのオンプレミス Active Directory などの ID プロバイダーとフェデレーションされていることを示します。 このプロパティは読み取り専用であり、null 許容ではありません。 |
| availabilityStatus | 文字列型 (String) | このプロパティは、検証アクションが使用されている場合を除き、常にnull使用されます。 検証アクションが使用されると、応答で ドメイン エンティティが返されます。 応答内の ドメイン エンティティの availabilityStatus プロパティは、次のいずれかAvailableImmediatelyですEmailVerifiedDomainTakeoverScheduled。 |
| id | String | ドメインの完全修飾名。 Key、immutable、not nullable、unique。 |
| isAdminManaged | ブール値 | プロパティの値は、 false ドメインの DNS レコード管理が Microsoft 365 に委任されている場合です。 それ以外の場合、値は true. null 許容ではない |
| isDefault | ブール型 (Boolean) | true これがユーザー作成に使用される既定のドメインの場合。 会社ごとに既定のドメインは 1 つだけです。 null 許容ではない |
| isInitial | ブール値 | true これが Microsoft Online Services (companyname.onmicrosoft.com) によって作成された初期ドメインの場合。 会社ごとに最初のドメインは 1 つだけです。 null 許容ではない |
| isRoot | ブール値 | true ドメインが検証済みのルート ドメインの場合。 それ以外の場合は、 false ドメインがサブドメインまたは未検証の場合。 null 許容ではない |
| isVerified | ブール値 | true ドメインがドメイン所有権の検証を完了した場合。 null 許容ではない |
| passwordNotificationWindowInDays | Int32 | ユーザーがパスワードの有効期限が切れるという通知を受け取るまでの日数を指定します。 プロパティが設定されていない場合は、既定値の 14 日間が使用されます。 |
| passwordValidityPeriodInDays | Int32 | パスワードを変更する前に有効な時間を指定します。 プロパティが設定されていない場合は、既定値の 90 日間が使用されます。 |
| supportedServices | String collection | ドメインに割り当てられている機能。 次の値を含0``1めることができます。 Email, Sharepoint, OfficeCommunicationsOnline``EmailInternalRelayOnly,SharePointDefaultDomain , , SharePointPublic``FullRedelegation, OrgIdAuthentication, . Intune``Yammer Graph API を使用して追加または削除できる値には、次のものが含まれます。 Email``OfficeCommunicationsOnline``Yammer null 許容ではありません。 |
| state | domainState | ドメインに対してスケジュールされた非同期操作の状態。 |
リレーションシップ
ドメインとその検証レコードやサービス構成レコードなどのディレクトリ内の他のオブジェクト間のリレーションシップは、ナビゲーション プロパティを使用して公開されます。 要求でこれらのナビゲーション プロパティをターゲットにすることで、これらのリレーションシップを読み取ることができます。
| リレーションシップ | 型 | 説明 |
|---|---|---|
| domainNameReferences | directoryObject collection | ドメイン 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 コレクション | 顧客が Azure AD でドメイン所有権の検証を完了する前に、顧客がドメインの DNS ゾーン ファイルに追加した DNS レコード。 読み取り専用、Null 許容。 $expand をサポートします。 |
| federationConfiguration | internalDomainFederation | Azure AD とのフェデレーション時に顧客によって構成されたドメイン設定。 $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"]
}
フィードバック
フィードバックの送信と表示