次の方法で共有

JavaScript 用 Azure Visual Studio リソース プロバイダー クライアント ライブラリ - バージョン 4.0.0-beta.2

  • [アーティクル]

このパッケージには、Azure Visual Studio リソース プロバイダー クライアント用の同型 SDK (Node.jsとブラウザーの両方で実行されます) が含まれています。

これらの API を使用して、Azure Resource Managerを使用してVisual Studio Team Servicesリソースを管理します。 すべてのタスク操作が HTTP/1.1 プロトコル仕様に準拠しており、各操作からは、要求に関する情報を取得する際に使用できる x-ms-request-id ヘッダーが返されます。 これらのリソースに対して行う要求には、セキュリティを確保する必要があります。 詳細については、「/rest/api/index」を参照してください。

ソースコード | パッケージ (NPM) | API リファレンス ドキュメント | サンプル

はじめに

現在サポートされている環境

詳細については、Microsoft のサポート ポリシーを参照してください。

前提条件

@azure/arm-visualstudio パッケージのインストール

を使用して、JavaScript 用の Azure Visual Studio リソース プロバイダー クライアント ライブラリを npmインストールします。

npm install @azure/arm-visualstudio

VisualStudioResourceProviderClient を作成して認証する

Azure Visual Studio リソース プロバイダー API にアクセスするためのクライアント オブジェクトを作成するには、Azure Visual Studio リソース プロバイダー リソースcredentialの と が必要endpointです。 Azure Visual Studio リソース プロバイダー クライアントは、Azure Active Directory 資格情報を使用して認証できます。 Azure Portal で Azure Visual Studio リソース プロバイダー リソースのエンドポイントを見つけることができます。

@azure/ID ライブラリまたは既存の AAD トークンからの資格情報を使用して、Azure Active Directory で認証できます。

次に示す DefaultAzureCredential プロバイダー、または Azure SDK で提供されているその他の資格情報プロバイダーを使用するには、パッケージを @azure/identity インストールしてください。

npm install @azure/identity

また、サービス プリンシパルに適切なロールを割り当てることで、 新しい AAD アプリケーションを登録し、Azure Visual Studio リソース プロバイダーへのアクセス 権を付与する必要があります (注: などの "Owner" ロールは、必要なアクセス許可を付与しません)。 環境変数として、AAD アプリケーションのクライアント ID、テナント ID、およびクライアント シークレットの値を設定します。 AZURE_CLIENT_IDAZURE_TENANT_IDAZURE_CLIENT_SECRET

Azure AD アプリケーションを作成する方法の詳細については、 このガイドを参照してください。

const { VisualStudioResourceProviderClient } = require("@azure/arm-visualstudio");
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 VisualStudioResourceProviderClient(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 VisualStudioResourceProviderClient(credential, subscriptionId);

JavaScript バンドル

ブラウザーでこのクライアント ライブラリを使用するには、まず bundler を使用する必要があります。 これを行う方法の詳細については、 バンドルに関するドキュメントを参照してください。

主要な概念

VisualStudioResourceProviderClient

VisualStudioResourceProviderClient は、Azure Visual Studio リソース プロバイダー クライアント ライブラリを使用する開発者向けの主要なインターフェイスです。 このクライアント オブジェクトのメソッドを調べて、アクセスできる Azure Visual Studio リソース プロバイダー サービスのさまざまな機能を理解します。

トラブルシューティング

ログ記録

ログの記録を有効にすると、エラーに関する有用な情報を明らかにするのに役立つ場合があります。 HTTP 要求と応答のログを表示するには、環境変数 AZURE_LOG_LEVEL を info に設定します。 または、@azure/logger で setLogLevel を呼び出して、実行時にログ記録を有効にすることもできます。

const { setLogLevel } = require("@azure/logger");
setLogLevel("info");

ログを有効にする方法の詳細については、@azure/logger パッケージに関するドキュメントを参照してください。

次の手順

このライブラリの使用方法の詳細な例については、 サンプル ディレクトリを参照してください。

共同作成

このライブラリに投稿する場合、コードをビルドしてテストする方法の詳細については、投稿ガイドを参照してください。

インプレッション数