JavaScript 用 AzureApiCenter クライアント ライブラリ

  • [アーティクル]

このパッケージには、AzureApiCenter クライアント用の同型 SDK (Node.js とブラウザーの両方で実行されます) が含まれています。

Azure API Center リソース プロバイダー。

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

はじめに

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

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

前提条件

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

を使用して、JavaScript 用 AzureApiCenter クライアント ライブラリを npmインストールします。

npm install @azure/arm-apicenter

AzureAPICenter を作成して認証する

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

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

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

npm install @azure/identity

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

Azure AD アプリケーションを作成する方法の詳細については、このガイドをチェック。

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

JavaScript バンドル

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

主要な概念

AzureAPICenter

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

トラブルシューティング

ログ記録

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

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

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

次の手順

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

共同作成

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

インプレッション数