Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-relay

Package version

Azure RelayManagementClient SDK for JavaScript

This package contains an isomorphic SDK for RelayManagementClient.

Currently supported environments

  • Node.js version 6.x.x or higher
  • Browser JavaScript

How to Install

npm install @azure/arm-relay

How to use

nodejs - Authentication, client creation and list operations as an example written in TypeScript.

Install @azure/ms-rest-nodeauth
npm install @azure/ms-rest-nodeauth
Sample code
import * as msRest from "@azure/ms-rest-js";
import * as msRestAzure from "@azure/ms-rest-azure-js";
import * as msRestNodeAuth from "@azure/ms-rest-nodeauth";
import { RelayManagementClient, RelayManagementModels, RelayManagementMappers } from "@azure/arm-relay";
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];

msRestNodeAuth.interactiveLogin().then((creds) => {
  const client = new RelayManagementClient(creds, subscriptionId);
  client.operations.list().then((result) => {
    console.log("The result is:");
    console.log(result);
  });
}).catch((err) => {
  console.error(err);
});

browser - Authentication, client creation and list operations as an example written in JavaScript.

Install @azure/ms-rest-browserauth
npm install @azure/ms-rest-browserauth
Sample code

See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser.

  • index.html
    <!DOCTYPE html>
    <html lang="en">
    <head>
      <title>@azure/arm-relay sample</title>
      <script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
      <script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script>
      <script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script>
      <script src="node_modules/@azure/arm-relay/dist/arm-relay.js"></script>
      <script type="text/javascript">
        const subscriptionId = "<Subscription_Id>";
        const authManager = new msAuth.AuthManager({
          clientId: "<client id for your Azure AD app>",
          tenant: "<optional tenant for your organization>"
        });
        authManager.finalizeLogin().then((res) => {
          if (!res.isLoggedIn) {
            // may cause redirects
            authManager.login();
          }
          const client = new Azure.ArmRelay.RelayManagementClient(res.creds, subscriptionId);
          client.operations.list().then((result) => {
            console.log("The result is:");
            console.log(result);
          }).catch((err) => {
            console.log("An error occurred:");
            console.error(err);
          });
        });
      </script>
    </head>
    <body></body>
    </html>

Related projects

Impressions

Generated using TypeDoc