Perpustakaan klien Azure RelayAPI untuk JavaScript - versi 4.0.0

Paket ini berisi SDK isomorfik (berjalan di Node.js dan di browser) untuk klien RelayAPI Azure.

Gunakan API ini untuk mengelola sumber daya Azure Relay melalui Azure Resource Manager.

Tautan kunci:

Memulai Langkah Pertama

Lingkungan yang didukung saat ini

Lihat kebijakan dukungan kami untuk detail selengkapnya.

Prasyarat

  • Sebuah langganan Azure.

Pasang paket @azure/arm-relay

Instal pustaka klien Azure RelayAPI untuk JavaScript dengannpm:

npm install @azure/arm-relay

Membuat dan mengautentikasi RelayAPI

Untuk membuat objek klien untuk mengakses API Azure RelayAPI, Anda memerlukan endpoint sumber daya Azure RelayAPI dan .credential Klien Azure RelayAPI dapat menggunakan kredensial Azure Active Directory untuk mengautentikasi. Anda dapat menemukan titik akhir untuk sumber daya Azure RelayAPI Anda di portal Azure.

Anda dapat mengautentikasi dengan Azure Active Directory menggunakan kredensial dari pustaka @azure/identity atau Token AAD yang ada.

Untuk menggunakan penyedia DefaultAzureCredential yang ditunjukkan di bawah ini, atau penyedia kredensial lain yang disediakan dengan Azure SDK, instal paket :

npm install @azure/identity

Anda juga harus mendaftarkan aplikasi AAD baru dan memberikan akses ke Azure RelayAPI dengan menetapkan peran yang sesuai ke perwakilan layanan Anda (catatan: peran seperti tidak "Owner" akan memberikan izin yang diperlukan).

Untuk informasi selengkapnya tentang cara membuat Aplikasi AD Azure, lihat panduan ini.

Dengan menggunakan lingkungan Node.js dan seperti Node, Anda dapat menggunakan kelas DefaultAzureCredential untuk mengautentikasi klien.

import { RelayAPI } from "@azure/arm-relay";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new RelayAPI(new DefaultAzureCredential(), subscriptionId);

Untuk lingkungan browser, gunakan InteractiveBrowserCredential dari paket @azure/identity untuk mengautentikasi.

import { InteractiveBrowserCredential } from "@azure/identity";
import { RelayAPI } from "@azure/arm-relay";

const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new RelayAPI(credential, subscriptionId);

Bundel JavaScript

Untuk menggunakan pustaka klien ini di browser, pertama-tama Anda perlu menggunakan bunder. Untuk detail tentang cara melakukan ini, silakan lihat dokumentasi bundling kami.

Konsep Utama

RelaiAPI

RelayAPIadalah antarmuka utama untuk pengembang yang menggunakan pustaka klien Azure RelayAPI. Jelajahi metode pada objek klien ini untuk memahami berbagai fitur layanan Azure RelayAPI yang dapat Anda akses.

Troubleshooting

Logging

Mengaktifkan pengelogan dapat membantu menemukan informasi yang berguna tentang kegagalan. Untuk melihat log permintaan dan respons HTTP, atur variabel lingkungan AZURE_LOG_LEVEL ke info. Atau, pengelogan dapat diaktifkan saat runtime dengan memanggil setLogLevel di @azure/logger:

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Untuk instruksi lebih rinci tentang cara mengaktifkan log, Anda dapat melihat dokumen paket @azure/logger.

Langkah berikutnya

Silakan lihat sampel direktori untuk contoh terperinci tentang cara menggunakan pustaka ini.

Contributing

Jika Anda ingin berkontribusi ke library ini, silakan baca panduan contributor untuk mempelajari lebih lanjut cara membuat dan menguji kode.

  • Last updated on