JavaScript 用Azure Policy クライアント ライブラリ - バージョン 2.1.0
このパッケージには、Azure Policy クライアント用の同型 SDK (Node.js とブラウザーの両方で実行されます) が含まれています。
リソースへのアクセスを管理および制御するには、カスタマイズしたポリシーを定義して一定のスコープで割り当てます。
ソースコード | パッケージ (NPM) | API リファレンス ドキュメント | サンプル
はじめに
現在サポートされている環境
- Node.js の LTS バージョン
- Safari、Chrome、Edge、Firefox の最新バージョン。
詳細については、Microsoft のサポート ポリシーを参照してください。
前提条件
@azure/arm-policy-profile-2020-09-01-hybrid
パッケージのインストール
を使用して JavaScript 用のAzure Policy クライアント ライブラリをnpm
インストールします。
npm install @azure/arm-policy-profile-2020-09-01-hybrid
PolicyClient
を作成して認証する
Azure Policy API にアクセスするクライアント オブジェクトを作成するには、Azure Policy リソースの と credential
が必要endpoint
です。 Azure Policy クライアントは、Azure Active Directory 資格情報を使用して認証できます。
Azure Policy リソースのエンドポイントは、Azure Portal で確認できます。
@azure/ID ライブラリまたは既存の AAD トークンからの資格情報を使用して、Azure Active Directory で認証できます。
次に示す DefaultAzureCredential プロバイダー、または Azure SDK で提供されている他の資格情報プロバイダーを使用するには、パッケージを @azure/identity
インストールしてください。
npm install @azure/identity
また、新しい AAD アプリケーションを登録し、適切なロールをサービス プリンシパルに割り当てることで、Azure Policyへのアクセス権を付与する必要があります (注: などの"Owner"
ロールは、必要なアクセス許可を付与しません)。
AAD アプリケーションのクライアント ID、テナント ID、およびクライアント シークレットの値を、環境変数 AZURE_CLIENT_ID
AZURE_TENANT_ID
、、AZURE_CLIENT_SECRET
、 として設定します。
Azure AD アプリケーションを作成する方法の詳細については、 こちらのガイドを参照してください。
const { PolicyClient } = require("@azure/arm-policy-profile-2020-09-01-hybrid");
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 PolicyClient(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 PolicyClient(credential, subscriptionId);
JavaScript バンドル
ブラウザーでこのクライアント ライブラリを使用するには、まず bundler を使用する必要があります。 これを行う方法の詳細については、 バンドルに関するドキュメントを参照してください。
主要な概念
PolicyClient
PolicyClient
は、Azure Policy クライアント ライブラリを使用する開発者向けの主要なインターフェイスです。 このクライアント オブジェクトのメソッドを調べて、アクセスできるAzure Policy サービスのさまざまな機能を理解します。
トラブルシューティング
ログ記録
ログの記録を有効にすると、エラーに関する有用な情報を明らかにするのに役立つ場合があります。 HTTP 要求と応答のログを表示するには、環境変数 AZURE_LOG_LEVEL
を info
に設定します。 または、@azure/logger
で setLogLevel
を呼び出して、実行時にログ記録を有効にすることもできます。
const { setLogLevel } = require("@azure/logger");
setLogLevel("info");
ログを有効にする方法の詳細については、@azure/logger パッケージに関するドキュメントを参照してください。
次の手順
このライブラリの使用方法の詳細な例については、 samples ディレクトリを参照してください。
共同作成
このライブラリに投稿する場合、コードをビルドしてテストする方法の詳細については、投稿ガイドを参照してください。
関連プロジェクト
Azure SDK for JavaScript