This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure WebPubSubManagement client.
REST API for Azure WebPubSub Service
Source code | Package (NPM) | API reference documentation | Samples
@azure/arm-webpubsub
packageInstall the Azure WebPubSubManagement client library for JavaScript with npm
:
npm install @azure/arm-webpubsub
WebPubSubManagementClient
To create a client object to access the Azure WebPubSubManagement API, you will need the endpoint
of your Azure WebPubSubManagement resource and a credential
. The Azure WebPubSubManagement client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure WebPubSubManagement resource in the Azure Portal.
You can authenticate with Azure Active Directory using the Azure Identity library. To use the DefaultAzureCredential provider shown below, or other credential providers provided with the Azure SDK, please install the @azure/identity
package:
npm install @azure/identity
You will also need to register a new AAD application and grant access to Azure WebPubSubManagement by assigning the suitable role to your service principal (note: roles such as "Owner"
will not grant the necessary permissions).
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: AZURE_CLIENT_ID
, AZURE_TENANT_ID
, AZURE_CLIENT_SECRET
.
const { WebPubSubManagementClient } = require("@azure/arm-webpubsub");
const { DefaultAzureCredential } = require("@azure/identity");
const client = new WebPubSubManagementClient("<endpoint>", new DefaultAzureCredential());
WebPubSubManagementClient
is the primary interface for developers using the Azure WebPubSubManagement client library. Explore the methods on this client object to understand the different features of the Azure WebPubSubManagement service that you can access.
Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the AZURE_LOG_LEVEL
environment variable to info
. Alternatively, logging can be enabled at runtime by calling setLogLevel
in the @azure/logger
:
import { setLogLevel } from "@azure/logger";
setLogLevel("info");
For more detailed instructions on how to enable logs, you can look at the @azure/logger package docs.
Please take a look at the samples directory for detailed examples on how to use this library.
If you'd like to contribute to this library, please read the contributing guide to learn more about how to build and test the code.
Generated using TypeDoc