Windows DSN の構成

Microsoft ［ODBC データソースアドミニストレーター］の使用

Microsoft ODBC データソースアドミニストレーターを使ってDSN 設定を編集できます。DSN はインストールプロセス中に作成されることに注意してください。

DSN 設定を編集するには、次の手順を実行してください。

スタート -> 検索 を選択し、検索ボックスにODBC データソース と入力します。
アプリケーションのビット数（32-bit または64-bit）に対応するODBC アドミニストレーターのバージョンを選択してください。
システムDSN タブをクリックします。
システムデータソースを選択して構成をクリックします。
接続タブの情報を編集してOK をクリックします。

Note： .NET Framework 4.0 の場合、本製品はMicrosoft Visual C++ 2015-2022 再頒布可能パッケージを配布します。.NET Framework 3.5 の場合、本製品はMicrosoft Visual C++ 2008 再頒布可能パッケージを配布します。

レジストリへのアクセスの確保

本製品は、接続情報をWindows レジストリに保存します。本製品がレジストリに書き込みできるようにするには、以下のいずれかの操作を実行します。

呼び出すアプリケーションを管理者として実行する。
システムDSN 経由ではなく、ユーザーDSN 経由で接続する。

Azure Cosmos DB への接続

Azure Cosmos DB は、アカウントキー、Azure AD、Azure Service Principal による接続と認証をサポートします。

アカウントキー

Azure Portal にログインしてAzure Cosmos DB を選択し、自分のアカウントを選択します。

認証するには以下のように設定します。

AccountEndpoint：Cosmos DB アカウントURL。これを、Cosmos DB アカウントの設定 -> キーブレードにあるURI 値に設定します。
AccountKey：Azure Cosmos DB に接続するためのマスターキートークンまたはリソーストークン。これを、Cosmos DB アカウントの設定 -> キーブレードにあるプライマリキー値に設定します。
TokenType：（オプション）アカウント作成時に生成される完全なアクセス許可を持つトークンであるマスタートークンを使用する場合は、これを"master"（デフォルト値）に設定します。その他の場合、リソーストークンを使用している場合は、このプロパティを"resource" に設定します。リソーストークンは、データベースユーザーがセットアップされたときに生成されるカスタムのアクセス許可トークンです。

Azure AD

Azure AD は、Microsoft のマルチテナント、クラウドベースのディレクトリおよびID 管理サービスです。これはユーザーベースの認証で、AuthScheme をAzureAD に設定する必要があります。

Web アプリケーションを介したAzure AD への認証には、必ずカスタムOAuth アプリケーションの作成が必要です。詳細はAzure AD アプリケーションの作成を参照してください。

デスクトップアプリケーション

CData は、デスクトップアプリケーションからAzure AD への接続を簡略化する埋め込みOAuth アプリケーションを提供します。

カスタムOAuth アプリケーションを使用して、デスクトップアプリケーションで認証することもできます。（詳しくは、Azure AD アプリケーションの作成を参照してください。） Azure AD 経由で認証するには、以下のパラメータを設定します。

AuthScheme：AzureAD。
カスタムアプリケーションのみ：
- OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
- OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。
- CallbackURL：カスタムOAuth アプリケーションの登録時に定義したリダイレクトURI。

接続すると、本製品はデフォルトブラウザでAzure Cosmos DB のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。

本製品はOAuth プロセスを完了し、Azure Cosmos DB からアクセストークンを取得してそれを使ってデータをリクエストします。 OAuth 値はOAuthSettingsLocation で指定されたパスに保存されます。これらの値は接続間で永続化されます。

アクセストークンの期限が切れたときは、本製品は自動でアクセストークンをリフレッシュします。

ヘッドレスマシン

ヘッドレスマシンのユーザーアカウントでドライバーを設定するには、インターネットブラウザに対応した別の端末で認証する必要があります。

以下のいずれかの方法で行います。

後述のオプション1：Verifier code を取得および交換に従い、OAuthVerifier 値を取得します。
後述のオプション2：OAuth 設定を転送で説明するように、本製品を別のマシンにインストールします。通常のブラウザベースのフローで認証した後、OAuth 認証値を転送します。

オプション1：Verifier code を取得および交換

認可エンドポイントを見つけます。

カスタムアプリケーションのみ： 次のプロパティを設定して、Authorization URL を作成します。
- OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId。
- OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレット。
カスタムアプリケーションおよび埋め込みアプリケーション：GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。
1. ストアドプロシージャによって返されたURL をブラウザで開きます。
2. ログインして、本製品にアクセス許可を与えます。verifier code を含むコールバックURL にリダイレクトされます。
3. verifier code の値を保存します。この値は後でOAuthVerifier 接続プロパティを設定する際に使用します。
OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換します。

ヘッドレスマシンでは、次のプロパティを設定します。
- AuthScheme：AzureAD。
- OAuthVerifier：verifier code。
- OAuthSettingsLocation：接続間で維持されるOAuth トークンの値を保存するファイルの場所。
- カスタムアプリケーションのみ：
  - OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId。
  - OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレット。
OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットします。
- OAuthSettingsLocation：暗号化されたOAuth 認証値が保存される場所。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品に読み書きのアクセス許可を与えることを確認してください。
- カスタムアプリケーションのみ：
  - OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId。
  - OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレット。

オプション2：OAuth 設定を転送

ヘッドレスマシン経由の接続に先立ち、インターネットブラウザに対応したデバイスでドライバーとの接続を作成し、インストールする必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順を完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。

接続が正常にテストされたら、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンでは、次のプロパティを設定します。

AuthScheme：AzureAD。
OAuthSettingsLocation：OAuth 設定ファイルの場所。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品に読み書きのアクセス許可を与えることを確認してください。
カスタムアプリケーションのみ：
- OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId。
- OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレット。

Azure サービスプリンシパル

Azure サービスプリンシパルは、ロールに基づいたアプリケーションベースの認証です。これは、認証がユーザーごとではなく、アプリケーションごとに行われることを意味します。アプリケーションで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで、割り当てられたロールに基づいて実行されます。リソースへのアプリケーションのアクセスは、割り当てられたロールの権限によって制御されます。

Azure サービスプリンシパル認証の設定方法については、サービスプリンシパルによるAzure AD アプリケーションの作成を参照してください。

ODBC Driver for Azure Cosmos DB