クイックスタートのサンプル: オンライン管理 API を使用する Microsoft Dataverse 環境の取得

[アーティクル]
03/11/2022

注意

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

C# サンプルは、オンライン管理 API への認証を行い、その後自分の Microsoft 365 テナントからすべての Dataverse 環境を取得する方法を示しています。

サンプルでは、OAuth 2.0 プロトコルを使用して Online Management API に簡単に認証し、要求ヘッダーにあるアクセストークンを渡すために、認証ヘルパーコードを使用しています。

このサンプルの概要

サンプルでは次のタスクを実行します:

ConnectToAPI メソッドを使用し、Online Management API に接続します。

a. 認証ヘルパーコードの DiscoverAuthority メソッドを呼び出して、権限情報を入手するためにサービス URL に渡します。

b. HttpClient インスタンスを使用して、Online Management API サービスに接続します。

c. API サービスのベースアドレスと最大実行時間を指定します。
RetrieveInstancesAsync メソッドを使用し、Microsoft 365 テナント内のすべての Customer Enagement のインスタンスを取得するための http 要求を実行し、応答を表示します。

このサンプルの実行

このサンプルを実行する前に次があることを確認します:

Microsoft 365 テナントの管理者ロールの 1 つ。 Microsoft 365 管理者ロールを参照
Visual Studio 2015 以降では、NuGet パッケージにアセンブリをダウンロード / 復元するには、インターネット接続が必要です。
.NET Framework 4.6.2

サンプルを実行するには:

サンプルをダウンロードし、展開します。
展開された場所にある C＃フォルダーの Visual Studio ソリューションファイル (.sln) をダブルクリックし、Visual Studio でソリューションを開きます。
Programs.cs ファイルでは、対象地域が北米以外である場合は、異なるサービス URL を指定します。世界各国の地域におけるサービス URL 値の一覧については、「サービス URL」を参照してください。
```
//TODO: Change this value if your Microsoft 365 tenant is in a different region than North America

private static string _serviceUrl = "https://admin.services.crm.dynamics.com";
```

HelperCode > AuthenticationHelper.cs ファイルでは、_clientId 値および _redirectURL 値を適切に更新します。

// TODO: Substitute your app registration values here.
// These values are obtained on registering your application with the 
// Azure Active Directory.
private static string _clientId = "<GUID>";    //e.g. "e5cf0024-a66a-4f16-85ce-99ba97a24bb2"
private static string _redirectUrl = "<Url>";  //e.g. "app://e5cf0024-a66a-4f16-85ce-99ba97a24bb2"

変更を保存し、F5 を押すか、または デバッグ > デバッグ開始 を選択し、デバッグを開始します。

コードサンプル一覧

完全なサンプルコードを次に示します。

using Microsoft.Crm.Sdk.Samples.HelperCode;
using System;
using System.Net.Http;
using System.Threading.Tasks;


namespace Microsoft.Crm.Sdk.Samples
{
    /// <summary>
    /// This sample retrieves Customer Engagement instances
    /// in your Microsoft 365 tenant.
    /// </summary>    

    class RetrieveInstances
    {
        private HttpClient httpClient;

        //TODO: Change this value if your Microsoft 365 tenant is in a different region than North America
        private static string _serviceUrl = "https://admin.services.crm.dynamics.com";

        private void ConnectToAPI()
        {
            Console.WriteLine("Connecting to the Online Management API service...");

            // Discover authority for the Online Management API service
            var authority = Authentication.DiscoverAuthority(_serviceUrl);

            // Authenticate to the Online Management API service by 
            // passing in the discovered authority 
            Authentication auth = new Authentication(authority.Result.ToString());            

            // Use an HttpClient object to connect to Online Management API service.           
            httpClient = new HttpClient(auth.ClientHandler, true);

            // Specify the API service base address and the max period of execution time 
            httpClient.BaseAddress = new Uri(_serviceUrl);
            httpClient.Timeout = new TimeSpan(0, 2, 0);            
        }

        public async Task RetrieveInstancesAsync()
        {
            HttpRequestMessage myRequest = new HttpRequestMessage(HttpMethod.Get, "/api/v1.1/instances");
            HttpResponseMessage myResponse = await httpClient.SendAsync(myRequest);

            if (myResponse.IsSuccessStatusCode)
            {
                var result = myResponse.Content.ReadAsStringAsync().Result;
                Console.WriteLine("Your instances retrieved from Microsoft 365 tenant: \n{0}", result);
            }
            else
            {
                Console.WriteLine("The request failed with a status of '{0}'",
                       myResponse.ReasonPhrase);
            }
        }

        static public void Main(string[] args)
        {
            RetrieveInstances app = new RetrieveInstances();
            try
            {
                // Connect to the Online Management API. 
                app.ConnectToAPI();

                // Run your request
                Task.WaitAll(Task.Run(async () => await app.RetrieveInstancesAsync()));
            }
            catch (System.Exception ex) { DisplayException(ex); }
            finally
            {
                if (app.httpClient != null)
                { app.httpClient.Dispose(); }
                Console.WriteLine("Press <Enter> to exit the program.");
                Console.ReadLine();
            }
        }

        /// <summary> Helper method to display exceptions </summary> 
        private static void DisplayException(Exception ex)
        {
            Console.WriteLine("The application terminated with an error.");
            Console.WriteLine(ex.Message);
            while (ex.InnerException != null)
            {
                Console.WriteLine("\t* {0}", ex.InnerException.Message);
                ex = ex.InnerException;
            }
        }
    }
}

Online Management API で始める

Online Management API でサポートする操作

Online Management API 参照

注意

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

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

クイック スタートのサンプル: オンライン管理 API を使用する Microsoft Dataverse 環境の取得

このサンプルの概要

このサンプルの実行

コード サンプル一覧

関連トピック

フィードバック

クイックスタートのサンプル: オンライン管理 API を使用する Microsoft Dataverse 環境の取得

コードサンプル一覧