azure-sdk-for-js/sdk/redis/arm-rediscache

Azure RedisManagement client library for JavaScript

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

REST API for Azure Redis Cache Service.

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.

Prerequisites

• An Azure subscription.

Install the @azure/arm-rediscache package

Install the Azure RedisManagement client library for JavaScript with npm:

npm install @azure/arm-rediscache

Create and authenticate a RedisManagementClient

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

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

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 RedisManagement 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 out this guide.

const { RedisManagementClient } = require("@azure/arm-rediscache");
const { DefaultAzureCredential } = require("@azure/identity");
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new RedisManagementClient(new DefaultAzureCredential(), 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 our bundling documentation.

Key concepts

RedisManagementClient

RedisManagementClient is the primary interface for developers using the Azure RedisManagement client library. Explore the methods on this client object to understand the different features of the Azure RedisManagement 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 the AZURE_LOG_LEVEL environment variable to info. Alternatively, logging can be enabled at runtime by calling setLogLevel 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 the samples directory for detailed examples on how to use this library.

Contributing

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.

Related projects

• Microsoft Azure SDK for JavaScript