RedisEnterprise interface

Package:

@azure/arm-redisenterprisecache

Interface representing a RedisEnterprise.

Methods

beginCreate(string, string, Cluster, RedisEnterpriseCreateOptionalParams)	Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster
beginCreateAndWait(string, string, Cluster, RedisEnterpriseCreateOptionalParams)	Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster
beginDelete(string, string, RedisEnterpriseDeleteOptionalParams)	Deletes a RedisEnterprise cache cluster.
beginDeleteAndWait(string, string, RedisEnterpriseDeleteOptionalParams)	Deletes a RedisEnterprise cache cluster.
beginUpdate(string, string, ClusterUpdate, RedisEnterpriseUpdateOptionalParams)	Updates an existing RedisEnterprise cluster
beginUpdateAndWait(string, string, ClusterUpdate, RedisEnterpriseUpdateOptionalParams)	Updates an existing RedisEnterprise cluster
get(string, string, RedisEnterpriseGetOptionalParams)	Gets information about a RedisEnterprise cluster
list(RedisEnterpriseListOptionalParams)	Gets all RedisEnterprise clusters in the specified subscription.
listByResourceGroup(string, RedisEnterpriseListByResourceGroupOptionalParams)	Lists all RedisEnterprise clusters in a resource group.

Method Details

beginCreate(string, string, Cluster, RedisEnterpriseCreateOptionalParams)

Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster

function beginCreate(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: RedisEnterpriseCreateOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

parameters

Cluster

Parameters supplied to the Create RedisEnterprise operation.

options

RedisEnterpriseCreateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>

beginCreateAndWait(string, string, Cluster, RedisEnterpriseCreateOptionalParams)

Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster

function beginCreateAndWait(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: RedisEnterpriseCreateOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

parameters

Cluster

Parameters supplied to the Create RedisEnterprise operation.

options

RedisEnterpriseCreateOptionalParams

The options parameters.

Returns

Promise<Cluster>

beginDelete(string, string, RedisEnterpriseDeleteOptionalParams)

Deletes a RedisEnterprise cache cluster.

function beginDelete(resourceGroupName: string, clusterName: string, options?: RedisEnterpriseDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

options

RedisEnterpriseDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, RedisEnterpriseDeleteOptionalParams)

Deletes a RedisEnterprise cache cluster.

function beginDeleteAndWait(resourceGroupName: string, clusterName: string, options?: RedisEnterpriseDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

options

RedisEnterpriseDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, ClusterUpdate, RedisEnterpriseUpdateOptionalParams)

Updates an existing RedisEnterprise cluster

function beginUpdate(resourceGroupName: string, clusterName: string, parameters: ClusterUpdate, options?: RedisEnterpriseUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

parameters

ClusterUpdate

Parameters supplied to the Update RedisEnterprise operation.

options

RedisEnterpriseUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>

beginUpdateAndWait(string, string, ClusterUpdate, RedisEnterpriseUpdateOptionalParams)

Updates an existing RedisEnterprise cluster

function beginUpdateAndWait(resourceGroupName: string, clusterName: string, parameters: ClusterUpdate, options?: RedisEnterpriseUpdateOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

parameters

ClusterUpdate

Parameters supplied to the Update RedisEnterprise operation.

options

RedisEnterpriseUpdateOptionalParams

The options parameters.

Returns

Promise<Cluster>

get(string, string, RedisEnterpriseGetOptionalParams)

Gets information about a RedisEnterprise cluster

function get(resourceGroupName: string, clusterName: string, options?: RedisEnterpriseGetOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the RedisEnterprise cluster.

options

RedisEnterpriseGetOptionalParams

The options parameters.

Returns

Promise<Cluster>

list(RedisEnterpriseListOptionalParams)

Gets all RedisEnterprise clusters in the specified subscription.

function list(options?: RedisEnterpriseListOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

Parameters

options

RedisEnterpriseListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listByResourceGroup(string, RedisEnterpriseListByResourceGroupOptionalParams)

Lists all RedisEnterprise clusters in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: RedisEnterpriseListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options

RedisEnterpriseListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>