This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Feature client.

Azure Feature Exposure Control (AFEC) provides a mechanism for the resource providers to control feature exposure to users. Resource providers typically use this mechanism to provide public/private preview for new features prior to making them generally available. Users need to explicitly register for AFEC features to get access to such functionality.

Source code |Package (NPM) |API reference documentation |Samples

Getting started

Currently supported environments

• LTS versions of Node.js
• Latest versions of Safari, Chrome, Edge and Firefox.

See oursupport policy for more details.

Prerequisites

• AnAzure subscription.

Install the@azure/arm-features package

Install the Azure Feature client library for JavaScript withnpm:

npm install @azure/arm-features

Create and authenticate aFeatureClient

To create a client object to access the Azure Feature API, you will need theendpoint of your Azure Feature resource and acredential. The Azure Feature client can use Azure Active Directory credentials to authenticate.You can find the endpoint for your Azure Feature resource in theAzure Portal.

You can authenticate with Azure Active Directory using a credential from the@azure/identity library oran existing AAD Token.

To use theDefaultAzureCredential 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 toregister a new AAD application and grant access to Azure Feature 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.

For more information about how to create an Azure AD Application check outthis guide.

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

JavaScript Bundle

To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to ourbundling documentation.

Key concepts

FeatureClient

FeatureClient is the primary interface for developers using the Azure Feature client library. Explore the methods on this client object to understand the different features of the Azure Feature service that you can access.

Troubleshooting

Logging

Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set theAZURE_LOG_LEVEL environment variable toinfo. Alternatively, logging can be enabled at runtime by callingsetLogLevel in the@azure/logger:

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

For more detailed instructions on how to enable logs, you can look at the@azure/logger package docs.

Next steps

Please take a look at thesamples directory for detailed examples on how to use this library.

Contributing

If you'd like to contribute to this library, please read thecontributing guide to learn more about how to build and test the code.

Related projects

• Microsoft Azure SDK for JavaScript