資格情報

[アーティクル]
03/25/2024

データソースの認証情報は、コマンド間でキャッシュおよび再利用できます。既定では、このキャッシュは %LOCALAPPDATA%/Microsoft/pqtest のローカルファイルに格納され、現在のユーザーキーで暗号化されます。

認証情報は、ローカルファイルストレージの代わりに Azure Key Vault に格納することもできます。このオプションを有効にするには、--keyVault / -kv オプションを使用して、オプション引数にキーコンテナー名を入力し、次の表で指定された環境変数を設定します。

Note

Azure Key Vault を使用する場合、認証情報は、個々のシークレットではなく、1 つのバイナリオブジェクトとして格納されます。

変数	詳細	サンプル
PQTEST_AZURE_CLIENT_ID	キーコンテナーへのアクセスを承認した、Microsoft Entra ID アプリケーションの ID (GUID)。	c265f4e8-a32f-4548-a21e-3542ec65134a
PQTEST_AZURE_CLIENT_SECRET	Microsoft Entra ID アプリケーションのクライアントシークレット。	<client-secret-placeholder>
PQTEST_AZURE_TENANT_ID	Azure Key Vault を所有するテナントの ID (GUID)。	c265f4e8-a32f-4548-a21e-3542ec65134a
PQTEST_AZURE_KEY_VAULT_URL	このキーコンテナーの URL。	`https://<myvault>.vault.azure.net`

keyVault オプションの使用例:

set PQTEST_AZURE_CLIENT_ID="c265f4e8-a32f-4548-a21e-3542ec65134a"
set PQTEST_AZURE_CLIENT_SECRET="<client-secret-placeholder>"
set PQTEST_AZURE_TENANT_ID="c265f4e8-a32f-4548-a21e-3542ec65134a"
set PQTEST_AZURE_KEY_VAULT_URL="https://myvault.vault.azure.net"

<Path to PQTest.exe>.\PQTest.exe list-credential --keyVault secretName

Credential-template

このコマンドを使用して、set-credential コマンドに渡すことができる認証情報テンプレートを JSON 形式で生成します。このコマンドでは、拡張機能とデータソース情報を指定する必要があります。データソースで認証の種類が複数サポートされている場合は、--authenticationKind / -ak オプションで、使用する認証の種類を指定する必要があります。

出力テンプレートには、$$<キー名>$$ で識別されるプレースホルダー値があります。これは、set-credential コマンドに渡す前に置き換える必要があります。

たとえば、MyConnector では、匿名認証と UsernamePassword 認証の両方の種類がサポートされています。

Anonymous 認証情報を生成するには、次のコマンドを使用します。

<Path to PQTest.exe>.\PQTest.exe credential-template --extension MyConnector.mez --queryFile MyConnectorQuery.m --prettyPrint --authenticationKind Anonymous

Note

出力 JSON 値にプレースホルダー値は含まれていません。Anonymous の種類にはそれが必要ないからです。

{
  "AuthenticationKind": "Anonymous",
  "AuthenticationProperties": {},
  "PrivacySetting": "None",
  "Permissions": []
}

次のコマンドを使用して、同じコネクタの UsernamePassword 認証情報を生成します。

<Path to PQTest.exe>.\PQTest.exe credential-template --extension MyConnector.mez --queryFile MyConnectorQuery.m --prettyPrint --authenticationKind UsernamePassword

結果のテンプレートには、$$USERNAME$$ と $$PASSWORD$$ のプレースホルダー値が含まれています。

{
  "AuthenticationKind": "UsernamePassword",
  "AuthenticationProperties": {
    "Username": "$$USERNAME$$",
    "Password": "$$PASSWORD$$"
  },
  "PrivacySetting": "None",
  "Permissions": []
}

Set-credential

このコマンドを使用して、test-connection コマンドと run-test コマンドで使用する認証情報を格納します。このコマンドでは、拡張機能とデータソース情報を指定する必要があります。認証情報を設定するには、次の 3 つのいずれかを実行します。

JSON 形式の認証情報を使用する。
追加の設定 (Anonymous と Windows) を必要としない認証の種類の自動認証情報。
対話モードを使用する。

JSON 形式の認証情報

JSON 形式の認証情報を使用して、任意の認証情報の種類を設定できます。 credential-template コマンドを使用して、JSON 形式の認証情報を生成します。

JSON テンプレートを使用して認証情報を設定する場合は、入力をパイプ処理してコマンドに渡すか、stdin からファイルを介して指定する必要があります。

次に、credential-template コマンドの結果を set-credential にパイプ処理して Anonymous 認証情報を設定する例を示します。

<Path to PQTest.exe>.\PQTest.exe credential-template -e MyConnector.mez -q MyConnectorQuery.m -p -ak Anonymous | pqtest set-credential -e MyConnector.mez -q MyConnectorQuery.m -p

{
  "Details": {
    "Kind": "MyConnector",
    "Path": "MyConnector",
    "NormalizedPath": "MyConnector",
    "IsDefaultForKind": false
  },
  "Message": "Successfully set credential",
  "Status": "Success"
}

Note

Anonymous と Windows の認証情報は、自動認証情報を使用して設定できます。

(リダイレクトされた入力を使用して) ディスクに格納されているファイルから認証情報を設定する例を次に示します。

<Path to PQTest.exe>.\PQTest.exe set-credential -e MyConnector.mez -q MyConnectorQuery.m -p < mySavedCredential.json

{
  "Details": {
    "Kind": "MyConnector",
    "Path": "MyConnector",
    "NormalizedPath": "MyConnector",
    "IsDefaultForKind": false
  },
  "Message": "Successfully set credential",
  "Status": "Success"
}

自動認証情報

認証情報テンプレートを指定せずに、Anonymous と Windows の認証情報を設定できます。

Note

この方法で設定した Windows 認証情報では、既定で現在のユーザーの ID を使用します。 credential-template コマンドを使用して、代替の Windows アカウント認証情報を使用するように変更できる JSON 形式の認証情報を生成します。

Windows 認証情報を生成するには、次のコマンドを使用します。

<Path to PQTest.exe>.\PQTest.exe set-credential -e MyConnector.mez -q MyConnectorQuery.m -p --authenticationKind windows

Anonymous 認証情報を生成するには、次のコマンドを使用します。

<Path to PQTest.exe>.\PQTest.exe set-credential -e MyConnector.mez -q MyConnectorQuery.m -p --authenticationKind anonymous

対話モード

認証情報は、--interactive コマンドラインオプションを使用して対話モードで設定できます。

対話モードは、OAuth と Aad の認証の種類に使用できます。このモードでコマンドを実行すると、OAuth の実装テストに使用できる OAuth ダイアログが表示されます。

対話型 OAuth フローでは、WebView2 (Microsoft Edge Chromium) ブラウザーコンポーネントを使用します。これは、個別にインストールしなければならない場合があります。詳細については、Power BI Desktop の Power Query OAuth ドキュメントを参照してください。

--useLegacyBrowser オプションを使用すると、IE11 埋め込みブラウザーウィンドウでの表示を強制できます。

次の方法で共有

資格情報

Credential-template

Set-credential

JSON 形式の認証情報

自動認証情報

対話モード

フィードバック

その他のリソース