此套件包含一個同構的 SDK(可在 Node.js 與瀏覽器中執行),用於 RelayAPI 用戶端Azure。
利用這些 API 透過 Azure Resource Manager 管理 Azure 轉送 資源。
主要連結:
入門指南
目前支援的環境
- Node.js的 LTS 版本
- 最新版的 Safari、Chrome、Edge 和 Firefox。
如需詳細資訊,請參閱我們的支援原則。
先決條件
安裝 @azure/arm-relay 套件
安裝 Azure RelayAPI JavaScript 客戶端函式庫,使用:npm
npm install @azure/arm-relay
建立和驗證 RelayAPI
要建立一個客戶端物件來存取 Azure RelayAPI API,你需要你的 Azure RelayAPI 資源中的 ,endpoint以及一個 credential. Azure RelayAPI 客戶端可以使用 Azure Active Directory 憑證來認證。
你可以在 Azure 入口網站 找到你的 Azure RelayAPI 資源的端點。
你可以用
若要使用下方所示的 DefaultAzureCredential 提供者,或Azure SDK附帶的其他憑證提供者,請安裝 @azure/identity 套件:
npm install @azure/identity
你還需要註冊一個新的 AAD 應用程式,並透過指派適當的角色給你的服務主體來授權 Azure RelayAPI(注意:像是的角色"Owner"不會授予必要的權限)。
想了解更多如何建立 Azure AD 應用程式的資訊,請參考 此指南。
使用 Node.js 和類似節點的環境,您可以使用 DefaultAzureCredential 類別來驗證用戶端。
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);
針對瀏覽器環境,請使用來自 InteractiveBrowserCredential 套件的 @azure/identity 進行驗證。
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);
JavaScript 套件組合
若要在瀏覽器中使用此用戶端連結庫,您必須先使用配套程式。 有關如何執行此作的詳細資訊,請參閱我們的 捆綁文檔。
關鍵概念
RelayAPI
RelayAPI是開發者使用 Azure RelayAPI 用戶端函式庫的主要介面。 探索此用戶端物件的方法,以了解您可以存取的 Azure RelayAPI 服務的不同功能。
Troubleshooting
伐木
啟用記錄可能有助於找出有關失敗的實用資訊。 若要查看 HTTP 要求和回應的記錄,請將 AZURE_LOG_LEVEL 環境變數設定為 info。 或者,您可以在運行時間啟用記錄,方法是在 setLogLevel中呼叫 @azure/logger:
import { setLogLevel } from "@azure/logger";
setLogLevel("info");
如需如何啟用記錄的詳細指示,請參閱
下一步
請參考 samples 目錄,裡面有詳細的使用範例。
Contributing
如果你想為這個函式庫貢獻,請閱讀 contributing guide,了解更多如何建置與測試程式碼。
相關專案
Microsoft JavaScript