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

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

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

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

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

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

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

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

SQL Server への接続

CData ODBC Driver for SQL Server を使用して、Microsoft SQL Server、Azure SQL Server、またはAzure Data Warehouse の任意のインスタンスに接続できます。

Microsoft SQL Server

SQL Server に接続するには、次の接続プロパティを設定します。

• Server：SQL Server を実行するサーバー名。
• Database：SQL Server データベース名。

Azure SQL Server またはAzure Data Warehouse

以下の接続プロパティを設定することで、Azure SQL Server またはAzure Data Warehouse に接続できます。

• Server：Azure を実行しているサーバー。Azure ポータルにログインして、SQL データベース（またはSQL データウェアハウス） -> 自身のデータベースを選択 -> 概要 -> サーバー名に進むと確認できます。
• Database：Azure ポータルのSQL データベース（またはSQL データウェアハウス）ページに表示されるデータベース名。

SQL Server への認証

本製品 は、SQL Server 認証、Windows 認証、またはKerberos 認証を使用するSQL Server への認証をサポートします。

Microsoft SQL Server

SQL Server のユーザーログイン認証情報を使用してMicrosoft SQL Server に認証するには、以下のように設定します。

• AuthScheme：Password に設定。
• User：SQL Server との認証に使われるユーザー名。
• Password：認証ユーザーに関連付けられたパスワード。

Windows

本製品 がプロセスを実行しているWindows ユーザーのID から自動的にログイン認証情報を取得できるようにするには、以下のように設定します。

• AuthScheme：NTLM に設定。
• IntegratedSecurity：true に設定。

Kerberos

Kerberos でSQL Server への認証を行うには、AuthScheme をKERBEROS に設定します。

Kerberos 経由でSQL Server への認証を行うには、認証プロパティを定義し、Kerberos が認証チケットを取得する方法を選択する必要があります。

Kerberos チケットの取得

Kerberos チケットは、依頼者のID を認証するために使用されます。正式なログイン / パスワードの代わりにチケットを使用することで、パスワードをローカルに保存したり、ネットワーク経由で送信したりする必要がなくなります。 ユーザーは、ローカルコンピュータでログインするか、 コマンドプロンプトでkinit USER と入力するたびに、再認証されます（チケットはリフレッシュされます）。

本製品 は、 KRB5CCNAME および / またはKerberosKeytabFile 変数が存在するかどうかに応じて、必要なKerberos チケットを取得する3 つの方法を提供します。

MIT Kerberos 資格情報キャッシュファイル

このオプションを使用すると、MIT Kerberos チケットマネージャーまたはkinit コマンドを使ってチケットを取得できます。このオプションでは、User またはPassword 接続プロパティを設定する必要はありません。

このオプションは、KRB5CCNAME がシステムに作成されている必要があります。

MIT Kerberos 資格情報キャッシュファイル経由でチケット検索を有効にするには：

1. お使いの環境にKRB5CCNAME 変数が存在することを確認します。
2. KRB5CCNAME を資格情報キャッシュファイルを指すパスに設定します。（例えば、C:\krb_cache\krb5cc_0 または/tmp/krb5cc_0 です。）資格情報キャッシュファイルは、MIT Kerberos チケットマネージャーを使用してチケットを生成するときに作成されます。
3. チケットを取得するには：
   1. MIT Kerberos チケットマネージャーアプリケーションを開きます。
   2. Get Ticket をクリックします。
   3. プリンシパル名とパスワードを入力します。
   4. OK をクリックします。

   チケットの取得に成功すると、チケット情報がKerberos チケットマネージャーに表示され、クレデンシャルキャッシュファイルに保存されます。

本製品 はキャッシュファイルを使用してSQL Server に接続するためのKerberos チケットを取得します。

Note： KRB5CCNAME を編集したくない場合は、KerberosTicketCache プロパティを使用してファイルパスを手動で設定することができます。この設定後に、本製品 は指定されたキャッシュファイルを使用してSQL Server に接続するためのKerberos チケットを取得します。

Keytab ファイル

お使いの環境にKRB5CCNAME 環境変数がない場合、Keytab ファイルを使用してKerberos チケットを取得できます。

この方法を使用するには、User プロパティを目的のユーザー名に設定し、KerberosKeytabFile プロパティをユーザーに関連付けられたキータブファイルを指すファイルパスに設定します。

User およびPassword

お使いの環境にKRB5CCNAME 環境変数およびKerberosKeytabFile プロパティが設定されていない場合、ユーザーとパスワードの組み合わせを使用してチケットを取得できます。

この方法を使用するには、User およびPassword プロパティを、SQL Server での認証に使用するユーザー / パスワードの組み合わせに設定します。

クロスレルム認証の有効化

より複雑なKerberos 環境では、複数のレルムおよびKDC サーバーが使用されるクロスレルム認証が必要になる場合があります。例えば、1つのレルム / KDC がユーザー認証に使用され、別のレルム / KDC がサービスチケットの取得に使用される場合です。

このようなクロスレルム認証を有効にするには、KerberosRealm およびKerberosKDC プロパティをユーザー認証に必要な値に設定します。また、KerberosServiceRealm およびKerberosServiceKDC プロパティを、 サービスチケットの取得に必要な値に設定します。

NTLM

NTLM 認証メカニズムを使用して、ユーザー名とパスワードで認証することができます。 ユーザー名とパスワードが指定されていない場合、ドライバーは現在のWindows 認証情報を使用して認証します（.NET Framework でのみサポート）。

認証するには、次を設定します。

• AuthScheme：NTLM （Windows Credentials）。
• User：認証するユーザーの名前。
• Password：認証ユーザーに関連付けられたパスワード。

または、AuthScheme をAzureAd、AzurePassword、AzureMSI のいずれかに設定してOAuth を使用することもできます。すべてのOAuth接続で、AzureTenant 接続プロパティをSQL Server データベースがホストされているテナントのId に設定する必要があります。

Entra ID（Azure AD）

Note：Microsoft はAzure AD をEntra ID にリブランドしました。ユーザーがEntra ID 管理サイトを操作する必要があるトピックでは、Microsoft が使用している名称と同じものを使用します。ただし、名前または値が"Azure AD" を参照しているCData 接続プロパティは、依然として存在します。

Microsoft Entra ID は、マルチテナント型のクラウドベースのID およびアクセス管理プラットフォームです。 OAuth ベースの認証フローに対応しており、ドライバーによるSQL Server エンドポイントへのセキュアなアクセスを実現します。

Web アプリケーションを介したEntra ID への認証には、必ずはじめにカスタムOAuth アプリケーションを作成して登録する必要があります。 これにより、アプリケーションは独自のリダイレクトURI を定義し、クレデンシャルのスコープを管理し、組織固有のセキュリティポリシーに準拠することができるようになります。

カスタムOAuth アプリケーションの作成および登録方法の詳細については、カスタムAzure AD アプリケーションの作成 を参照してください。

AuthScheme をAzureAD に設定した後の認証手順は、環境によって異なります。 デスクトップアプリケーション、Web ベースのワークフロー、またはヘッドレスシステムから接続する方法の詳細については、以下のセクションを参照してください。

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

デスクトップアプリケーションでは、ドライバーに組み込まれたOAuth アプリケーション、またはMicrosoft Entra ID に登録されたカスタムOAuth アプリケーションのいずれかを使用して認証を行うことができます。

オプション1：組み込みOAuth アプリケーションの使用

これはドライバーに含まれている、事前登録済みのアプリケーションです。 セットアップが簡単で、独自の認証情報を登録する必要がないため、開発環境、単一ユーザー向けツール、または迅速かつ簡単な認証が求められる構成に最適です。

次の接続プロパティを設定します。

• AuthScheme：AzureAD
• InitiateOAuth：
  • GETANDREFRESH – 初回ログイン時に使用します。ログインページを起動し、トークンを保存します。
  • REFRESH – すでに有効なアクセストークンおよびリフレッシュトークンを取得している場合は、この設定を使用します。保存されたトークンを再利用するため、ユーザーに再度プロンプトを表示することはありません。

接続時には、ドライバーは既定のブラウザでMicrosoft Entra のサインインページを開きます。 サインインしてアクセスを許可すると、ドライバーはアクセストークンおよびリフレッシュトークンを取得し、OAuthSettingsLocation で指定されたパスに保存します。

オプション2：カスタムOAuth アプリケーションの使用

組織でセキュリティポリシーの管理、リダイレクトURI の設定、アプリケーションのブランディングなど、より高度な制御が必要な場合は、代わりにMicrosoft Entra ID にカスタムOAuth アプリケーションを登録し、接続時にその値を指定することができます。

登録時に、以下の値を記録してください。

• OAuthClientId：カスタムOAuth アプリケーションの登録時に生成されたクライアントId。
• OAuthClientSecret：カスタムOAuth アプリケーションの登録時に生成されたクライアントシークレット。
• CallbackURL：アプリケーション登録時に定義したリダイレクトURI。

カスタムOAuth アプリケーションの登録とリダイレクトURI の設定方法の詳細については、カスタムAzure AD アプリケーションの作成 を参照してください。

次の接続プロパティを設定します。

• AuthScheme： AzureAD
• InitiateOAuth：
  • GETANDREFRESH – 初回ログイン時に使用します。ログインページを起動し、トークンを保存します。
  • REFRESH – すでに有効なアクセストークンおよびリフレッシュトークンを取得している場合は、この設定を使用します。保存されたトークンを再利用するため、ユーザーに再度プロンプトを表示することはありません。
• OAuthClientId：カスタムOAuth アプリケーションの登録時に生成されたクライアントId。
• OAuthClientSecret：カスタムOAuth アプリケーションの登録時に生成されたクライアントシークレット。
• CallbackURL：アプリケーション登録時に定義したリダイレクトURI。

認証後、トークンはOAuthSettingsLocation に保存されます。 これらの値はセッションをまたいで保持され、アクセストークンの有効期限が切れた際に自動的に更新されるため、次回以降の接続時に再度ログインする必要はありません。

ヘッドレスマシン

CI / CD パイプライン、バックグラウンドサービス、サーバーベース連携などのヘッドレス環境では、対話型のブラウザが使用できません。 AzureAD を使用して認証するには、別のデバイス上のブラウザでOAuth フローを完了し、その認証結果をヘッドレスシステムに転送する必要があります。

セットアップオプション ：

• Verifier code を取得および交換
  • 別のデバイスを使用してサインインし、Verifier code を取得します。ヘッドレスシステムがこのコードを使用してトークンを要求します。
• OAuth 設定ファイルを転送
  • 別のデバイスで認証を行い、その後、保存されたトークンファイルをヘッドレス環境にコピーします。

Verifier code の使用

1. ブラウザを備えたデバイスで：
   • カスタムOAuth アプリケーションを使用する場合は、次のプロパティを設定します。
     • OAuthClientId：カスタムOAuth アプリケーションの登録時に生成されたクライアントId。
     • OAuthClientSecret：カスタムOAuth アプリケーションの登録時に生成されたクライアントシークレット。
   • GetOAuthAuthorizationUrl ストアドプロシージャを呼び出し、サインインURL を生成します。
   • 返されたURL をブラウザで開きます。サインインして、ドライバーにアクセス許可を与えます。verifier code を含むコールバックURL にリダイレクトされます。
   • サインイン後、リダイレクトURL のcode パラメータの値を保存します。この値は後でOAuthVerifier 接続プロパティを設定する際に使用します。
2. ヘッドレスマシンで：
   • 次のプロパティを設定します。
     • AuthScheme：AzureAD
     • OAuthVerifier：保存したverifier code。
     • OAuthSettingsLocation：OAuth トークンの値を保存するファイルのパス。
     • カスタムアプリケーションの場合：
       • OAuthClientId：カスタムOAuth アプリケーションの登録時に生成されたクライアントId。
       • OAuthClientSecret：カスタムOAuth アプリケーションの登録時に生成されたクライアントシークレット。
   • トークンを保存した後、以下の設定により再利用できます。
     • OAuthSettingsLocation：アクセストークンの自動リフレッシュを有効にするために、この場所がドライバーに読み書きのアクセス許可を与えることを確認してください。
     • カスタムアプリケーションの場合：
       • OAuthClientId：カスタムOAuth アプリケーションの登録時に生成されたクライアントId。
       • OAuthClientSecret：カスタムOAuth アプリケーションの登録時に生成されたクライアントシークレット。

OAuth 設定を転送

1. ブラウザを備えたデバイスで：
   • デスクトップアプリケーションセクションの説明に従って接続します。
   • 接続後、トークンはOAuthSettingsLocation のファイルパスに保存されます。デフォルトのファイル名はOAuthSettings.txt です。

   暗号化された値はシステムレジストリに保存されます。

2. ヘッドレスマシンで：
   • OAuth 設定ファイルをマシンにコピーします。
   • 次のプロパティを設定します。
     • AuthScheme：AzureAD
     • OAuthSettingsLocation：アクセストークンの自動リフレッシュを有効にするために、この場所がドライバーに読み書きのアクセス許可を与えることを確認してください。
     • カスタムアプリケーションの場合：
       • OAuthClientId：カスタムOAuth アプリケーションの登録時に生成されたクライアントId。
       • OAuthClientSecret：カスタムOAuth アプリケーションの登録時に生成されたクライアントシークレット。

セットアップ後、ドライバーは保存されたトークンを使用してアクセストークンを自動的に更新するため、ブラウザや手動でのログインは必要ありません。

Azure サービスプリンシパル

Note：Microsoft はAzure AD をEntra ID にリブランドしました。ユーザーがEntra ID 管理サイトを操作する必要があるトピックでは、Microsoft が使用している名称と同じものを使用します。ただし、名前または値が"Azure AD" を参照しているCData 接続プロパティは、依然として存在します。

サービスプリンシパルは、Microsoft Entra ID（Azure AD）アプリケーション内のセキュリティオブジェクトであり、そのアプリケーションが特定のテナント内で何を行えるかを定義します。 サービスプリンシパルはEntra 管理センターで作成でき、Azure ポータルからもアクセス可能です。 作成プロセスの過程で、サービスプリンシパルがクライアントシークレットまたは証明書のどちらを経由してEntra リソースにアクセスするかも指定します。

接続先のサービスによっては、テナント管理者がサービスプリンシパル認証を有効にするか、サービスプリンシパルを適切なロールまたはセキュリティグループに割り当てる必要があります。

サービスプリンシパルの権限は、特定のユーザーに紐づくのではなく、割り当てられたロールに基づきます。 これらのロールは、アプリケーションがアクセスできるリソースと、実行できる操作を決定します。

サービスプリンシパルを使用して認証する場合、Entra ID（Azure AD）でのサービスプリンシパルアプリの作成 で説明するようにEntra テナントにアプリケーションを登録する必要があります。

このサブセクションでは、接続前に設定する必要があるプロパティについて説明します。 これらは、クライアントシークレットで認証するか、証明書で認証するかによって異なります。

クライアントシークレットによる認証

• AuthScheme：AzureServicePrincipal。
• AzureTenant：接続するAzure AD テナント。
• OAuthClientId：アプリケーション設定のクライアントID。
• OAuthClientSecret：アプリケーション設定のクライアントシークレット。
• InitiateOAuth：GETANDREFRESH。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。

証明書による認証

• AuthScheme：AzureServicePrincipalCert。
• AzureTenant：接続するAzure AD テナント。
• OAuthClientId：アプリケーション設定のクライアントId。
• OAuthJWTCert：JWT 証明書のストア。
• OAuthJWTCertType：JWT 証明書ストアの種類。
• InitiateOAuth：GETANDREFRESH。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。

Azure Password

Azure 認証情報を使用してAzure Active Directory に直接認証するには、以下の接続プロパティを指定します：

• AuthScheme：AzurePassword。
• User：認証するAzure ユーザーのアカウント。
• Password：認証するAzure ユーザーのパスワード。
• AzureTenant：Azure 上のSQL Server への認証に使用するカスタムAzure AD アプリケーションのディレクトリ（テナント）ID。これを見つけるには、カスタムアプリケーションの概要ページに移動します。

Managed Service Identity (MSI)

Azure VM 上でSQL Server を実行しており、マネージドID（MSI）認証情報を自動的に取得して接続したい場合は、AuthScheme を AzureMSI に設定します。

User-Managed Identities

マネージドID のトークンを取得するには、OAuthClientId プロパティを使用してマネージドID のclient_id を指定します。

VM に複数のユーザーが割り当てられたマネージドID がある場合は、OAuthClientId も指定する必要があります。