JavaScript 用 Azure CustomerInsightsManagement クライアント ライブラリ - バージョン 4.1.0
このパッケージには、Azure CustomerInsightsManagement クライアント用の同型 SDK (Node.jsとブラウザーの両方で実行されます) が含まれています。
Azure Customer Insights 管理 API には、リソースを管理するために Azure Customer Insights サービスと対話する、RESTful の一連の Web サービスが用意されています。 API には、エンド ユーザーと Azure Customer Insights サービスの間の関係をキャプチャするエンティティがあります。
ソースコード | パッケージ (NPM) | API リファレンス ドキュメント | サンプル
はじめに
現在サポートされている環境
- Node.js の LTS バージョン
- Safari、Chrome、Edge、Firefox の最新バージョン。
詳細については、Microsoft のサポート ポリシーを参照してください。
前提条件
@azure/arm-customerinsights
パッケージのインストール
を使用して、JavaScript 用の Azure CustomerInsightsManagement クライアント ライブラリを npm
インストールします。
npm install @azure/arm-customerinsights
CustomerInsightsManagementClient
を作成して認証する
Azure CustomerInsightsManagement API にアクセスするためのクライアント オブジェクトを作成するには、Azure CustomerInsightsManagement リソースの と credential
が必要endpoint
です。 Azure CustomerInsightsManagement クライアントは、Azure Active Directory 資格情報を使用して認証できます。
Azure Portal で Azure CustomerInsightsManagement リソースのエンドポイントを見つけることができます。
@azure/ID ライブラリまたは既存の AAD トークンからの資格情報を使用して、Azure Active Directory で認証できます。
次に示す DefaultAzureCredential プロバイダー、または Azure SDK で提供されているその他の資格情報プロバイダーを使用するには、パッケージを @azure/identity
インストールしてください。
npm install @azure/identity
また、サービス プリンシパルに適切なロールを割り当てることで、 新しい AAD アプリケーションを登録し、Azure CustomerInsightsManagement へのアクセス 権を付与する必要があります (注: などの "Owner"
ロールは、必要なアクセス許可を付与しません)。
環境変数として、AAD アプリケーションのクライアント ID、テナント ID、およびクライアント シークレットの値を設定します。 AZURE_CLIENT_ID
AZURE_TENANT_ID
AZURE_CLIENT_SECRET
Azure AD アプリケーションを作成する方法の詳細については、 このガイドを参照してください。
const { CustomerInsightsManagementClient } = require("@azure/arm-customerinsights");
const { DefaultAzureCredential } = require("@azure/identity");
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new CustomerInsightsManagementClient(new DefaultAzureCredential(), subscriptionId);
// For client-side applications running in the browser, use this code instead:
// const credential = new InteractiveBrowserCredential({
// tenantId: "<YOUR_TENANT_ID>",
// clientId: "<YOUR_CLIENT_ID>"
// });
// const client = new CustomerInsightsManagementClient(credential, subscriptionId);
JavaScript バンドル
ブラウザーでこのクライアント ライブラリを使用するには、まず bundler を使用する必要があります。 これを行う方法の詳細については、 バンドルに関するドキュメントを参照してください。
主要な概念
CustomerInsightsManagementClient
CustomerInsightsManagementClient
は、Azure CustomerInsightsManagement クライアント ライブラリを使用する開発者向けの主要なインターフェイスです。 このクライアント オブジェクトのメソッドを調べて、アクセスできる Azure CustomerInsightsManagement サービスのさまざまな機能を理解します。
トラブルシューティング
ログの記録
ログの記録を有効にすると、エラーに関する有用な情報を明らかにするのに役立つ場合があります。 HTTP 要求と応答のログを表示するには、環境変数 AZURE_LOG_LEVEL
を info
に設定します。 または、@azure/logger
で setLogLevel
を呼び出して、実行時にログ記録を有効にすることもできます。
const { setLogLevel } = require("@azure/logger");
setLogLevel("info");
ログを有効にする方法の詳細については、@azure/logger パッケージに関するドキュメントを参照してください。
次のステップ
このライブラリの使用方法の詳細な例については、 サンプル ディレクトリを参照してください。
共同作成
このライブラリに投稿する場合、コードをビルドしてテストする方法の詳細については、投稿ガイドを参照してください。
関連プロジェクト
Azure SDK for JavaScript