Azure Redis Enterprise PowerShell Module

Manage your Azure Redis Enterprise instances with ease.

Az.RedisEnterprise

Module Overview

The Az.RedisEnterprise PowerShell module provides a comprehensive set of cmdlets for provisioning, configuring, and managing Azure Redis Enterprise instances. This module allows you to interact with Azure Redis Enterprise through the Azure Resource Manager API, enabling automation and scripting of your cache deployments.

Key Features

  • Create, update, and delete Redis Enterprise clusters.
  • Manage database configurations, including persistence and clustering.
  • Configure network settings, such as private endpoints and firewall rules.
  • Retrieve information about your Redis Enterprise deployments.
  • Integrate with Azure Active Directory for secure access.

Installation

To install the Az.RedisEnterprise module, open a PowerShell session with administrator privileges and run the following command:

Install-Module -Name Az.RedisEnterprise -Repository PSGallery -Force

If you don't have the Az module family installed, you can install it first:

Install-Module -Name Az -Repository PSGallery -Force

After installing, you can import the module:

Import-Module Az.RedisEnterprise

Getting Started

Authenticate with your Azure account:

Connect-AzAccount

List Redis Enterprise clusters in your subscription:

Get-AzRedisEnterprise

Create a new Redis Enterprise cluster:

New-AzRedisEnterprise -ResourceGroupName "MyResourceGroup" -Name "MyRedisEnterpriseCache" -Location "East US" -SkuName "Enterprise_E2" -Capacity 2

For more detailed examples and advanced usage, please refer to the official Azure Redis Enterprise PowerShell documentation.

Cmdlet Reference

The following are some of the core cmdlets available in the module:

  • New-AzRedisEnterprise
  • Get-AzRedisEnterprise
  • Update-AzRedisEnterprise
  • Remove-AzRedisEnterprise
  • New-AzRedisEnterpriseDatabase
  • Get-AzRedisEnterpriseDatabase
  • Update-AzRedisEnterpriseDatabase
  • Remove-AzRedisEnterpriseDatabase

Use Get-Command -Module Az.RedisEnterprise to see all available cmdlets.