RedisEnterprise interface
Interface representing a RedisEnterprise.
Methods
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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- parameters
- Cluster
Parameters supplied to the Create Redis Enterprise operation.
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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- parameters
- Cluster
Parameters supplied to the Create Redis Enterprise operation.
The options parameters.
Returns
Promise<Cluster>
beginDelete(string, string, RedisEnterpriseDeleteOptionalParams)
Deletes a Redis Enterprise 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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, RedisEnterpriseDeleteOptionalParams)
Deletes a Redis Enterprise 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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, ClusterUpdate, RedisEnterpriseUpdateOptionalParams)
Updates an existing Redis Enterprise 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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- parameters
- ClusterUpdate
Parameters supplied to the Update Redis Enterprise operation.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>
beginUpdateAndWait(string, string, ClusterUpdate, RedisEnterpriseUpdateOptionalParams)
Updates an existing Redis Enterprise 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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- parameters
- ClusterUpdate
Parameters supplied to the Update Redis Enterprise operation.
The options parameters.
Returns
Promise<Cluster>
get(string, string, RedisEnterpriseGetOptionalParams)
Gets information about a Redis Enterprise 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 Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- options
- RedisEnterpriseGetOptionalParams
The options parameters.
Returns
Promise<Cluster>
list(RedisEnterpriseListOptionalParams)
Lists all Redis Enterprise clusters in the specified subscription.
function list(options?: RedisEnterpriseListOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>Parameters
The options parameters.
Returns
listByResourceGroup(string, RedisEnterpriseListByResourceGroupOptionalParams)
Lists all Redis Enterprise 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.
The options parameters.
Returns
listSkusForScaling(string, string, RedisEnterpriseListSkusForScalingOptionalParams)
Lists the available SKUs for scaling the Redis Enterprise cluster.
function listSkusForScaling(resourceGroupName: string, clusterName: string, options?: RedisEnterpriseListSkusForScalingOptionalParams): Promise<SkuDetailsList>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
The options parameters.
Returns
Promise<SkuDetailsList>