Azure DataLakeStorage Gen 1 への接続

To connect to a Gen 1 DataLakeStorage account, you should first set the following properties:

• Schema：ADLSGen1 に設定。
• Account：アカウント名に設定。
• AzureTenant：テナントId に設定。取得方法について詳しくは、プロパティを参照してください。
• Directory：（オプション）複製されたファイルを格納するために使用されるパスに設定。指定しない場合は、ルートディレクトリが使用されます。

Azure DataLakeStorage Gen 1 への認証

Gen 1 は、次の認証メソッドをサポートしています。Azure Active Directory OAuth (AzureAD) and Managed Service Identity (AzureMSI).

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 Data Lake Storage のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。

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

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

Web アプリケーション

Web アプリケーションを使用してAzure AD 経由で認証する場合は、Azure Data Lake Storage にカスタムOAuth アプリケーションを登録する必要があります（Azure AD アプリケーションの作成 を参照）。 それから本製品 を使用してOAuth トークンの値を取得および管理します。

Azure AD OAuth アクセストークンの取得

はじめに、以下の接続プロパティを設定してOAuthAccessToken を取得します。

• AuthScheme：AzureAD。
• OAuthClientId：アプリケーション設定のクライアントId。
• OAuthClientSecret：アプリケーション設定のクライアントシークレット。

次に、ストアドプロシージャを呼び出してOAuth 交換を完了します。

1. GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。AuthMode インプットをWEB に、CallbackURL インプットをアプリケーション設定で指定したリダイレクトURI に設定します。必要に応じて、Permissions パラメータを設定してカスタム権限をリクエストします。
   ストアドプロシージャがOAuth エンドポイントのURL を返します。
2. URL を開き、ログインして、アプリケーションを認可します。コールバックURL にリダイレクトされます。
3. GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode インプットをWEB に設定します。Verifier インプットを、コールバックURL のクエリ文字列の"code" パラメータに設定します。必要に応じて、Permissions パラメータを設定してカスタム権限をリクエストします。

アクセストークンとリフレッシュトークンを取得すると、データに接続し、Azure AD アクセストークンを自動または手動でリフレッシュすることができるようになります。

Azure AD OAuth アクセストークンの自動リフレッシュ

本製品 がAzure AD OAuth アクセストークンを自動的にリフレッシュするようにするには、データへの初回接続時に以下のパラメータを設定します。

• AuthScheme：AzureAD。
• InitiateOAuth：REFRESH。
• OAuthClientId：アプリケーション設定のクライアントId。
• OAuthClientSecret：アプリケーション設定のクライアントシークレット。
• OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークン。
• OAuthRefreshToken：GetOAuthAccessToken によって返されたリフレッシュトークン。
• OAuthSettingsLocation：ドライバーがOAuth トークン値を保存する場所。これは接続間で維持されます。

それ以降のデータ接続では、OAuthAccessToken とOAuthRefreshToken の値はOAuthSettingsLocation から取得され、接続時に設定する必要はありません。

Azure AD OAuth アクセストークンの手動リフレッシュ

データ接続時に手動でAzure AD OAuth アクセストークンをリフレッシュするために必要な値は、OAuth リフレッシュトークンのみです。

GetOAuthAccessToken が返すExpiresIn パラメータ値が経過した後に、RefreshOAuthAccessToken ストアドプロシージャを使用して手動でOAuthAccessToken をリフレッシュし、次の接続プロパティを設定します。

• OAuthClientId：アプリケーション設定のクライアントId。
• OAuthClientSecret：アプリケーション設定のクライアントシークレット。

ここでRefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを指定します。新しいトークンが取得できたら、OAuthAccessToken をRefreshOAuthAccessToken が返す値に設定し、新しい接続をオープンします。

最後に、OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

ヘッドレスマシン

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

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

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

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

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

   カスタムアプリケーションのみ： 次のプロパティを設定して、Authorization URL を作成します。

   • InitiateOAuth：OFF。
   • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId。
   • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレット。

   カスタムアプリケーションおよび埋め込みアプリケーション：GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。

   1. ストアドプロシージャによって返されたURL をブラウザで開きます。
   2. ログインして、本製品 にアクセス許可を与えます。verifier code を含むコールバックURL にリダイレクトされます。
   3. verifier code の値を保存します。この値は後でOAuthVerifier 接続プロパティを設定する際に使用します。

2. OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換します。

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

   • AuthScheme：AzureAD。
   • InitiateOAuth：REFRESH。
   • OAuthVerifier：verifier code。
   • OAuthSettingsLocation：接続間で維持されるOAuth トークンの値を保存するファイルの場所。

   • カスタムアプリケーションのみ：

     • OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId。
     • OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレット。

3. OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットします。

   • InitiateOAuth：REFRESH。
   • OAuthSettingsLocation：暗号化されたOAuth 認証値が保存される場所。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。

   • カスタムアプリケーションのみ：

     • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId。
     • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレット。

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

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

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

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

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

• AuthScheme：AzureAD。
• InitiateOAuth：REFRESH。
• OAuthSettingsLocation：OAuth 設定ファイルの場所。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。

• カスタムアプリケーションのみ：

  • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId。
  • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレット。

Managed Service Identity (MSI)

Azure VM 上でAzure Data Lake Storage を実行しており、MSI を利用して接続したい場合は、AuthScheme をAzureMSI に設定します。

User-Managed Identities

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

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

Azure DataLakeStorage Gen 2 への接続

To connect to a Gen 2 DataLakeStorage account, you should first set the following properties:

• Schema：ADLSGen2 に設定。
• Account：ストレージアカウント名に設定。
• FileSystem：このアカウントに使用されるファイルシステム名に設定。例えば、Azure Blob コンテナの名前。
• Directory：（オプション）複製されたファイルを格納するために使用されるパスに設定。指定しない場合は、ルートディレクトリが使用されます。

Azure DataLakeStorage Gen 2 への認証

Gen 2 supports the following authentication methods: using an AccessKey, using a Shared Access Signature, Azure Active Directory OAuth (AzureAD), Managed Service Identity (AzureMSI).

Access Key を使用した認証

To connect using a Shared Access Signature set the AccessKey property and the AuthScheme to AccessKey.

You can obtain an access key for the ADLS Gen2 storage account using the Azure portal:

1. Go to your ADLS Gen2 Storage Account in the Azure portal.
2. 設定で［アクセスキー］を選択します。
3. Copy the value for one of the available access keys to the AccessKey connection property.

共有アクセス署名（SAS）

To connect using a Shared Access Signature set the SharedAccessSignature property to a valid signature of a resource to connect to and the AuthScheme to SAS. The SharedAccessSignature may be generated with a tool such as Azure Storage Explorer.

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 Data Lake Storage のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。

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

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

Web アプリケーション

Web アプリケーションを使用してAzure AD 経由で認証する場合は、Azure Data Lake Storage にカスタムOAuth アプリケーションを登録する必要があります（Azure AD アプリケーションの作成 を参照）。 それから本製品 を使用してOAuth トークンの値を取得および管理します。

Azure AD OAuth アクセストークンの取得

はじめに、以下の接続プロパティを設定してOAuthAccessToken を取得します。

• AuthScheme：AzureAD。
• OAuthClientId：アプリケーション設定のクライアントId。
• OAuthClientSecret：アプリケーション設定のクライアントシークレット。

次に、ストアドプロシージャを呼び出してOAuth 交換を完了します。

1. GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。AuthMode インプットをWEB に、CallbackURL インプットをアプリケーション設定で指定したリダイレクトURI に設定します。必要に応じて、Permissions パラメータを設定してカスタム権限をリクエストします。
   ストアドプロシージャがOAuth エンドポイントのURL を返します。
2. URL を開き、ログインして、アプリケーションを認可します。コールバックURL にリダイレクトされます。
3. GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode インプットをWEB に設定します。Verifier インプットを、コールバックURL のクエリ文字列の"code" パラメータに設定します。必要に応じて、Permissions パラメータを設定してカスタム権限をリクエストします。

アクセストークンとリフレッシュトークンを取得すると、データに接続し、Azure AD アクセストークンを自動または手動でリフレッシュすることができるようになります。

Azure AD OAuth アクセストークンの自動リフレッシュ

本製品 がAzure AD OAuth アクセストークンを自動的にリフレッシュするようにするには、データへの初回接続時に以下のパラメータを設定します。

• AuthScheme：AzureAD。
• InitiateOAuth：REFRESH。
• OAuthClientId：アプリケーション設定のクライアントId。
• OAuthClientSecret：アプリケーション設定のクライアントシークレット。
• OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークン。
• OAuthRefreshToken：GetOAuthAccessToken によって返されたリフレッシュトークン。
• OAuthSettingsLocation：ドライバーがOAuth トークン値を保存する場所。これは接続間で維持されます。

それ以降のデータ接続では、OAuthAccessToken とOAuthRefreshToken の値はOAuthSettingsLocation から取得され、接続時に設定する必要はありません。

Azure AD OAuth アクセストークンの手動リフレッシュ

データ接続時に手動でAzure AD OAuth アクセストークンをリフレッシュするために必要な値は、OAuth リフレッシュトークンのみです。

GetOAuthAccessToken が返すExpiresIn パラメータ値が経過した後に、RefreshOAuthAccessToken ストアドプロシージャを使用して手動でOAuthAccessToken をリフレッシュし、次の接続プロパティを設定します。

• OAuthClientId：アプリケーション設定のクライアントId。
• OAuthClientSecret：アプリケーション設定のクライアントシークレット。

ここでRefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを指定します。新しいトークンが取得できたら、OAuthAccessToken をRefreshOAuthAccessToken が返す値に設定し、新しい接続をオープンします。

最後に、OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

ヘッドレスマシン

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

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

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

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

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

   カスタムアプリケーションのみ： 次のプロパティを設定して、Authorization URL を作成します。

   • InitiateOAuth：OFF。
   • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId。
   • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレット。

   カスタムアプリケーションおよび埋め込みアプリケーション：GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。

   1. ストアドプロシージャによって返されたURL をブラウザで開きます。
   2. ログインして、本製品 にアクセス許可を与えます。verifier code を含むコールバックURL にリダイレクトされます。
   3. verifier code の値を保存します。この値は後でOAuthVerifier 接続プロパティを設定する際に使用します。

2. OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換します。

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

   • AuthScheme：AzureAD。
   • InitiateOAuth：REFRESH。
   • OAuthVerifier：verifier code。
   • OAuthSettingsLocation：接続間で維持されるOAuth トークンの値を保存するファイルの場所。

   • カスタムアプリケーションのみ：

     • OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId。
     • OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレット。

3. OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットします。

   • InitiateOAuth：REFRESH。
   • OAuthSettingsLocation：暗号化されたOAuth 認証値が保存される場所。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。

   • カスタムアプリケーションのみ：

     • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId。
     • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレット。

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

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

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

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

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

• AuthScheme：AzureAD。
• InitiateOAuth：REFRESH。
• OAuthSettingsLocation：OAuth 設定ファイルの場所。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。

• カスタムアプリケーションのみ：

  • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId。
  • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレット。

Managed Service Identity (MSI)

Azure VM 上でAzure Data Lake Storage を実行しており、MSI を利用して接続したい場合は、AuthScheme をAzureMSI に設定します。

User-Managed Identities

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

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