Online Management API に関する入門情報

注意

2020 年 8 月 26 日より、オンライン管理の API は非推奨となります。

このトピックでは、Microsoft Dataverse のための Online Admin API の開始に役立つ基本情報を提供します。

Microsoft 365 管理者ロール

Online Management API を使用するには、 Microsoft 365 のテナントで割り当てられた次の管理者ロールのいずれかを持っている必要があります:

これらのロールについては、管理者ロールについてを参照してください

サービス URL は REST API にアクセスするためのエンドポイントアドレスを定義します。 Online Management API を使用して操作を実行するには、次の形式で URL を指定する必要があります:

{ServiceUrl}/api/v1.2/{resource}

たとえば、北米の Microsoft 365 テナントのインスタンスを取得するには、入手リクエストで次の URL に渡すことができます:

https://admin.services.crm.dynamics.com/api/v1.2/instances

サービス URL のリストについては、サービス URL を参照してください。

Online Management API は、次の規格要求および応答ヘッダーがあります。

ヘッダー	種類	内容
言語の承諾	String	応答に優先する言語を指定します。ヘッダーに関する詳細: 言語の承諾 (MDN Webドキュメント)
認証	String	資格情報を指定して、Online Management API サービスでユーザーを認証します。ヘッダーに関する詳細: 認証 (MDN Web ドキュメント)

要求でのこれらのヘッダーの設定については、「Online Management API の使用を認証」を参照してください。

ヘッダー	内容
操作場所	長期実行操作の場合、操作照会の位置を確認するための操作照会の場所を指定します。たとえば、次のようになります。 `https://admin.services.crm.dynamics.com/operations/{operationid}`
後に試行	長期実行操作の場合は、操作状況を再度照会するまでの推奨期間を秒単位で指定します。例: 30

注意

ドキュメントの言語設定についてお聞かせください。簡単な調査を行います。 (この調査は英語です)

この調査には約 7 分かかります。個人データは収集されません (プライバシーステートメント)。