このページでは、CData Cloud でのMicrosoft Power BI XMLA への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Microsoft Power BI XMLA への接続

接続の確立 は、CData Cloud にデータベースを作成するためのMicrosoft Power BI XMLA への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してMicrosoft Power BI XMLA からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

Database タブで対応するアイコンを選択して、Microsoft Power BI XMLA に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Microsoft Power BI XMLA への接続

接続するには、Workspace プロパティを有効なPowerBIXMLA ワークスペースに設定します（例：CData）。

Microsoft Power BI XMLA への認証

Azure AD

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

Azure サービスプリンシパル

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

Azure サービスプリンシパル認証を使用するには、以下を行います。

• 認証アプリケーションにロールを割り当てる機能を設定します。これには、カスタムOAuth アプリの作成 で説明するように、カスタムOAuth AD アプリケーションを作成します。
• Azure AD テナントにアプリケーションを登録し、ロールベースのアクセス制御で使用できる新しいサービスプリンシパルを作成して、サブスクリプション内のリソースにアクセスします。

以下の手順に従います。

1. カスタムOAuth アプリの作成 での説明のとおりに、カスタムAzure AD アプリケーションを作成します。
2. アプリケーションへのロールの割り当て：
   1. 検索バーを使用してサブスクリプションサービスを検索します。
   2. サブスクリプションページを開きます。
   3. アプリケーションを割り当てるサブスクリプションを選択します。
   4. アクセス制御（IAM）を開きます。
   5. 追加 -> ロールの割り当ての追加を選択します。Microsoft Power BI XMLA はロールの割り当ての追加ページを開きます。
   6. 作成したカスタムAzure AD アプリケーションに所有者ロールを割り当てます。

管理者の同意

管理者の同意は、Azure Active Directory テナントの管理者が、管理者の同意を明示的に必要とするカスタムアプリケーションに権限を付与する場合に行います。

Azure ポータルで新しいAzure AD アプリケーションを作成する場合には、アプリケーションに必要なアクセス許可を指定する必要があります。一部のアクセス許可には、「管理者の同意が必要」と記載されている場合があります。 例えば、すべてのグループのアクセス許可には管理者の同意が必要です。アプリケーションが管理者の同意を必要とする場合、方法は2つあります。

管理者の同意を付与する最も簡単な方法は、管理者がportal.azure.com にログインして、アプリの登録で作成したアプリケーションに移動することです。API のアクセス許可で、 同意の付与をクリックします。これにより、アプリケーションが作成されたテナントにアクセス権限が付与されます。

組織に複数のテナントがある場合、または組織外の他のテナントにアプリのアクセス許可を与える必要がある場合、GetAdminConsentURL ストアドプロシージャを使用してAdmin Authorization URL を生成します。GetOAuthAuthorizationUrl ストアドプロシージャとは異なり、このエンドポイントから返される重要な情報はありません。代わりに、OAuth アプリケーションが正常に認可されると、アクセス権限が付与されたことを示すBoolean 値が返されます。

管理者がOAuth アプリケーションを承認後、認証を続行できます。

クライアントクレデンシャル

クライアント資格情報は、直接ユーザー認証が行われないOAuth のフローを指します。代わりに、クレデンシャルはアプリケーション自体のためだけに作成されます。アプリケーションで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで実行されます。そのため、認証フローが標準フローとは少し違ったものになります。

クライアントOAuth フローに関連するすべてのアクセス許可には、管理者の同意が必要です。これは、CData Cloud が埋め込まれたアプリケーションをクライアントOAuth フローでは使用できないことを意味します。クライアント資格情報を使用するには、独自のOAuth アプリケーションの作成が必要になります。詳しくは、カスタムOAuth アプリの作成 を参照してください。

portal.azure.com の［アプリの登録］で［API のアクセス許可］に移動し、Microsoft Graph アクセス許可を選択します。アクセス許可には2つの異なるアクセス許可セットがあります。委任されたアクセス許可とアプリケーションの許可です。クライアントの資格情報認証時に使用されるアクセス許可は、［アプリケーションの許可］の下にあります。

インテグレーションに必要なアクセス許可を選択します。その後、次の接続プロパティを設定します。

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

クライアント資格情報での認証は、他の接続同様に自動的に行われますが、ユーザーにプロンプトするウィンドウは表示されません。ユーザーコンテキストがないため、ブラウザのポップアップは必要ないからです。接続が行われ、内部的に処理されます。

Auth Certificate

Auth Certificate は、証明書を使用してサーバー間認証を可能にするOAuth フローを指します。クライアントOAuth フローに関連するすべてのアクセス許可には、管理者の同意が必要です。これは、CData Cloud が埋め込まれたアプリケーションをクライアントOAuth フローでは使用できないことを意味します。OAuth 証明書を使用するには、独自のOAuth アプリケーションの作成が必要になります。 詳しくは、カスタムOAuth アプリの作成 を参照してください。

portal.azure.com の［アプリの登録］でAPI のアクセス許可に移動し、クライアントのGraph アクセス許可を選択します。アクセス許可には2つの異なるアクセス許可セットがあります。委任されたアクセス許可とアプリケーションの許可です。証明書認証時に使用されるアクセス許可は、［アプリケーションの許可］の下にあります。

自身のインテグレーションに適用させるアクセス許可を選択します。その後、次の接続プロパティを設定します。

• AuthScheme：AzureServicePrincipalCert。
• AzureTenant：接続するテナント。
• OAuthJWTCert：JWT 証明書のストア。
• OAuthJWTIssuer：OAuth クライアントId。
• OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類。

証明書の認証は自動で行われます。ユーザーコンテキストがないため、認証が発生したことを知らせるポップアップはありません。 接続は内部で行われ、処理されます。

カスタムOAuth アプリケーションの作成

Microsoft Power BI XMLA は、Azure AD、Azure サービスプリンシパルを使用する認証をサポートします。これらは、いずれもOAuth ベースです。

このトピックでは、以下の方法を説明します。

• Azure AD またはAzure サービスプリンシパル用のカスタムOAuth アプリケーションの作成と登録
• カスタムOAuth アプリケーションに管理者の同意を提供
• クライアント資格情報で使用するカスタムOAuth アプリケーションの作成

Azure AD

portal.azure.com で：

1. https://portal.azure.com にログインします。
2. 左側のナビゲーションペインでAzure Active Directory -> アプリの登録を選択します。
3. 新規登録をクリックします。
4. アプリケーションの名前を入力します。
5. シングルかマルチテナントか、パブリックかプライベートか、希望するテナント設定を選択します。
   • デフォルトのオプション［この組織ディレクトリ内のアカウントのみ］を選択する場合は、CData Cloud への接続を確立するときにAzureTenant 接続プロパティをAzure AD テナントのId に設定する必要があります。それ以外の場合は、認証に失敗しエラーが発生します。
   • アプリケーションが個人使用のみの場合は、この組織ディレクトリ内のアカウントのみを指定します。
   • アプリケーションを配布する場合は、マルチテナントオプションのいずれか1つを選択してください。

6. リダイレクトURL をhttp://localhost:33333（Cloud のデフォルト）に設定するか、または別のポートを指定し、CallbackURL を定義した正確なリプライURL に設定します。
7. 登録をクリックして新しいアプリケーションを登録します。アプリケーション管理画面が表示されます。
   OAuthClientId としてApplication (client) ID の値、AzureTenant としてDirectory (tenant) ID の値をメモします。
8. 証明書とシークレットセクションに移動して、アプリケーションの認証タイプを定義します。認証には、証明書（推奨）とクライアントシークレットの2種類があります。
   • 証明書による認証：証明書とシークレットで証明書のアップロードを選択し、ローカルマシンから証明書をアップロードします。
   • 新しいクライアントシークレットの作成：証明書とシークレットで新しいクライアントシークレットを選択し、有効期限を指定します。クライアントシークレットが保存されると、Microsoft Power BI XMLA はキーの値を表示します。 表示は一度のみなのでこの値をコピーします。 この値がOAuthClientSecret となります。

9. API のアクセス許可 -> アクセス許可の追加 -> 委任されたアクセス許可を選択します。
10. Select Power BI Service -> Delegated Permissions -> Dataset.Read.All and Workspace.Read.All.
11. 変更を保存します。
12. 管理者の同意が必要なアクセス許可（［アプリケーションの許可］など）を使用することを指定した場合は、API のアクセス許可ページで現在のテナントから付与することができます。

Azure サービスプリンシパル

Azure サービスプリンシパル認証を使用するには、認証アプリケーションにロールを割り当てる機能を設定したのち、Azure AD テナントにアプリケーションを登録し、新しい サービスプリンシパルを作成する必要があります。この新しいサービスプリンシパルは、割り当てられたロールベースのアクセス制御を利用して、サブスクリプション内のリソースにアクセスできます。

portal.azure.com で：

1. 前述のように、カスタムOAuth AD アプリケーションを作成します。
2. 検索バーを使用してサブスクリプションサービスを検索します。
3. サブスクリプションページを開きます。
4. アプリケーションを割り当てるサブスクリプションを選択します。
5. アクセス制御（IAM）を開きます。
6. 追加 -> ロールの割り当ての追加を選択します。Microsoft Power BI XMLA はロールの割り当ての追加ページを開きます。
7. 作成したカスタムAzure AD アプリケーションに所有者ロールを割り当てます。

管理者の同意

カスタムアプリケーションの中には、Azure Active Directory テナント内で操作するために管理者権限が必要なものがあります。管理者の同意は、新しいカスタムOAuth アプリケーションを作成する際に、すでに"Admin Consent Required" とマークされている関連パーミッションを追加することで付与できます。管理者の同意は、OAuth フローでクライアント資格情報を使用する場合にも必要です。

管理者の同意を付与するには：

1. 管理者にportal.azure.com にログインしてもらいます。
2. アプリの登録に移動し、作成したカスタムOAuth アプリケーションを見つけます。
3. API のアクセス許可で、同意の付与をクリックします。

これで、アプリケーションが作成されたテナントにアクセス権限が付与されます。

クライアント資格情報の同意

OAuth は、認証のためのクライアント資格情報の使用をサポートします。クライアント資格情報のOAuth フローでは、認証するアプリケーション自身の資格情報が作成されます。認証フローは通常の認証フローと同じように動作しますが、関連するユーザーに対して資格情報の提供を求めるプロンプトは表示されません。 アプリケーションで受理されるすべてのタスクは、デフォルトユーザーコンテキストなしで実行されます。

Note：埋め込まれたOAuth 資格情報はユーザーごとに認証されるため、クライアントOAuth フローで使用することはできません。 クライアント資格情報を使用するには、必ずカスタムOAuth アプリケーションを作成する必要があります。

portal.azure.com で：

1. 前述のように、カスタムOAuth アプリケーションを作成します。
2. アプリの登録に移動します。
3. 作成したアプリケーションを探し、API のアクセス許可を開きます。
4. Microsoft Graph アクセス許可を選択します。 アクセス許可には2つの異なるアクセス許可セットがあります。委任されたアクセス許可とアプリケーションの許可です。
5. Application Permissions で、インテグレーションに必要なアクセス許可を選択します。

証明書を使用したクライアントOAuth フロー

クライアントOAuth フローに関連するすべてのアクセス許可には、管理者の同意が必要です。これは、CData Cloud が埋め込まれたアプリケーションをクライアントOAuth フローでは使用できないことを意味します。前述のとおり、クライアント資格情報を使用するには、独自のOAuth アプリケーションの作成が必要になります。

OAuth アプリケーションが作成されたら：

1. portal.azure.com に戻ります。
2. アプリの登録に移動します。
3. 作成したアプリケーションを見つけます。
4. API のアクセス許可の下で、Microsoft Graph アクセス許可を選択します。
   アクセス許可には2つの異なるアクセス許可セットがあります。委任されたアクセス許可とアプリケーションの許可です。クライアントの資格情報認証時に使用されるアクセス許可は、［アプリケーションの許可］の下にあります。
5. 自身のインテグレーションに適用させるアクセス許可を選択します。

カスタムOAuth アプリケーションの作成

Microsoft Power BI XMLA は、Azure AD、Azure サービスプリンシパルを使用する認証をサポートします。これらは、いずれもOAuth ベースです。

このトピックでは、以下の方法を説明します。

• Azure AD またはAzure サービスプリンシパル用のカスタムOAuth アプリケーションの作成と登録
• カスタムOAuth アプリケーションに管理者の同意を提供
• クライアント資格情報で使用するカスタムOAuth アプリケーションの作成

Azure AD

portal.azure.com で：

1. https://portal.azure.com にログインします。
2. 左側のナビゲーションペインでAzure Active Directory -> アプリの登録を選択します。
3. 新規登録をクリックします。
4. アプリケーションの名前を入力します。
5. シングルかマルチテナントか、パブリックかプライベートか、希望するテナント設定を選択します。
   • デフォルトのオプション［この組織ディレクトリ内のアカウントのみ］を選択する場合は、CData Cloud への接続を確立するときにAzureTenant 接続プロパティをAzure AD テナントのId に設定する必要があります。それ以外の場合は、認証に失敗しエラーが発生します。
   • アプリケーションが個人使用のみの場合は、この組織ディレクトリ内のアカウントのみを指定します。
   • アプリケーションを配布する場合は、マルチテナントオプションのいずれか1つを選択してください。

6. リダイレクトURL をhttp://localhost:33333（Cloud のデフォルト）に設定するか、または別のポートを指定し、CallbackURL を定義した正確なリプライURL に設定します。
7. 登録をクリックして新しいアプリケーションを登録します。アプリケーション管理画面が表示されます。
   OAuthClientId としてApplication (client) ID の値、AzureTenant としてDirectory (tenant) ID の値をメモします。
8. 証明書とシークレットセクションに移動して、アプリケーションの認証タイプを定義します。認証には、証明書（推奨）とクライアントシークレットの2種類があります。
   • 証明書による認証：証明書とシークレットで証明書のアップロードを選択し、ローカルマシンから証明書をアップロードします。
   • 新しいクライアントシークレットの作成：証明書とシークレットで新しいクライアントシークレットを選択し、有効期限を指定します。クライアントシークレットが保存されると、Microsoft Power BI XMLA はキーの値を表示します。 表示は一度のみなのでこの値をコピーします。 この値がOAuthClientSecret となります。

9. API のアクセス許可 -> アクセス許可の追加 -> 委任されたアクセス許可を選択します。
10. Select Power BI Service -> Delegated Permissions -> Dataset.Read.All and Workspace.Read.All.
11. 変更を保存します。
12. 管理者の同意が必要なアクセス許可（［アプリケーションの許可］など）を使用することを指定した場合は、API のアクセス許可ページで現在のテナントから付与することができます。

Azure サービスプリンシパル

Azure サービスプリンシパル認証を使用するには、認証アプリケーションにロールを割り当てる機能を設定したのち、Azure AD テナントにアプリケーションを登録し、新しい サービスプリンシパルを作成する必要があります。この新しいサービスプリンシパルは、割り当てられたロールベースのアクセス制御を利用して、サブスクリプション内のリソースにアクセスできます。

portal.azure.com で：

1. 前述のように、カスタムOAuth AD アプリケーションを作成します。
2. 検索バーを使用してサブスクリプションサービスを検索します。
3. サブスクリプションページを開きます。
4. アプリケーションを割り当てるサブスクリプションを選択します。
5. アクセス制御（IAM）を開きます。
6. 追加 -> ロールの割り当ての追加を選択します。Microsoft Power BI XMLA はロールの割り当ての追加ページを開きます。
7. 作成したカスタムAzure AD アプリケーションに所有者ロールを割り当てます。

管理者の同意

カスタムアプリケーションの中には、Azure Active Directory テナント内で操作するために管理者権限が必要なものがあります。管理者の同意は、新しいカスタムOAuth アプリケーションを作成する際に、すでに"Admin Consent Required" とマークされている関連パーミッションを追加することで付与できます。管理者の同意は、OAuth フローでクライアント資格情報を使用する場合にも必要です。

管理者の同意を付与するには：

1. 管理者にportal.azure.com にログインしてもらいます。
2. アプリの登録に移動し、作成したカスタムOAuth アプリケーションを見つけます。
3. API のアクセス許可で、同意の付与をクリックします。

これで、アプリケーションが作成されたテナントにアクセス権限が付与されます。

クライアント資格情報の同意

OAuth は、認証のためのクライアント資格情報の使用をサポートします。クライアント資格情報のOAuth フローでは、認証するアプリケーション自身の資格情報が作成されます。認証フローは通常の認証フローと同じように動作しますが、関連するユーザーに対して資格情報の提供を求めるプロンプトは表示されません。 アプリケーションで受理されるすべてのタスクは、デフォルトユーザーコンテキストなしで実行されます。

Note：埋め込まれたOAuth 資格情報はユーザーごとに認証されるため、クライアントOAuth フローで使用することはできません。 クライアント資格情報を使用するには、必ずカスタムOAuth アプリケーションを作成する必要があります。

portal.azure.com で：

1. 前述のように、カスタムOAuth アプリケーションを作成します。
2. アプリの登録に移動します。
3. 作成したアプリケーションを探し、API のアクセス許可を開きます。
4. Microsoft Graph アクセス許可を選択します。 アクセス許可には2つの異なるアクセス許可セットがあります。委任されたアクセス許可とアプリケーションの許可です。
5. Application Permissions で、インテグレーションに必要なアクセス許可を選択します。

証明書を使用したクライアントOAuth フロー

クライアントOAuth フローに関連するすべてのアクセス許可には、管理者の同意が必要です。これは、CData Cloud が埋め込まれたアプリケーションをクライアントOAuth フローでは使用できないことを意味します。前述のとおり、クライアント資格情報を使用するには、独自のOAuth アプリケーションの作成が必要になります。

OAuth アプリケーションが作成されたら：

1. portal.azure.com に戻ります。
2. アプリの登録に移動します。
3. 作成したアプリケーションを見つけます。
4. API のアクセス許可の下で、Microsoft Graph アクセス許可を選択します。
   アクセス許可には2つの異なるアクセス許可セットがあります。委任されたアクセス許可とアプリケーションの許可です。クライアントの資格情報認証時に使用されるアクセス許可は、［アプリケーションの許可］の下にあります。
5. 自身のインテグレーションに適用させるアクセス許可を選択します。

Microsoft Power BI XMLA は、データをキューブとして公開するOLAP データベースで、MDX（マルチディメンション式）でクエリします。 Cloud は、これらのキューブをSQL-92 でクエリできるリレーショナルビューにモデル化します。以下のマッピングは、モデルのレイアウト用です：

• Catalog - Cloud にカタログとして表示されます。
• Cube - Cloud にスキーマとして表示されます。
• Measure - Cloud の特別なMeasures ビューの下で利用可能です。
• Dimension - 各ディメンションはビューとして公開されます。
• Level - 階層の個々のレベルは、適切なディメンションビューのカラムとして公開されます。

メジャーとディメンションの結合

特定のレベル値ごとにメジャーを取得するには、Measure ビューと任意のDimension もしくはディメンションのセット間でJOIN を発行します。 例えば、次のように発行すると、各都市の顧客数を取得できます。

SELECT m.[Customer Count], c.[City] 
FROM [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Customer AS c 
INNER JOIN [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Measures AS m

ON 条件は必要ないことに注意してください。これは、テーブルがMicrosoft Power BI XMLA ですでに適切に関連付けられているためです。 ON 条件を必要とするツールを使用している場合は、IncludeJoinColumns をtrue に設定してください。 これにより、各ビューに複数の外部キーカラムが追加され、相互に関連付けられます。 これらのカラムはそれ自体ではデータを返しませんが、必要に応じて結合のON 条件を構築するツールを使用して自動的に取得できます。

データの集計

Microsoft Power BI XMLA に格納されているデータはすでに集計済みです。多くの場合、集計を取得しようとすることは、何も指定しないことと構文的に同じになるかもしれません。 例えば、次のクエリは、前のクエリとまったく同じデータを返します。

SELECT SUM(m.[Customer Count]), c.[City] 
FROM [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Customer AS c 
INNER JOIN [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Measures AS m
GROUP BY c.[City]

このルールの例外は、フィルタリングされた結果の集計がリクエストされた場合です。 そのような場合、計算はMicrosoft Power BI XMLA からリクエストされます。例えば、 フランスとドイツの顧客の合計と平均を計算するには：

SELECT SUM(m.[Customer Count]), AVG(m.[Customer Count]), c.[Country] 
FROM [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Customer AS c 
INNER JOIN [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Measures AS m
WHERE c.[Country] IN ('France', 'Germany')
GROUP BY c.[Country]

複数の階層の選択

Microsoft Power BI XMLA では、個々のディメンジョンは、1つ以上のレベルを持つ階層で構成されています。例えば、 AdventureWorks Customers テーブルにはCity、Country およびGender があります。City とCountry は同じ階層の一部ですが、 Gender は独自の階層です。

複数の階層を選択する場合、これをサポートする方法はMDX の値をクロス結合することです。Cloud が提示するデータのリレーショナルテーブルモデルからは明らかではありませんが、これにより非常に負荷の高いクエリが実行される可能性があります。 例えば、次のように実行すると：

SELECT c.[Country], m.[Customer Count]
FROM [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Customer AS c 
INNER JOIN [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Measures AS m

結果は6行になります。しかし、Gender も選択すると：

SELECT c.[Country], c.[Gender], m.[Customer Count]
FROM [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Customer AS c 
INNER JOIN [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Measures AS m

結果は12行になります。これは、Gender とCountry が異なる階層にあるため、両方一緒に返すにはクロス結合が必要だからです。 SELECT に追加された各階層は、その階層で利用可能な値の数で合計結果を乗算します。 したがって、期待する行数を取得するには、次のように実行します：

SELECT (COUNT(c.[Country])*COUNT(c.[Gender])) AS totalrows
FROM [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Customer AS c 

応答行の制限

複数の階層を選択すると、結果行の合計数が倍になるため、応答行の数が非常に速く膨らみタイムアウトが発生します。 どのクエリが非常に高負荷になるかをある程度可視化するために、理想的な設定に導くメカニズムとしてResponseRowLimit 接続プロパティが追加されました。 設定すると、クエリが実行される前に予想される行数が計算されます。 予想された行の数が制限を超えると、クエリで予想される行数を表示するエラーがスローされます。

必要なカラムのみを選択するか、WHERE 条件を適用することをお勧めします。どちらも応答行の数を大幅に減らすことができ、パフォーマンスに大きな影響を与えます。 Cloud に精通していて、どのクエリが高負荷になる可能性があるかをすでにお分かりの場合は、ResponseRowLimit を0に設定することで無効にできます。

データアクセスのファインチューニング

以下は、データ接続をよりきめ細かく制御できるプロパティです。

• UseMDX：MDX クエリが送信されているかどうかを示します。デフォルトではこれはfalse で、ドライバーはSQL-92 準拠のクエリのみを受け入れます。

  このプロパティをtrue に設定すると、すべてのクエリが直接Microsoft Power BI XMLA に渡されます。

• ExtraProperties：MDX クエリと併せて送信する追加のプロパティ。UseMDX がtrue の場合にのみ意味があります。
• IncludeJoinColumns：結合でON 条件を作成するために使用される余分なカラムを追加する必要があるかどうかを示すboolean。

  これらは値を返しません。結合を作成するときにテーブル間のリレーションシップを自動的に設定するために、それらを必要とするツールを有効にするために純粋に追加されています。

• ResponseRowLimit：エラーを返す前にユーザーが選択できるように、計算上の行数の制限を設定します。

  クエリはMDX に変換されているため、少数のカラムのみを選択すると、期待される結果の数が指数関数的に倍になることがあります。

  このため、ResponseRowLimit はどのタイプのクエリがタイムアウトになる可能性が高いかについて、いくつかのガイダンスを提供するために利用できます。 0に設定すると無効にできます。

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

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

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

概要

このセクションでは、利用可能なAPI オブジェクトを示し、Microsoft Power BI XMLA API へのSQL の実行について詳しく説明します。

Cloud は、ディメンションをテーブル、キューブをスキーマとしてモデル化し、ワークスペースとデータセットカタログの組み合わせをカタログとしてモデル化します。 Cloud は、Workspace プロパティにワークスペースのカンマ区切りリストを指定することで、複数のワークスペースへの同時接続をサポートします。 その結果、各ワークスペースは、WorkspaceName_CatalogName としてカタログに表示されます。

主要機能

• Cloud はドキュメント、フォルダ、およびグループなどのMicrosoft Power BI XMLA エンティティをリレーショナルビューとしてモデル化し、SQL を記述してMicrosoft Power BI XMLA データをクエリできるようにします。
• ストアドプロシージャを使用するとMicrosoft Power BI XMLA の操作を実行できます。
• これらのオブジェクトへのライブ接続により、Cloud を使用するとMicrosoft Power BI XMLA アカウントへのあらゆる変更が即座に反映されます。

Measure Attributes

By default, all measure attributes are listed in a 'Measures' view. However, you can set SplitMeasures to 'true' to split the measures view; the result is each measure attribute is included in its respective view based on the Measure Group value. Further classification based on 'Measure Directories' is not included.

ストアドプロシージャ

ストアドプロシージャ は、Microsoft Power BI XMLA のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、オブジェクトのダウンロードやエンベロープの移動など、Microsoft Power BI XMLA の操作を実行できます。

ストアドプロシージャはファンクションライクなインターフェースで、Microsoft Power BI XMLA の単純なSELECT 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにMicrosoft Power BI XMLA から関連するレスポンスデータを返します。

CData Cloud - Microsoft Power BI XMLA ストアドプロシージャ

Name	Description
GetAdminConsentURL	Gets the admin consent URL that must be opened separately by an admin of a given domain to grant access to your application. Only needed when using custom OAuth credentials.

Gets the admin consent URL that must be opened separately by an admin of a given domain to grant access to your application. Only needed when using custom OAuth credentials.

Input

Name	Type	Required	Description
CallbackUrl	String	False	The URL the user will be redirected to after authorizing your application. This value must match the Reply URL in the Azure AD app settings.
State	String	False	The same value for state that you sent when you requested the authorization code.

Result Set Columns

Name	Type	Description
URL	String	The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app.

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、Microsoft Power BI XMLA のデータベースメタデータを返します。

• sys_catalogs：利用可能なデータベースをリスト。
• sys_schemas：利用可能なスキーマをリスト。
• sys_tables：利用可能なテーブルおよびビューをリスト。
• sys_tablecolumns：利用可能なテーブルおよびビューのカラムについて説明。
• sys_procedures：利用可能なストアドプロシージャについて説明。
• sys_procedureparameters：ストアドプロシージャパラメータについて説明。
• sys_keycolumns：主キーおよび外部キーについて説明。
• sys_indexes：利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

• sys_connection_props：利用可能な接続プロパティについての情報を返す。
• sys_sqlinfo：Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

• sys_identity：バッチ処理または単一の更新に関する情報を返す。

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	データベース名。

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	データベース名。
SchemaName	String	スキーマ名。

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベース。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	テーブル名またはビュー名。
TableType	String	テーブルの種類（テーブルまたはビュー）。
Description	String	テーブルまたはビューの説明。
IsUpdateable	Boolean	テーブルが更新可能かどうか。

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、[AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Customer テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Customer' AND CatalogName='AdventureWorksDW2012Multidimensional-SE' AND SchemaName='Adventure Works'

Columns

Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベースの名前。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	カラムを含むテーブルまたはビューの名前。
ColumnName	String	カラム名。
DataTypeName	String	データ型の名前。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length	Int32	カラムのストレージサイズ。
DisplaySize	Int32	指定されたカラムの通常の最大幅（文字数）。
NumericPrecision	Int32	数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ（文字数）。
NumericScale	Int32	カラムのスケール（小数点以下の桁数）。
IsNullable	Boolean	カラムがNull を含められるかどうか。
Description	String	カラムの簡単な説明。
Ordinal	Int32	カラムのシーケンスナンバー。
IsAutoIncrement	String	カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn	String	生成されたカラムであるかどうか。
IsHidden	Boolean	カラムが非表示かどうか。
IsArray	Boolean	カラムが配列かどうか。
IsReadOnly	Boolean	カラムが読み取り専用かどうか。
IsKey	Boolean	sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベース。
SchemaName	String	ストアドプロシージャを含むスキーマ。
ProcedureName	String	ストアドプロシージャの名前。
Description	String	ストアドプロシージャの説明。
ProcedureType	String	PROCEDURE やFUNCTION などのプロシージャのタイプ。

ストアドプロシージャパラメータについて説明します。

次のクエリは、SelectEntries ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2

Columns

Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベースの名前。
SchemaName	String	ストアドプロシージャを含むスキーマの名前。
ProcedureName	String	パラメータを含むストアドプロシージャの名前。
ColumnName	String	ストアドプロシージャパラメータの名前。
Direction	Int32	パラメータのタイプに対応する整数値：input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataTypeName	String	データ型の名前。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length	Int32	文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericPrecision	Int32	数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ（文字数）。
NumericScale	Int32	数値データの小数点以下の桁数。
IsNullable	Boolean	パラメータがNull を含められるかどうか。
IsRequired	Boolean	プロシージャの実行にパラメータが必要かどうか。
IsArray	Boolean	パラメータが配列かどうか。
Description	String	パラメータの説明。
Ordinal	Int32	パラメータのインデックス。

主キーおよび外部キーについて説明します。

次のクエリは、[AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Customer テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Customer' AND CatalogName='AdventureWorksDW2012Multidimensional-SE' AND SchemaName='Adventure Works'
          

Columns

Name	Type	Description
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前
IsKey	Boolean	カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey	Boolean	カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName	String	主キーの名前。
ForeignKeyName	String	外部キーの名前。
ReferencedCatalogName	String	主キーを含むデータベース。
ReferencedSchemaName	String	主キーを含むスキーマ。
ReferencedTableName	String	主キーを含むテーブル。
ReferencedColumnName	String	主キーのカラム名。

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

名前	タイプ	説明
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前
PrimaryKeyName	String	主キーの名前。
ForeignKeyName	String	外部キーの名前。
ReferencedCatalogName	String	主キーを含むデータベース。
ReferencedSchemaName	String	主キーを含むスキーマ。
ReferencedTableName	String	主キーを含むテーブル。
ReferencedColumnName	String	主キーのカラム名。
ForeignKeyType	String	外部キーがインポート（他のテーブルを指す）キーかエクスポート（他のテーブルから参照される）キーかを指定します。

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前。
KeySeq	String	主キーのシーケンス番号。
KeyName	String	主キーの名前。

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	インデックスを含むデータベースの名前。
SchemaName	String	インデックスを含むスキーマの名前。
TableName	String	インデックスを含むテーブルの名前。
IndexName	String	インデックス名。
ColumnName	String	インデックスに関連付けられたカラムの名前。
IsUnique	Boolean	インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary	Boolean	インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type	Int16	インデックスタイプに対応する整数値：statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder	String	並べ替え順序：A が昇順、D が降順。
OrdinalPosition	Int16	インデックスのカラムのシーケンスナンバー。

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

このテーブルをクエリする際は、config 接続文字列を使用する必要があります。

jdbc:cdata:powerbixmla:config:

この接続文字列を使用すると、有効な接続がなくてもこのテーブルをクエリできます。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	接続プロパティ名。
ShortDescription	String	簡単な説明。
Type	String	接続プロパティのデータ型。
Default	String	明示的に設定されていない場合のデフォルト値。
Values	String	可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value	String	設定した値またはあらかじめ設定されたデフォルト。
Required	Boolean	プロパティが接続に必要かどうか。
Category	String	接続プロパティのカテゴリ。
IsSessionProperty	String	プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity	String	プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName	String	キャメルケースの短縮形の接続プロパティ名。
Ordinal	Int32	パラメータのインデックス。
CatOrdinal	Int32	パラメータカテゴリのインデックス。
Hierarchy	String	このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible	Boolean	プロパティが接続UI に表示されるかどうかを通知します。
ETC	String	プロパティに関するその他のさまざまな情報。

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

名前	説明	有効な値
AGGREGATE_FUNCTIONS	サポートされている集計関数。	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	COUNT 関数がサポートされているかどうか。	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	識別子をエスケープするための開始文字。	[
IDENTIFIER_QUOTE_CLOSE_CHAR	識別子をエスケープするための終了文字。	]
SUPPORTED_OPERATORS	サポートされているSQL 演算子。	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	サポートされている外部結合の種類。	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	外部結合がサポートされているかどうか。	YES, NO
SUBQUERIES	サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	サポートされている文字列関数。	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	サポートされている数値関数。	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	サポートされている日付および時刻関数。	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	レプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNS	レプリケーション中に更新判断のカラムとして使用するかどうかを、（指定された順に）チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN	識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTION	プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。	YES, NO
DIALECT	使用するSQL ダイアレクトを示します。
KEY_PROPERTIES	Uniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMAS	プロバイダー用に複数のスキームが存在するかどうかを示します。	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	プロバイダー用に複数のカタログが存在するかどうかを示します。	YES, NO
DATASYNCVERSION	このドライバーにアクセスするために必要な、CData Sync のバージョン。	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	このドライバーのCData Sync カテゴリ。	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	API で提供されている以上の、追加SQL 機能がサポートされているかどうか。	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	バッチ操作がサポートされているかどうか。	YES, NO
SQL_CAP	このドライバーでサポートされているすべてのSQL 機能。	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERY	ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。	YES, NO
PSEUDO_COLUMNS	利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS	値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	レプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTION	サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATE	レプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERY	レプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTION	サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTID	CheckCache 構文を親キーカラムに対して実行するかどうかを示します。	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	スキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。

Columns

Name	Type	Description
NAME	String	SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE	String	サポートされるSQL またはSQL 構文の詳細。

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	データ変更処理から返された、データベース生成Id。
Batch	String	バッチの識別子。1 は単一処理。
Operation	String	バッチ内の処理の結果：INSERTED、UPDATED、またはDELETED。
Message	String	SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Authentication

---

プロパティ	説明
AuthScheme	The type of authentication to use when connecting to Microsoft Power BI XMLA.

Azure Authentication

---

プロパティ	説明
AzureTenant	データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。
AzureEnvironment	接続を確立するときに使用するAzure 環境。

OAuth

---

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

JWT OAuth

---

プロパティ	説明
OAuthJWTCert	JWT 証明書のストア。
OAuthJWTCertType	JWT 証明書を格納するキーストアの種類。
OAuthJWTCertPassword	OAuth JWT 証明書のパスワード。
OAuthJWTCertSubject	OAuth JWT 証明書のサブジェクト。

SSL

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Logging

---

プロパティ	説明
Verbosity	ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。

Schema

---

プロパティ	説明
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Catalog	The Power BI workspace and dataset to use.
IncludeJoinColumns	Set this to true to include extra join columns on each table.

Miscellaneous

---

プロパティ	説明
CustomHeaders	ユーザーが決定したその他のヘッダー（オプション）。
ExposeMemberKeys	Determines if each level should be converted into a measure, allowing calculations to be performed on the measure.
ExpressionInDescription	Set this to true to report expressions as part of the description on measure columns.
ExtraProperties	Additional properties to submit on each MDX request to Microsoft Power BI XMLA
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
ResponseRowLimit	The number of response rows to allow before triggering an error. Set to 0 for no limit.
ShowHiddenEntities	Set this to true to include hidden dimensions, measures and levels.
SplitMeasures	Set this to true to split Measures table into individual tables.
SplitMeasuresOn	Use this property in conjunction with SplitMeasures to set the priority for how measures should be organized into tables.
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UseMDX	Set this to true to pass MDX queries to Microsoft Power BI XMLA as-is.
Workspace	The comma separated PowerBI workspace(s) to connect to.

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

---

プロパティ	説明
AuthScheme	The type of authentication to use when connecting to Microsoft Power BI XMLA.

The type of authentication to use when connecting to Microsoft Power BI XMLA.

Possible Values

AzureAD, AzureServicePrincipal, AzureServicePrincipalCert

データ型

string

デフォルト値

"AzureAD"

解説

• AzureAD: Set this to perform Azure Active Directory OAuth authentication.
• AzureServicePrincipal: Set this to authenticate as an Azure Service Principal using client credentials.
• AzureServicePrincipalCert: Set this to authenticate as an Azure Service Principal using a certificate.

このセクションでは、本プロバイダーの接続文字列で設定可能なAzure Authentication プロパティの全リストを提供します。

---

プロパティ	説明
AzureTenant	データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。
AzureEnvironment	接続を確立するときに使用するAzure 環境。

データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。

データ型

string

デフォルト値

""

解説

データにアクセスするために使用されるMicrosoft Online テナント。例えば、contoso.onmicrosoft.com です。あるいは、 テナントId を指定します。この値は［Azure ポータル］->［Azure Active Directory］->［プロパティ］のディレクトリId です。

通常、Tenant を指定する必要はありません。OAuthGrantType をCODE（デフォルト）に設定している場合は、Microsoft が自動的に決定します。 ただし、ユーザーがマルチテナントに所属している場合は失敗する可能性があります。 例えば、ドメインA の管理者がドメインB のユーザーをゲストユーザーとして招待した場合。ユーザーは両方のテナントに属していることになります。 Tenant を指定するのはグッドプラクティスですが、一般的には指定しなくてもうまく動作するはずです。

OAuthGrantType をCLIENT に設定する場合は、AzureTenant が必須です。クライアント資格情報を使用する場合、ユーザーコンテキストはありません。 資格情報は、アプリ自体のコンテキストから取得されます。Microsoft ではTenant を指定せずにクライアント資格情報を取得することを許容していますが、使用する特定のテナントを選択する可能性ははるかに低くなっています。 このため、接続するドメインに適用される資格情報を確実に取得するために、すべてのクライアント資格情報接続に対してAzureTenant を明示的に指定する必要があります。

接続を確立するときに使用するAzure 環境。

Possible Values

GLOBAL, CHINA, USGOVT, USGOVTDOD

データ型

string

デフォルト値

"GLOBAL"

解説

ほとんどの場合、環境をグローバルに設定したままにしておくとうまく機能します。ただし、 Azure アカウントが別の環境に追加されている場合は、AzureEnvironment を使用してどの環境かを 指定できます。利用可能な値はGLOBAL、CHINA、USGOVT、USGOVTDOD です。

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

---

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

データ型

string

デフォルト値

""

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

データ型

string

デフォルト値

""

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。

---

プロパティ	説明
OAuthJWTCert	JWT 証明書のストア。
OAuthJWTCertType	JWT 証明書を格納するキーストアの種類。
OAuthJWTCertPassword	OAuth JWT 証明書のパスワード。
OAuthJWTCertSubject	OAuth JWT 証明書のサブジェクト。

JWT 証明書のストア。

データ型

string

デフォルト値

""

解説

クライアント証明書のための証明書ストア名。

OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword でパスワードを指定します。

OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。 詳しくは、OAuthJWTCertSubject フィールドを参照してください。

証明書ストアの指定はプラットフォームに依存します。

Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。

MY	個人証明書と関連付けられた秘密キーを格納している証明書ストア。
CA	証明機関の証明書。
ROOT	ルート証明書。
SPC	ソフトウェア発行元証明書。

Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。

証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ（例えば、PKCS12証明書ストア）に設定する必要があります。

JWT 証明書を格納するキーストアの種類。

データ型

string

デフォルト値

"PEMKEY_BLOB"

解説

このプロパティには次の値の一つを設定できます。

USER	Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。 Note：この種類はJava では利用できません。
MACHINE	Windows の場合、この証明書ストアがシステムストアであることを指定します。 Note：この種類はJava では利用できません。
PFXFILE	この証明書ストアは、証明書を含むPFX（PKCS12）ファイルの名前です。
PFXBLOB	この証明書ストアは、PFX（PKCS12）形式の証明書ストアを表すBase-64でエンコードされた文字列です。
JKSFILE	この証明書ストアは、証明書を含むJava key store（JKS）ファイルの名前です。 Note：この種類はJava のみで利用できます。
JKSBLOB	この証明書ストアは、Java key store（JKS）形式の証明書ストアを表すBase-64でエンコードされた文字列です。 Note：この種類はJava のみで利用できます。
PEMKEY_FILE	この証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。
PEMKEY_BLOB	この証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。
PUBLIC_KEY_FILE	この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。
PUBLIC_KEY_BLOB	この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。
SSHPUBLIC_KEY_FILE	この証明書ストアは、SSH 公開キーを含むファイルの名前です。
SSHPUBLIC_KEY_BLOB	この証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。
P7BFILE	この証明書ストアは、証明書を含むPKCS7 ファイルの名前です。
PPKFILE	この証明書ストアは、PuTTY 秘密キー（PPK）を含むファイルの名前です。
XMLFILE	この証明書ストアは、XML 形式の証明書を含むファイルの名前です。
XMLBLOB	この証明書ストアは、XML 形式の証明書を含む文字列の名前です。

OAuth JWT 証明書のパスワード。

データ型

string

デフォルト値

""

解説

証明書ストアでパスワードが必要である場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。

OAuth JWT 証明書のサブジェクト。

データ型

string

デフォルト値

"*"

解説

証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。

完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。

それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。

"*" に設定すると、証明書ストアの1番目の証明書が選択されます。

証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。 例えば、"CN=www.server.com, OU=test, C=US, [email protected]"。共通のフィールドとその説明は以下のとおりです。

フィールド	説明
CN	共通名。一般的には、www.server.com のようなホスト名です。
O	法人名
OU	法人の部署名
L	法人の住所（市町村名）
S	法人の住所（都道府県）
C	国名
E	Eメールアドレス

フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

データ型

string

デフォルト値

""

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：

説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

---

プロパティ	説明
Verbosity	ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。

ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。

データ型

string

デフォルト値

"1"

解説

Verbosity レベルは、Cloud がLogfile にどの程度の詳細さで記載するかを決定します。1 から5 までのVerbosity レベルがサポートされています。より詳しい説明は、ログ ページに記載されています。

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

---

プロパティ	説明
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Catalog	The Power BI workspace and dataset to use.
IncludeJoinColumns	Set this to true to include extra join columns on each table.

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。

The Power BI workspace and dataset to use.

データ型

string

デフォルト値

""

解説

The Cloud combines each Power BI workspace and dataset into a single catalog name. For example, if you have a workspace called MyWorkspace and a dataset called MyDataset then its catalog name will be MyWorkspace_MyDataset.

By default the Cloud will report all workspaces and datasets as separate catalogs. A query can either use the catalog directly, or leave off the catalog to have the Cloud search for a matching table.

-- Use this specific catalog
SELECT ... FROM MyWorkspace_MyDataset.Model.MyDimension

-- Search for a catalog containing this table
SELECT ... FROM Model.MyDimension

However, if you have enabled UseMDX then you may want to set this value so that MDX queries go to the correct workspace and dataset. The Cloud cannot determine the workspace and dataset automatically from an MDX query.

Set this to true to include extra join columns on each table.

データ型

bool

デフォルト値

false

解説

Some tools may require an ON condition (or generate them automatically) based on foreign key references. By setting IncludeJoinColumns to true, every table will include a foreign key reference to the other tables. These columns will not return any data and are not useful for anything other than passing as ON conditions to perform joins upon.

In Microsoft Power BI XMLA, the dimensions and measures making up the tables are already related naturally. There is no context on which to join them provided. Therefore, the CData Cloud supports joining without specifying an ON condition, so they are optional to specify.

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

---

プロパティ	説明
CustomHeaders	ユーザーが決定したその他のヘッダー（オプション）。
ExposeMemberKeys	Determines if each level should be converted into a measure, allowing calculations to be performed on the measure.
ExpressionInDescription	Set this to true to report expressions as part of the description on measure columns.
ExtraProperties	Additional properties to submit on each MDX request to Microsoft Power BI XMLA
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
ResponseRowLimit	The number of response rows to allow before triggering an error. Set to 0 for no limit.
ShowHiddenEntities	Set this to true to include hidden dimensions, measures and levels.
SplitMeasures	Set this to true to split Measures table into individual tables.
SplitMeasuresOn	Use this property in conjunction with SplitMeasures to set the priority for how measures should be organized into tables.
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UseMDX	Set this to true to pass MDX queries to Microsoft Power BI XMLA as-is.
Workspace	The comma separated PowerBI workspace(s) to connect to.

ユーザーが決定したその他のヘッダー（オプション）。

データ型

string

デフォルト値

""

解説

このプロパティは、他のプロパティ（ContentType、From など）から作成されたHTTP リクエストヘッダーに追加するヘッダーの文字列に設定できます。

ヘッダーは、HTTP の仕様で説明されているとおり、"header: value" 形式でなければなりません。ヘッダー行はキャリッジリターンと改行（CRLF）文字で区切る必要があります。

このプロパティは慎重に使用してください。このプロパティに無効なヘッダーが含まれていると、HTTP リクエストは失敗する場合があります。

このプロパティは、専門的/非標準的なAPI と統合するためにCloud の機能を微調整する場合に便利です。

Determines if each level should be converted into a measure, allowing calculations to be performed on the measure.

データ型

bool

デフォルト値

false

解説

By default, all levels are of type String. Enabling this option allows a level to be resolved down to its key property, creating a measure that has the level's DBType data type. Calculations can then be performed on the measure.

Set this to true to report expressions as part of the description on measure columns.

データ型

bool

デフォルト値

false

解説

The Cloud reports the remarks for several types of entities (dimensions, measures, measure groups and heirarchies) as table and column descriptions. By default, the Cloud will include only the remarks in measure column descriptions.

If this option is enabled, then the measure expression is included in the measure column description, along with the remarks. The descriptions on other types of entities are not affected.

Additional properties to submit on each MDX request to Microsoft Power BI XMLA

データ型

string

デフォルト値

""

解説

When setting UseMDX to true, properties may be specified using this connection property to fill out extra values in the PropertiesList of the XMLA request. Use name=value pairs separated by a semicolon to submit the properties. For example, Catalog=MyCatalog;Cube=MyCube;.

A list of properties may be found by executing SELECT * FROM $System.DISCOVER_PROPERTIES.

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

データ型

int

デフォルト値

-1

解説

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

The number of response rows to allow before triggering an error. Set to 0 for no limit.

データ型

int

デフォルト値

100000

解説

Selecting a lot of columns results in a number of crossjoins occurring under the hood when translated to something that is acceptable for Microsoft Power BI XMLA. This is not intuitive if you are not familiar with MDX. It can easily result in very large responses that time out. The ResponseRowLimit is designed to alert the user to very expensive requests.

Set this to true to include hidden dimensions, measures and levels.

データ型

bool

デフォルト値

false

解説

By default the Cloud does not report entities that Microsoft Power BI XMLA marks as hidden. Enabling this option allows you to query them.

Set this to true to split Measures table into individual tables.

データ型

bool

デフォルト値

false

解説

All measures are currently grouped into a single table 'Measures'. Set this to true to split Measures table into individual tables (if a table only contains measures) and include measures into respective dimensions tables.

Use this property in conjunction with SplitMeasures to set the priority for how measures should be organized into tables.

データ型

string

デフォルト値

"MeasureGroup"

解説

This property controls the order in which measure storage attributes are used to sort them into subtables when SplitMeasures is true. Provide a comma-delimited list of storage methods in the order they should be prioritized. Available values are:

• MeasureGroup
• DisplayFolder

Split-Measure tables will be named according to whichever attribute comes first in the list, or sorted into a generic 'Measures' table if none of the values in the list are populated for the measure.

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

データ型

int

デフォルト値

60

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Cloud は例外をスローします。

Set this to true to pass MDX queries to Microsoft Power BI XMLA as-is.

データ型

bool

デフォルト値

false

解説

You can execute SQL-92 SELECT queries to the views modeled by the Cloud; set this property to instead execute MDX queries directly to Microsoft Power BI XMLA.

The comma separated PowerBI workspace(s) to connect to.

データ型

string

デフォルト値

""

解説

The comma separated PowerBI workspace(s) to connect to. If not specified, objects from all workspaces will be available. This will cause extra requests to be executed to list objects from all workspaces.

Note: The workspace names are case-sensitive.