Microsoft.Cache (stable:2025-04-01)

2025/03/25 • 30 new methods

Operations_List (new)
Description :  Lists all of the available REST API operations of the Microsoft.Cache provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Cache/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OperationsStatus_Get (new)
Description :  Gets the status of operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Cache/locations/{location}/operationsStatus/{operationId}
{
location:
{
Description: The name of Azure region. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The operation's unique id. ,
Required: False ,
}
string ,
name:
{
Description: The operation's name. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the operation. ,
Required: False ,
}
string ,
error:
{
Description: Error response describing why the operation failed. ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RedisEnterprise_Create (new)
Description :  Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create Redis Enterprise operation. ,
Required: True ,
}
{
kind:
{
Description: Distinguishes the kind of cluster. Read-only. ,
Enum:
{
v1: No description available. ,
v2: No description available. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: The SKU to create, which affects price, performance, and features. ,
Required: True ,
}
{
name:
{
Description: The level of Redis Enterprise cluster to deploy. Possible values: ('Balanced_B5', 'MemoryOptimized_M10', 'ComputeOptimized_X5', etc.). For more information on SKUs see the latest pricing documentation. Note that additional SKUs may become supported in the future. ,
Enum:
{
Enterprise_E1: No description available. ,
Enterprise_E5: No description available. ,
Enterprise_E10: No description available. ,
Enterprise_E20: No description available. ,
Enterprise_E50: No description available. ,
Enterprise_E100: No description available. ,
Enterprise_E200: No description available. ,
Enterprise_E400: No description available. ,
EnterpriseFlash_F300: No description available. ,
EnterpriseFlash_F700: No description available. ,
EnterpriseFlash_F1500: No description available. ,
Balanced_B0: No description available. ,
Balanced_B1: No description available. ,
Balanced_B3: No description available. ,
Balanced_B5: No description available. ,
Balanced_B10: No description available. ,
Balanced_B20: No description available. ,
Balanced_B50: No description available. ,
Balanced_B100: No description available. ,
Balanced_B150: No description available. ,
Balanced_B250: No description available. ,
Balanced_B350: No description available. ,
Balanced_B500: No description available. ,
Balanced_B700: No description available. ,
Balanced_B1000: No description available. ,
MemoryOptimized_M10: No description available. ,
MemoryOptimized_M20: No description available. ,
MemoryOptimized_M50: No description available. ,
MemoryOptimized_M100: No description available. ,
MemoryOptimized_M150: No description available. ,
MemoryOptimized_M250: No description available. ,
MemoryOptimized_M350: No description available. ,
MemoryOptimized_M500: No description available. ,
MemoryOptimized_M700: No description available. ,
MemoryOptimized_M1000: No description available. ,
MemoryOptimized_M1500: No description available. ,
MemoryOptimized_M2000: No description available. ,
ComputeOptimized_X3: No description available. ,
ComputeOptimized_X5: No description available. ,
ComputeOptimized_X10: No description available. ,
ComputeOptimized_X20: No description available. ,
ComputeOptimized_X50: No description available. ,
ComputeOptimized_X100: No description available. ,
ComputeOptimized_X150: No description available. ,
ComputeOptimized_X250: No description available. ,
ComputeOptimized_X350: No description available. ,
ComputeOptimized_X500: No description available. ,
ComputeOptimized_X700: No description available. ,
FlashOptimized_A250: No description available. ,
FlashOptimized_A500: No description available. ,
FlashOptimized_A700: No description available. ,
FlashOptimized_A1000: No description available. ,
FlashOptimized_A1500: No description available. ,
FlashOptimized_A2000: No description available. ,
FlashOptimized_A4500: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: This property is only used with Enterprise and EnterpriseFlash SKUs. Determines the size of the cluster. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for EnterpriseFlash SKUs. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
zones:
{
Description: The Availability Zones where this cluster will be deployed. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Other properties of the cluster. ,
Required: False ,
}
{
highAvailability:
{
Description: Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2'. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete -- you cannot use them. They are mentioned only for the sake of consistency with old API versions. ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption-at-rest configuration for the cluster. ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption. ,
Required: False ,
}
{
keyEncryptionKeyIdentity:
{
Description: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. ,
Required: False ,
}
string ,
identityType:
{
Description: Only userAssignedIdentity is supported in this API version; other types may be supported in the future ,
Enum:
{
systemAssignedIdentity: No description available. ,
userAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
keyEncryptionKeyUrl:
{
Description: Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 ,
Required: False ,
}
string ,
}
,
}
,
hostName:
{
Description: DNS name of the cluster endpoint ,
Required: False ,
}
string ,
provisioningState:
{
Description: Current provisioning status of the cluster ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
redundancyMode:
{
Description: Explains the current redundancy strategy of the cluster, which affects the expected SLA. ,
Enum:
{
None: No redundancy. Availability loss will occur. ,
LR: Local redundancy with high availability. ,
ZR: Zone redundant. Higher availability. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Current resource status of the cluster ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
CreateFailed: No description available. ,
Updating: No description available. ,
UpdateFailed: No description available. ,
Deleting: No description available. ,
DeleteFailed: No description available. ,
Enabling: No description available. ,
EnableFailed: No description available. ,
Disabling: No description available. ,
DisableFailed: No description available. ,
Disabled: No description available. ,
Scaling: No description available. ,
ScalingFailed: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
redisVersion:
{
Description: Version of redis the cluster supports, e.g. '6' ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified Redis Enterprise cluster ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
kind:
{
Description: Distinguishes the kind of cluster. Read-only. ,
Enum:
{
v1: No description available. ,
v2: No description available. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: The SKU to create, which affects price, performance, and features. ,
Required: True ,
}
{
name:
{
Description: The level of Redis Enterprise cluster to deploy. Possible values: ('Balanced_B5', 'MemoryOptimized_M10', 'ComputeOptimized_X5', etc.). For more information on SKUs see the latest pricing documentation. Note that additional SKUs may become supported in the future. ,
Enum:
{
Enterprise_E1: No description available. ,
Enterprise_E5: No description available. ,
Enterprise_E10: No description available. ,
Enterprise_E20: No description available. ,
Enterprise_E50: No description available. ,
Enterprise_E100: No description available. ,
Enterprise_E200: No description available. ,
Enterprise_E400: No description available. ,
EnterpriseFlash_F300: No description available. ,
EnterpriseFlash_F700: No description available. ,
EnterpriseFlash_F1500: No description available. ,
Balanced_B0: No description available. ,
Balanced_B1: No description available. ,
Balanced_B3: No description available. ,
Balanced_B5: No description available. ,
Balanced_B10: No description available. ,
Balanced_B20: No description available. ,
Balanced_B50: No description available. ,
Balanced_B100: No description available. ,
Balanced_B150: No description available. ,
Balanced_B250: No description available. ,
Balanced_B350: No description available. ,
Balanced_B500: No description available. ,
Balanced_B700: No description available. ,
Balanced_B1000: No description available. ,
MemoryOptimized_M10: No description available. ,
MemoryOptimized_M20: No description available. ,
MemoryOptimized_M50: No description available. ,
MemoryOptimized_M100: No description available. ,
MemoryOptimized_M150: No description available. ,
MemoryOptimized_M250: No description available. ,
MemoryOptimized_M350: No description available. ,
MemoryOptimized_M500: No description available. ,
MemoryOptimized_M700: No description available. ,
MemoryOptimized_M1000: No description available. ,
MemoryOptimized_M1500: No description available. ,
MemoryOptimized_M2000: No description available. ,
ComputeOptimized_X3: No description available. ,
ComputeOptimized_X5: No description available. ,
ComputeOptimized_X10: No description available. ,
ComputeOptimized_X20: No description available. ,
ComputeOptimized_X50: No description available. ,
ComputeOptimized_X100: No description available. ,
ComputeOptimized_X150: No description available. ,
ComputeOptimized_X250: No description available. ,
ComputeOptimized_X350: No description available. ,
ComputeOptimized_X500: No description available. ,
ComputeOptimized_X700: No description available. ,
FlashOptimized_A250: No description available. ,
FlashOptimized_A500: No description available. ,
FlashOptimized_A700: No description available. ,
FlashOptimized_A1000: No description available. ,
FlashOptimized_A1500: No description available. ,
FlashOptimized_A2000: No description available. ,
FlashOptimized_A4500: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: This property is only used with Enterprise and EnterpriseFlash SKUs. Determines the size of the cluster. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for EnterpriseFlash SKUs. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
zones:
{
Description: The Availability Zones where this cluster will be deployed. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Other properties of the cluster. ,
Required: False ,
}
{
highAvailability:
{
Description: Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2'. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete -- you cannot use them. They are mentioned only for the sake of consistency with old API versions. ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption-at-rest configuration for the cluster. ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption. ,
Required: False ,
}
{
keyEncryptionKeyIdentity:
{
Description: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. ,
Required: False ,
}
string ,
identityType:
{
Description: Only userAssignedIdentity is supported in this API version; other types may be supported in the future ,
Enum:
{
systemAssignedIdentity: No description available. ,
userAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
keyEncryptionKeyUrl:
{
Description: Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 ,
Required: False ,
}
string ,
}
,
}
,
hostName:
{
Description: DNS name of the cluster endpoint ,
Required: False ,
}
string ,
provisioningState:
{
Description: Current provisioning status of the cluster ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
redundancyMode:
{
Description: Explains the current redundancy strategy of the cluster, which affects the expected SLA. ,
Enum:
{
None: No redundancy. Availability loss will occur. ,
LR: Local redundancy with high availability. ,
ZR: Zone redundant. Higher availability. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Current resource status of the cluster ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
CreateFailed: No description available. ,
Updating: No description available. ,
UpdateFailed: No description available. ,
Deleting: No description available. ,
DeleteFailed: No description available. ,
Enabling: No description available. ,
EnableFailed: No description available. ,
Disabling: No description available. ,
DisableFailed: No description available. ,
Disabled: No description available. ,
Scaling: No description available. ,
ScalingFailed: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
redisVersion:
{
Description: Version of redis the cluster supports, e.g. '6' ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified Redis Enterprise cluster ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Distinguishes the kind of cluster. Read-only. ,
Enum:
{
v1: No description available. ,
v2: No description available. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: The SKU to create, which affects price, performance, and features. ,
Required: True ,
}
{
name:
{
Description: The level of Redis Enterprise cluster to deploy. Possible values: ('Balanced_B5', 'MemoryOptimized_M10', 'ComputeOptimized_X5', etc.). For more information on SKUs see the latest pricing documentation. Note that additional SKUs may become supported in the future. ,
Enum:
{
Enterprise_E1: No description available. ,
Enterprise_E5: No description available. ,
Enterprise_E10: No description available. ,
Enterprise_E20: No description available. ,
Enterprise_E50: No description available. ,
Enterprise_E100: No description available. ,
Enterprise_E200: No description available. ,
Enterprise_E400: No description available. ,
EnterpriseFlash_F300: No description available. ,
EnterpriseFlash_F700: No description available. ,
EnterpriseFlash_F1500: No description available. ,
Balanced_B0: No description available. ,
Balanced_B1: No description available. ,
Balanced_B3: No description available. ,
Balanced_B5: No description available. ,
Balanced_B10: No description available. ,
Balanced_B20: No description available. ,
Balanced_B50: No description available. ,
Balanced_B100: No description available. ,
Balanced_B150: No description available. ,
Balanced_B250: No description available. ,
Balanced_B350: No description available. ,
Balanced_B500: No description available. ,
Balanced_B700: No description available. ,
Balanced_B1000: No description available. ,
MemoryOptimized_M10: No description available. ,
MemoryOptimized_M20: No description available. ,
MemoryOptimized_M50: No description available. ,
MemoryOptimized_M100: No description available. ,
MemoryOptimized_M150: No description available. ,
MemoryOptimized_M250: No description available. ,
MemoryOptimized_M350: No description available. ,
MemoryOptimized_M500: No description available. ,
MemoryOptimized_M700: No description available. ,
MemoryOptimized_M1000: No description available. ,
MemoryOptimized_M1500: No description available. ,
MemoryOptimized_M2000: No description available. ,
ComputeOptimized_X3: No description available. ,
ComputeOptimized_X5: No description available. ,
ComputeOptimized_X10: No description available. ,
ComputeOptimized_X20: No description available. ,
ComputeOptimized_X50: No description available. ,
ComputeOptimized_X100: No description available. ,
ComputeOptimized_X150: No description available. ,
ComputeOptimized_X250: No description available. ,
ComputeOptimized_X350: No description available. ,
ComputeOptimized_X500: No description available. ,
ComputeOptimized_X700: No description available. ,
FlashOptimized_A250: No description available. ,
FlashOptimized_A500: No description available. ,
FlashOptimized_A700: No description available. ,
FlashOptimized_A1000: No description available. ,
FlashOptimized_A1500: No description available. ,
FlashOptimized_A2000: No description available. ,
FlashOptimized_A4500: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: This property is only used with Enterprise and EnterpriseFlash SKUs. Determines the size of the cluster. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for EnterpriseFlash SKUs. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
zones:
{
Description: The Availability Zones where this cluster will be deployed. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Other properties of the cluster. ,
Required: False ,
}
{
highAvailability:
{
Description: Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2'. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete -- you cannot use them. They are mentioned only for the sake of consistency with old API versions. ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption-at-rest configuration for the cluster. ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption. ,
Required: False ,
}
{
keyEncryptionKeyIdentity:
{
Description: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. ,
Required: False ,
}
string ,
identityType:
{
Description: Only userAssignedIdentity is supported in this API version; other types may be supported in the future ,
Enum:
{
systemAssignedIdentity: No description available. ,
userAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
keyEncryptionKeyUrl:
{
Description: Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 ,
Required: False ,
}
string ,
}
,
}
,
hostName:
{
Description: DNS name of the cluster endpoint ,
Required: False ,
}
string ,
provisioningState:
{
Description: Current provisioning status of the cluster ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
redundancyMode:
{
Description: Explains the current redundancy strategy of the cluster, which affects the expected SLA. ,
Enum:
{
None: No redundancy. Availability loss will occur. ,
LR: Local redundancy with high availability. ,
ZR: Zone redundant. Higher availability. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Current resource status of the cluster ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
CreateFailed: No description available. ,
Updating: No description available. ,
UpdateFailed: No description available. ,
Deleting: No description available. ,
DeleteFailed: No description available. ,
Enabling: No description available. ,
EnableFailed: No description available. ,
Disabling: No description available. ,
DisableFailed: No description available. ,
Disabled: No description available. ,
Scaling: No description available. ,
ScalingFailed: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
redisVersion:
{
Description: Version of redis the cluster supports, e.g. '6' ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified Redis Enterprise cluster ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RedisEnterprise_Update (new)
Description :  Updates an existing Redis Enterprise cluster
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update Redis Enterprise operation. ,
Required: True ,
}
{
sku:
{
Description: The SKU to create, which affects price, performance, and features. ,
Required: False ,
}
{
name:
{
Description: The level of Redis Enterprise cluster to deploy. Possible values: ('Balanced_B5', 'MemoryOptimized_M10', 'ComputeOptimized_X5', etc.). For more information on SKUs see the latest pricing documentation. Note that additional SKUs may become supported in the future. ,
Enum:
{
Enterprise_E1: No description available. ,
Enterprise_E5: No description available. ,
Enterprise_E10: No description available. ,
Enterprise_E20: No description available. ,
Enterprise_E50: No description available. ,
Enterprise_E100: No description available. ,
Enterprise_E200: No description available. ,
Enterprise_E400: No description available. ,
EnterpriseFlash_F300: No description available. ,
EnterpriseFlash_F700: No description available. ,
EnterpriseFlash_F1500: No description available. ,
Balanced_B0: No description available. ,
Balanced_B1: No description available. ,
Balanced_B3: No description available. ,
Balanced_B5: No description available. ,
Balanced_B10: No description available. ,
Balanced_B20: No description available. ,
Balanced_B50: No description available. ,
Balanced_B100: No description available. ,
Balanced_B150: No description available. ,
Balanced_B250: No description available. ,
Balanced_B350: No description available. ,
Balanced_B500: No description available. ,
Balanced_B700: No description available. ,
Balanced_B1000: No description available. ,
MemoryOptimized_M10: No description available. ,
MemoryOptimized_M20: No description available. ,
MemoryOptimized_M50: No description available. ,
MemoryOptimized_M100: No description available. ,
MemoryOptimized_M150: No description available. ,
MemoryOptimized_M250: No description available. ,
MemoryOptimized_M350: No description available. ,
MemoryOptimized_M500: No description available. ,
MemoryOptimized_M700: No description available. ,
MemoryOptimized_M1000: No description available. ,
MemoryOptimized_M1500: No description available. ,
MemoryOptimized_M2000: No description available. ,
ComputeOptimized_X3: No description available. ,
ComputeOptimized_X5: No description available. ,
ComputeOptimized_X10: No description available. ,
ComputeOptimized_X20: No description available. ,
ComputeOptimized_X50: No description available. ,
ComputeOptimized_X100: No description available. ,
ComputeOptimized_X150: No description available. ,
ComputeOptimized_X250: No description available. ,
ComputeOptimized_X350: No description available. ,
ComputeOptimized_X500: No description available. ,
ComputeOptimized_X700: No description available. ,
FlashOptimized_A250: No description available. ,
FlashOptimized_A500: No description available. ,
FlashOptimized_A700: No description available. ,
FlashOptimized_A1000: No description available. ,
FlashOptimized_A1500: No description available. ,
FlashOptimized_A2000: No description available. ,
FlashOptimized_A4500: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: This property is only used with Enterprise and EnterpriseFlash SKUs. Determines the size of the cluster. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for EnterpriseFlash SKUs. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Other properties of the cluster. ,
Required: False ,
}
{
highAvailability:
{
Description: Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2'. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete -- you cannot use them. They are mentioned only for the sake of consistency with old API versions. ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption-at-rest configuration for the cluster. ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption. ,
Required: False ,
}
{
keyEncryptionKeyIdentity:
{
Description: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. ,
Required: False ,
}
string ,
identityType:
{
Description: Only userAssignedIdentity is supported in this API version; other types may be supported in the future ,
Enum:
{
systemAssignedIdentity: No description available. ,
userAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
keyEncryptionKeyUrl:
{
Description: Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 ,
Required: False ,
}
string ,
}
,
}
,
hostName:
{
Description: DNS name of the cluster endpoint ,
Required: False ,
}
string ,
provisioningState:
{
Description: Current provisioning status of the cluster ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
redundancyMode:
{
Description: Explains the current redundancy strategy of the cluster, which affects the expected SLA. ,
Enum:
{
None: No redundancy. Availability loss will occur. ,
LR: Local redundancy with high availability. ,
ZR: Zone redundant. Higher availability. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Current resource status of the cluster ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
CreateFailed: No description available. ,
Updating: No description available. ,
UpdateFailed: No description available. ,
Deleting: No description available. ,
DeleteFailed: No description available. ,
Enabling: No description available. ,
EnableFailed: No description available. ,
Disabling: No description available. ,
DisableFailed: No description available. ,
Disabled: No description available. ,
Scaling: No description available. ,
ScalingFailed: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
redisVersion:
{
Description: Version of redis the cluster supports, e.g. '6' ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified Redis Enterprise cluster ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Distinguishes the kind of cluster. Read-only. ,
Enum:
{
v1: No description available. ,
v2: No description available. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: The SKU to create, which affects price, performance, and features. ,
Required: True ,
}
{
name:
{
Description: The level of Redis Enterprise cluster to deploy. Possible values: ('Balanced_B5', 'MemoryOptimized_M10', 'ComputeOptimized_X5', etc.). For more information on SKUs see the latest pricing documentation. Note that additional SKUs may become supported in the future. ,
Enum:
{
Enterprise_E1: No description available. ,
Enterprise_E5: No description available. ,
Enterprise_E10: No description available. ,
Enterprise_E20: No description available. ,
Enterprise_E50: No description available. ,
Enterprise_E100: No description available. ,
Enterprise_E200: No description available. ,
Enterprise_E400: No description available. ,
EnterpriseFlash_F300: No description available. ,
EnterpriseFlash_F700: No description available. ,
EnterpriseFlash_F1500: No description available. ,
Balanced_B0: No description available. ,
Balanced_B1: No description available. ,
Balanced_B3: No description available. ,
Balanced_B5: No description available. ,
Balanced_B10: No description available. ,
Balanced_B20: No description available. ,
Balanced_B50: No description available. ,
Balanced_B100: No description available. ,
Balanced_B150: No description available. ,
Balanced_B250: No description available. ,
Balanced_B350: No description available. ,
Balanced_B500: No description available. ,
Balanced_B700: No description available. ,
Balanced_B1000: No description available. ,
MemoryOptimized_M10: No description available. ,
MemoryOptimized_M20: No description available. ,
MemoryOptimized_M50: No description available. ,
MemoryOptimized_M100: No description available. ,
MemoryOptimized_M150: No description available. ,
MemoryOptimized_M250: No description available. ,
MemoryOptimized_M350: No description available. ,
MemoryOptimized_M500: No description available. ,
MemoryOptimized_M700: No description available. ,
MemoryOptimized_M1000: No description available. ,
MemoryOptimized_M1500: No description available. ,
MemoryOptimized_M2000: No description available. ,
ComputeOptimized_X3: No description available. ,
ComputeOptimized_X5: No description available. ,
ComputeOptimized_X10: No description available. ,
ComputeOptimized_X20: No description available. ,
ComputeOptimized_X50: No description available. ,
ComputeOptimized_X100: No description available. ,
ComputeOptimized_X150: No description available. ,
ComputeOptimized_X250: No description available. ,
ComputeOptimized_X350: No description available. ,
ComputeOptimized_X500: No description available. ,
ComputeOptimized_X700: No description available. ,
FlashOptimized_A250: No description available. ,
FlashOptimized_A500: No description available. ,
FlashOptimized_A700: No description available. ,
FlashOptimized_A1000: No description available. ,
FlashOptimized_A1500: No description available. ,
FlashOptimized_A2000: No description available. ,
FlashOptimized_A4500: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: This property is only used with Enterprise and EnterpriseFlash SKUs. Determines the size of the cluster. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for EnterpriseFlash SKUs. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
zones:
{
Description: The Availability Zones where this cluster will be deployed. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Other properties of the cluster. ,
Required: False ,
}
{
highAvailability:
{
Description: Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2'. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete -- you cannot use them. They are mentioned only for the sake of consistency with old API versions. ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption-at-rest configuration for the cluster. ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption. ,
Required: False ,
}
{
keyEncryptionKeyIdentity:
{
Description: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. ,
Required: False ,
}
string ,
identityType:
{
Description: Only userAssignedIdentity is supported in this API version; other types may be supported in the future ,
Enum:
{
systemAssignedIdentity: No description available. ,
userAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
keyEncryptionKeyUrl:
{
Description: Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 ,
Required: False ,
}
string ,
}
,
}
,
hostName:
{
Description: DNS name of the cluster endpoint ,
Required: False ,
}
string ,
provisioningState:
{
Description: Current provisioning status of the cluster ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
redundancyMode:
{
Description: Explains the current redundancy strategy of the cluster, which affects the expected SLA. ,
Enum:
{
None: No redundancy. Availability loss will occur. ,
LR: Local redundancy with high availability. ,
ZR: Zone redundant. Higher availability. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Current resource status of the cluster ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
CreateFailed: No description available. ,
Updating: No description available. ,
UpdateFailed: No description available. ,
Deleting: No description available. ,
DeleteFailed: No description available. ,
Enabling: No description available. ,
EnableFailed: No description available. ,
Disabling: No description available. ,
DisableFailed: No description available. ,
Disabled: No description available. ,
Scaling: No description available. ,
ScalingFailed: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
redisVersion:
{
Description: Version of redis the cluster supports, e.g. '6' ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified Redis Enterprise cluster ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation URI to poll for result ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RedisEnterprise_Delete (new)
Description :  Deletes a Redis Enterprise cache cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation URI to poll for result ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RedisEnterprise_Get (new)
Description :  Gets information about a Redis Enterprise cluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Distinguishes the kind of cluster. Read-only. ,
Enum:
{
v1: No description available. ,
v2: No description available. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: The SKU to create, which affects price, performance, and features. ,
Required: True ,
}
{
name:
{
Description: The level of Redis Enterprise cluster to deploy. Possible values: ('Balanced_B5', 'MemoryOptimized_M10', 'ComputeOptimized_X5', etc.). For more information on SKUs see the latest pricing documentation. Note that additional SKUs may become supported in the future. ,
Enum:
{
Enterprise_E1: No description available. ,
Enterprise_E5: No description available. ,
Enterprise_E10: No description available. ,
Enterprise_E20: No description available. ,
Enterprise_E50: No description available. ,
Enterprise_E100: No description available. ,
Enterprise_E200: No description available. ,
Enterprise_E400: No description available. ,
EnterpriseFlash_F300: No description available. ,
EnterpriseFlash_F700: No description available. ,
EnterpriseFlash_F1500: No description available. ,
Balanced_B0: No description available. ,
Balanced_B1: No description available. ,
Balanced_B3: No description available. ,
Balanced_B5: No description available. ,
Balanced_B10: No description available. ,
Balanced_B20: No description available. ,
Balanced_B50: No description available. ,
Balanced_B100: No description available. ,
Balanced_B150: No description available. ,
Balanced_B250: No description available. ,
Balanced_B350: No description available. ,
Balanced_B500: No description available. ,
Balanced_B700: No description available. ,
Balanced_B1000: No description available. ,
MemoryOptimized_M10: No description available. ,
MemoryOptimized_M20: No description available. ,
MemoryOptimized_M50: No description available. ,
MemoryOptimized_M100: No description available. ,
MemoryOptimized_M150: No description available. ,
MemoryOptimized_M250: No description available. ,
MemoryOptimized_M350: No description available. ,
MemoryOptimized_M500: No description available. ,
MemoryOptimized_M700: No description available. ,
MemoryOptimized_M1000: No description available. ,
MemoryOptimized_M1500: No description available. ,
MemoryOptimized_M2000: No description available. ,
ComputeOptimized_X3: No description available. ,
ComputeOptimized_X5: No description available. ,
ComputeOptimized_X10: No description available. ,
ComputeOptimized_X20: No description available. ,
ComputeOptimized_X50: No description available. ,
ComputeOptimized_X100: No description available. ,
ComputeOptimized_X150: No description available. ,
ComputeOptimized_X250: No description available. ,
ComputeOptimized_X350: No description available. ,
ComputeOptimized_X500: No description available. ,
ComputeOptimized_X700: No description available. ,
FlashOptimized_A250: No description available. ,
FlashOptimized_A500: No description available. ,
FlashOptimized_A700: No description available. ,
FlashOptimized_A1000: No description available. ,
FlashOptimized_A1500: No description available. ,
FlashOptimized_A2000: No description available. ,
FlashOptimized_A4500: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: This property is only used with Enterprise and EnterpriseFlash SKUs. Determines the size of the cluster. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for EnterpriseFlash SKUs. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
zones:
{
Description: The Availability Zones where this cluster will be deployed. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Other properties of the cluster. ,
Required: False ,
}
{
highAvailability:
{
Description: Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2'. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete -- you cannot use them. They are mentioned only for the sake of consistency with old API versions. ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption-at-rest configuration for the cluster. ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption. ,
Required: False ,
}
{
keyEncryptionKeyIdentity:
{
Description: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. ,
Required: False ,
}
string ,
identityType:
{
Description: Only userAssignedIdentity is supported in this API version; other types may be supported in the future ,
Enum:
{
systemAssignedIdentity: No description available. ,
userAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
keyEncryptionKeyUrl:
{
Description: Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 ,
Required: False ,
}
string ,
}
,
}
,
hostName:
{
Description: DNS name of the cluster endpoint ,
Required: False ,
}
string ,
provisioningState:
{
Description: Current provisioning status of the cluster ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
redundancyMode:
{
Description: Explains the current redundancy strategy of the cluster, which affects the expected SLA. ,
Enum:
{
None: No redundancy. Availability loss will occur. ,
LR: Local redundancy with high availability. ,
ZR: Zone redundant. Higher availability. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Current resource status of the cluster ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
CreateFailed: No description available. ,
Updating: No description available. ,
UpdateFailed: No description available. ,
Deleting: No description available. ,
DeleteFailed: No description available. ,
Enabling: No description available. ,
EnableFailed: No description available. ,
Disabling: No description available. ,
DisableFailed: No description available. ,
Disabled: No description available. ,
Scaling: No description available. ,
ScalingFailed: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
redisVersion:
{
Description: Version of redis the cluster supports, e.g. '6' ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified Redis Enterprise cluster ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RedisEnterprise_ListByResourceGroup (new)
Description :  Lists all Redis Enterprise clusters in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of clusters. ,
Required: False ,
}
[
{
kind:
{
Description: Distinguishes the kind of cluster. Read-only. ,
Enum:
{
v1: No description available. ,
v2: No description available. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: The SKU to create, which affects price, performance, and features. ,
Required: True ,
}
{
name:
{
Description: The level of Redis Enterprise cluster to deploy. Possible values: ('Balanced_B5', 'MemoryOptimized_M10', 'ComputeOptimized_X5', etc.). For more information on SKUs see the latest pricing documentation. Note that additional SKUs may become supported in the future. ,
Enum:
{
Enterprise_E1: No description available. ,
Enterprise_E5: No description available. ,
Enterprise_E10: No description available. ,
Enterprise_E20: No description available. ,
Enterprise_E50: No description available. ,
Enterprise_E100: No description available. ,
Enterprise_E200: No description available. ,
Enterprise_E400: No description available. ,
EnterpriseFlash_F300: No description available. ,
EnterpriseFlash_F700: No description available. ,
EnterpriseFlash_F1500: No description available. ,
Balanced_B0: No description available. ,
Balanced_B1: No description available. ,
Balanced_B3: No description available. ,
Balanced_B5: No description available. ,
Balanced_B10: No description available. ,
Balanced_B20: No description available. ,
Balanced_B50: No description available. ,
Balanced_B100: No description available. ,
Balanced_B150: No description available. ,
Balanced_B250: No description available. ,
Balanced_B350: No description available. ,
Balanced_B500: No description available. ,
Balanced_B700: No description available. ,
Balanced_B1000: No description available. ,
MemoryOptimized_M10: No description available. ,
MemoryOptimized_M20: No description available. ,
MemoryOptimized_M50: No description available. ,
MemoryOptimized_M100: No description available. ,
MemoryOptimized_M150: No description available. ,
MemoryOptimized_M250: No description available. ,
MemoryOptimized_M350: No description available. ,
MemoryOptimized_M500: No description available. ,
MemoryOptimized_M700: No description available. ,
MemoryOptimized_M1000: No description available. ,
MemoryOptimized_M1500: No description available. ,
MemoryOptimized_M2000: No description available. ,
ComputeOptimized_X3: No description available. ,
ComputeOptimized_X5: No description available. ,
ComputeOptimized_X10: No description available. ,
ComputeOptimized_X20: No description available. ,
ComputeOptimized_X50: No description available. ,
ComputeOptimized_X100: No description available. ,
ComputeOptimized_X150: No description available. ,
ComputeOptimized_X250: No description available. ,
ComputeOptimized_X350: No description available. ,
ComputeOptimized_X500: No description available. ,
ComputeOptimized_X700: No description available. ,
FlashOptimized_A250: No description available. ,
FlashOptimized_A500: No description available. ,
FlashOptimized_A700: No description available. ,
FlashOptimized_A1000: No description available. ,
FlashOptimized_A1500: No description available. ,
FlashOptimized_A2000: No description available. ,
FlashOptimized_A4500: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: This property is only used with Enterprise and EnterpriseFlash SKUs. Determines the size of the cluster. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for EnterpriseFlash SKUs. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
zones:
{
Description: The Availability Zones where this cluster will be deployed. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Other properties of the cluster. ,
Required: False ,
}
{
highAvailability:
{
Description: Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2'. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete -- you cannot use them. They are mentioned only for the sake of consistency with old API versions. ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption-at-rest configuration for the cluster. ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption. ,
Required: False ,
}
{
keyEncryptionKeyIdentity:
{
Description: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. ,
Required: False ,
}
string ,
identityType:
{
Description: Only userAssignedIdentity is supported in this API version; other types may be supported in the future ,
Enum:
{
systemAssignedIdentity: No description available. ,
userAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
keyEncryptionKeyUrl:
{
Description: Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 ,
Required: False ,
}
string ,
}
,
}
,
hostName:
{
Description: DNS name of the cluster endpoint ,
Required: False ,
}
string ,
provisioningState:
{
Description: Current provisioning status of the cluster ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
redundancyMode:
{
Description: Explains the current redundancy strategy of the cluster, which affects the expected SLA. ,
Enum:
{
None: No redundancy. Availability loss will occur. ,
LR: Local redundancy with high availability. ,
ZR: Zone redundant. Higher availability. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Current resource status of the cluster ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
CreateFailed: No description available. ,
Updating: No description available. ,
UpdateFailed: No description available. ,
Deleting: No description available. ,
DeleteFailed: No description available. ,
Enabling: No description available. ,
EnableFailed: No description available. ,
Disabling: No description available. ,
DisableFailed: No description available. ,
Disabled: No description available. ,
Scaling: No description available. ,
ScalingFailed: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
redisVersion:
{
Description: Version of redis the cluster supports, e.g. '6' ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified Redis Enterprise cluster ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RedisEnterprise_List (new)
Description :  Lists all Redis Enterprise clusters in the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Cache/redisEnterprise
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of clusters. ,
Required: False ,
}
[
{
kind:
{
Description: Distinguishes the kind of cluster. Read-only. ,
Enum:
{
v1: No description available. ,
v2: No description available. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: The SKU to create, which affects price, performance, and features. ,
Required: True ,
}
{
name:
{
Description: The level of Redis Enterprise cluster to deploy. Possible values: ('Balanced_B5', 'MemoryOptimized_M10', 'ComputeOptimized_X5', etc.). For more information on SKUs see the latest pricing documentation. Note that additional SKUs may become supported in the future. ,
Enum:
{
Enterprise_E1: No description available. ,
Enterprise_E5: No description available. ,
Enterprise_E10: No description available. ,
Enterprise_E20: No description available. ,
Enterprise_E50: No description available. ,
Enterprise_E100: No description available. ,
Enterprise_E200: No description available. ,
Enterprise_E400: No description available. ,
EnterpriseFlash_F300: No description available. ,
EnterpriseFlash_F700: No description available. ,
EnterpriseFlash_F1500: No description available. ,
Balanced_B0: No description available. ,
Balanced_B1: No description available. ,
Balanced_B3: No description available. ,
Balanced_B5: No description available. ,
Balanced_B10: No description available. ,
Balanced_B20: No description available. ,
Balanced_B50: No description available. ,
Balanced_B100: No description available. ,
Balanced_B150: No description available. ,
Balanced_B250: No description available. ,
Balanced_B350: No description available. ,
Balanced_B500: No description available. ,
Balanced_B700: No description available. ,
Balanced_B1000: No description available. ,
MemoryOptimized_M10: No description available. ,
MemoryOptimized_M20: No description available. ,
MemoryOptimized_M50: No description available. ,
MemoryOptimized_M100: No description available. ,
MemoryOptimized_M150: No description available. ,
MemoryOptimized_M250: No description available. ,
MemoryOptimized_M350: No description available. ,
MemoryOptimized_M500: No description available. ,
MemoryOptimized_M700: No description available. ,
MemoryOptimized_M1000: No description available. ,
MemoryOptimized_M1500: No description available. ,
MemoryOptimized_M2000: No description available. ,
ComputeOptimized_X3: No description available. ,
ComputeOptimized_X5: No description available. ,
ComputeOptimized_X10: No description available. ,
ComputeOptimized_X20: No description available. ,
ComputeOptimized_X50: No description available. ,
ComputeOptimized_X100: No description available. ,
ComputeOptimized_X150: No description available. ,
ComputeOptimized_X250: No description available. ,
ComputeOptimized_X350: No description available. ,
ComputeOptimized_X500: No description available. ,
ComputeOptimized_X700: No description available. ,
FlashOptimized_A250: No description available. ,
FlashOptimized_A500: No description available. ,
FlashOptimized_A700: No description available. ,
FlashOptimized_A1000: No description available. ,
FlashOptimized_A1500: No description available. ,
FlashOptimized_A2000: No description available. ,
FlashOptimized_A4500: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: This property is only used with Enterprise and EnterpriseFlash SKUs. Determines the size of the cluster. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for EnterpriseFlash SKUs. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
zones:
{
Description: The Availability Zones where this cluster will be deployed. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Other properties of the cluster. ,
Required: False ,
}
{
highAvailability:
{
Description: Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2'. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete -- you cannot use them. They are mentioned only for the sake of consistency with old API versions. ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: Encryption-at-rest configuration for the cluster. ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption. ,
Required: False ,
}
{
keyEncryptionKeyIdentity:
{
Description: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. ,
Required: False ,
}
string ,
identityType:
{
Description: Only userAssignedIdentity is supported in this API version; other types may be supported in the future ,
Enum:
{
systemAssignedIdentity: No description available. ,
userAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
keyEncryptionKeyUrl:
{
Description: Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 ,
Required: False ,
}
string ,
}
,
}
,
hostName:
{
Description: DNS name of the cluster endpoint ,
Required: False ,
}
string ,
provisioningState:
{
Description: Current provisioning status of the cluster ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
redundancyMode:
{
Description: Explains the current redundancy strategy of the cluster, which affects the expected SLA. ,
Enum:
{
None: No redundancy. Availability loss will occur. ,
LR: Local redundancy with high availability. ,
ZR: Zone redundant. Higher availability. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Current resource status of the cluster ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
CreateFailed: No description available. ,
Updating: No description available. ,
UpdateFailed: No description available. ,
Deleting: No description available. ,
DeleteFailed: No description available. ,
Enabling: No description available. ,
EnableFailed: No description available. ,
Disabling: No description available. ,
DisableFailed: No description available. ,
Disabled: No description available. ,
Scaling: No description available. ,
ScalingFailed: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
redisVersion:
{
Description: Version of redis the cluster supports, e.g. '6' ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified Redis Enterprise cluster ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Databases_ListByCluster (new)
Description :  Gets all databases in the specified Redis Enterprise cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of databases ,
Required: False ,
}
[
{
properties:
{
Description: Other properties of the database. ,
Required: False ,
}
{
clientProtocol:
{
Description: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. ,
Enum:
{
Encrypted: No description available. ,
Plaintext: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: TCP port of the database endpoint. Specified at create time. Defaults to an available port. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Current provisioning status of the database ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Current resource status of the database ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
CreateFailed: No description available. ,
Updating: No description available. ,
UpdateFailed: No description available. ,
Deleting: No description available. ,
DeleteFailed: No description available. ,
Enabling: No description available. ,
EnableFailed: No description available. ,
Disabling: No description available. ,
DisableFailed: No description available. ,
Disabled: No description available. ,
Scaling: No description available. ,
ScalingFailed: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
clusteringPolicy:
{
Description: Clustering policy - default is OSSCluster. This property must be chosen at create time, and cannot be changed without deleting the database. ,
Enum:
{
EnterpriseCluster: Enterprise clustering policy uses only the classic redis protocol, which does not support redis cluster commands. ,
OSSCluster: OSS clustering policy follows the redis cluster specification, and requires all clients to support redis clustering. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Redis eviction policy - default is VolatileLRU ,
Enum:
{
AllKeysLFU: No description available. ,
AllKeysLRU: No description available. ,
AllKeysRandom: No description available. ,
VolatileLRU: No description available. ,
VolatileLFU: No description available. ,
VolatileTTL: No description available. ,
VolatileRandom: No description available. ,
NoEviction: No description available. ,
}
,
Required: False ,
}
enum ,
persistence:
{
Description: Persistence settings ,
Required: False ,
}
{
aofEnabled:
{
Description: Sets whether AOF is enabled. Note that at most one of AOF or RDB persistence may be enabled. ,
Required: False ,
}
boolean ,
rdbEnabled:
{
Description: Sets whether RDB is enabled. Note that at most one of AOF or RDB persistence may be enabled. ,
Required: False ,
}
boolean ,
aofFrequency:
{
Description: Sets the frequency at which data is written to disk. Defaults to '1s', meaning 'every second'. Note that the 'always' setting is deprecated, because of its performance impact. ,
Enum:
{
1s: No description available. ,
always: No description available. ,
}
,
Required: False ,
}
enum ,
rdbFrequency:
{
Description: Sets the frequency at which a snapshot of the database is created. ,
Enum:
{
1h: No description available. ,
6h: No description available. ,
12h: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
modules:
{
Description: Optional set of redis modules to enable in this database - modules can only be added at creation time. ,
Required: False ,
}
[
{
name:
{
Description: The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries' ,
Required: True ,
}
string ,
args:
{
Description: Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'. ,
Required: False ,
}
string ,
version:
{
Description: The version of the module, e.g. '1.0'. ,
Required: False ,
}
string ,
}
,
]
,
geoReplication:
{
Description: Optional set of properties to configure geo replication for this database. ,
Required: False ,
}
{
groupNickname:
{
Description: Name for the group of linked database resources ,
Required: False ,
}
string ,
linkedDatabases:
{
Description: List of database resources to link with this database ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a database resource to link with this database. ,
Format: arm-id ,
Required: False ,
}
string ,
state:
{
Description: State of the link between the database resources. ,
Enum:
{
Linked: No description available. ,
Linking: No description available. ,
Unlinking: No description available. ,
LinkFailed: No description available. ,
UnlinkFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
redisVersion:
{
Description: Version of Redis the database is running on, e.g. '6.0' ,
Required: False ,
}
string ,
deferUpgrade:
{
Description: Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade ,
Enum:
{
Deferred: No description available. ,
NotDeferred: No description available. ,
}
,
Required: False ,
}
enum ,
accessKeysAuthentication:
{
Description: This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Databases_Create (new)
Description :  Creates a database
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the Redis Enterprise database. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update database operation. ,
Required: True ,
}
{
properties:
{
Description: Other properties of the database. ,
Required: False ,
}
{
clientProtocol:
{
Description: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. ,
Enum:
{
Encrypted: No description available. ,
Plaintext: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: TCP port of the database endpoint. Specified at create time. Defaults to an available port. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Current provisioning status of the database ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Current resource status of the database ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
CreateFailed: No description available. ,
Updating: No description available. ,
UpdateFailed: No description available. ,
Deleting: No description available. ,
DeleteFailed: No description available. ,
Enabling: No description available. ,
EnableFailed: No description available. ,
Disabling: No description available. ,
DisableFailed: No description available. ,
Disabled: No description available. ,
Scaling: No description available. ,
ScalingFailed: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
clusteringPolicy:
{
Description: Clustering policy - default is OSSCluster. This property must be chosen at create time, and cannot be changed without deleting the database. ,
Enum:
{
EnterpriseCluster: Enterprise clustering policy uses only the classic redis protocol, which does not support redis cluster commands. ,
OSSCluster: OSS clustering policy follows the redis cluster specification, and requires all clients to support redis clustering. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Redis eviction policy - default is VolatileLRU ,
Enum:
{
AllKeysLFU: No description available. ,
AllKeysLRU: No description available. ,
AllKeysRandom: No description available. ,
VolatileLRU: No description available. ,
VolatileLFU: No description available. ,
VolatileTTL: No description available. ,
VolatileRandom: No description available. ,
NoEviction: No description available. ,
}
,
Required: False ,
}
enum ,
persistence:
{
Description: Persistence settings ,
Required: False ,
}
{
aofEnabled:
{
Description: Sets whether AOF is enabled. Note that at most one of AOF or RDB persistence may be enabled. ,
Required: False ,
}
boolean ,
rdbEnabled:
{
Description: Sets whether RDB is enabled. Note that at most one of AOF or RDB persistence may be enabled. ,
Required: False ,
}
boolean ,
aofFrequency:
{
Description: Sets the frequency at which data is written to disk. Defaults to '1s', meaning 'every second'. Note that the 'always' setting is deprecated, because of its performance impact. ,
Enum:
{
1s: No description available. ,
always: No description available. ,
}
,
Required: False ,
}
enum ,
rdbFrequency:
{
Description: Sets the frequency at which a snapshot of the database is created. ,
Enum:
{
1h: No description available. ,
6h: No description available. ,
12h: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
modules:
{
Description: Optional set of redis modules to enable in this database - modules can only be added at creation time. ,
Required: False ,
}
[
{
name:
{
Description: The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries' ,
Required: True ,
}
string ,
args:
{
Description: Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'. ,
Required: False ,
}
string ,
version:
{
Description: The version of the module, e.g. '1.0'. ,
Required: False ,
}
string ,
}
,
]
,
geoReplication:
{
Description: Optional set of properties to configure geo replication for this database. ,
Required: False ,
}
{
groupNickname:
{
Description: Name for the group of linked database resources ,
Required: False ,
}
string ,
linkedDatabases:
{
Description: List of database resources to link with this database ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a database resource to link with this database. ,
Format: arm-id ,
Required: False ,
}
string ,
state:
{
Description: State of the link between the database resources. ,
Enum:
{
Linked: No description available. ,
Linking: No description available. ,
Unlinking: No description available. ,
LinkFailed: No description available. ,
UnlinkFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
redisVersion:
{
Description: Version of Redis the database is running on, e.g. '6.0' ,
Required: False ,
}
string ,
deferUpgrade:
{
Description: Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade ,
Enum:
{
Deferred: No description available. ,
NotDeferred: No description available. ,
}
,
Required: False ,
}
enum ,
accessKeysAuthentication:
{
Description: This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Other properties of the database. ,
Required: False ,
}
{
clientProtocol:
{
Description: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. ,
Enum:
{
Encrypted: No description available. ,
Plaintext: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: TCP port of the database endpoint. Specified at create time. Defaults to an available port. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Current provisioning status of the database ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Current resource status of the database ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
CreateFailed: No description available. ,
Updating: No description available. ,
UpdateFailed: No description available. ,
Deleting: No description available. ,
DeleteFailed: No description available. ,
Enabling: No description available. ,
EnableFailed: No description available. ,
Disabling: No description available. ,
DisableFailed: No description available. ,
Disabled: No description available. ,
Scaling: No description available. ,
ScalingFailed: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
clusteringPolicy:
{
Description: Clustering policy - default is OSSCluster. This property must be chosen at create time, and cannot be changed without deleting the database. ,
Enum:
{
EnterpriseCluster: Enterprise clustering policy uses only the classic redis protocol, which does not support redis cluster commands. ,
OSSCluster: OSS clustering policy follows the redis cluster specification, and requires all clients to support redis clustering. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Redis eviction policy - default is VolatileLRU ,
Enum:
{
AllKeysLFU: No description available. ,
AllKeysLRU: No description available. ,
AllKeysRandom: No description available. ,
VolatileLRU: No description available. ,
VolatileLFU: No description available. ,
VolatileTTL: No description available. ,
VolatileRandom: No description available. ,
NoEviction: No description available. ,
}
,
Required: False ,
}
enum ,
persistence:
{
Description: Persistence settings ,
Required: False ,
}
{
aofEnabled:
{
Description: Sets whether AOF is enabled. Note that at most one of AOF or RDB persistence may be enabled. ,
Required: False ,
}
boolean ,
rdbEnabled:
{
Description: Sets whether RDB is enabled. Note that at most one of AOF or RDB persistence may be enabled. ,
Required: False ,
}
boolean ,
aofFrequency:
{
Description: Sets the frequency at which data is written to disk. Defaults to '1s', meaning 'every second'. Note that the 'always' setting is deprecated, because of its performance impact. ,
Enum:
{
1s: No description available. ,
always: No description available. ,
}
,
Required: False ,
}
enum ,
rdbFrequency:
{
Description: Sets the frequency at which a snapshot of the database is created. ,
Enum:
{
1h: No description available. ,
6h: No description available. ,
12h: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
modules:
{
Description: Optional set of redis modules to enable in this database - modules can only be added at creation time. ,
Required: False ,
}
[
{
name:
{
Description: The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries' ,
Required: True ,
}
string ,
args:
{
Description: Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'. ,
Required: False ,
}
string ,
version:
{
Description: The version of the module, e.g. '1.0'. ,
Required: False ,
}
string ,
}
,
]
,
geoReplication:
{
Description: Optional set of properties to configure geo replication for this database. ,
Required: False ,
}
{
groupNickname:
{
Description: Name for the group of linked database resources ,
Required: False ,
}
string ,
linkedDatabases:
{
Description: List of database resources to link with this database ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a database resource to link with this database. ,
Format: arm-id ,
Required: False ,
}
string ,
state:
{
Description: State of the link between the database resources. ,
Enum:
{
Linked: No description available. ,
Linking: No description available. ,
Unlinking: No description available. ,
LinkFailed: No description available. ,
UnlinkFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
redisVersion:
{
Description: Version of Redis the database is running on, e.g. '6.0' ,
Required: False ,
}
string ,
deferUpgrade:
{
Description: Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade ,
Enum:
{
Deferred: No description available. ,
NotDeferred: No description available. ,
}
,
Required: False ,
}
enum ,
accessKeysAuthentication:
{
Description: This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Other properties of the database. ,
Required: False ,
}
{
clientProtocol:
{
Description: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. ,
Enum:
{
Encrypted: No description available. ,
Plaintext: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: TCP port of the database endpoint. Specified at create time. Defaults to an available port. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Current provisioning status of the database ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Current resource status of the database ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
CreateFailed: No description available. ,
Updating: No description available. ,
UpdateFailed: No description available. ,
Deleting: No description available. ,
DeleteFailed: No description available. ,
Enabling: No description available. ,
EnableFailed: No description available. ,
Disabling: No description available. ,
DisableFailed: No description available. ,
Disabled: No description available. ,
Scaling: No description available. ,
ScalingFailed: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
clusteringPolicy:
{
Description: Clustering policy - default is OSSCluster. This property must be chosen at create time, and cannot be changed without deleting the database. ,
Enum:
{
EnterpriseCluster: Enterprise clustering policy uses only the classic redis protocol, which does not support redis cluster commands. ,
OSSCluster: OSS clustering policy follows the redis cluster specification, and requires all clients to support redis clustering. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Redis eviction policy - default is VolatileLRU ,
Enum:
{
AllKeysLFU: No description available. ,
AllKeysLRU: No description available. ,
AllKeysRandom: No description available. ,
VolatileLRU: No description available. ,
VolatileLFU: No description available. ,
VolatileTTL: No description available. ,
VolatileRandom: No description available. ,
NoEviction: No description available. ,
}
,
Required: False ,
}
enum ,
persistence:
{
Description: Persistence settings ,
Required: False ,
}
{
aofEnabled:
{
Description: Sets whether AOF is enabled. Note that at most one of AOF or RDB persistence may be enabled. ,
Required: False ,
}
boolean ,
rdbEnabled:
{
Description: Sets whether RDB is enabled. Note that at most one of AOF or RDB persistence may be enabled. ,
Required: False ,
}
boolean ,
aofFrequency:
{
Description: Sets the frequency at which data is written to disk. Defaults to '1s', meaning 'every second'. Note that the 'always' setting is deprecated, because of its performance impact. ,
Enum:
{
1s: No description available. ,
always: No description available. ,
}
,
Required: False ,
}
enum ,
rdbFrequency:
{
Description: Sets the frequency at which a snapshot of the database is created. ,
Enum:
{
1h: No description available. ,
6h: No description available. ,
12h: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
modules:
{
Description: Optional set of redis modules to enable in this database - modules can only be added at creation time. ,
Required: False ,
}
[
{
name:
{
Description: The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries' ,
Required: True ,
}
string ,
args:
{
Description: Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'. ,
Required: False ,
}
string ,
version:
{
Description: The version of the module, e.g. '1.0'. ,
Required: False ,
}
string ,
}
,
]
,
geoReplication:
{
Description: Optional set of properties to configure geo replication for this database. ,
Required: False ,
}
{
groupNickname:
{
Description: Name for the group of linked database resources ,
Required: False ,
}
string ,
linkedDatabases:
{
Description: List of database resources to link with this database ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a database resource to link with this database. ,
Format: arm-id ,
Required: False ,
}
string ,
state:
{
Description: State of the link between the database resources. ,
Enum:
{
Linked: No description available. ,
Linking: No description available. ,
Unlinking: No description available. ,
LinkFailed: No description available. ,
UnlinkFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
redisVersion:
{
Description: Version of Redis the database is running on, e.g. '6.0' ,
Required: False ,
}
string ,
deferUpgrade:
{
Description: Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade ,
Enum:
{
Deferred: No description available. ,
NotDeferred: No description available. ,
}
,
Required: False ,
}
enum ,
accessKeysAuthentication:
{
Description: This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Databases_Update (new)
Description :  Updates a database
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the Redis Enterprise database. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update database operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the database. ,
Required: False ,
}
{
clientProtocol:
{
Description: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. ,
Enum:
{
Encrypted: No description available. ,
Plaintext: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: TCP port of the database endpoint. Specified at create time. Defaults to an available port. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Current provisioning status of the database ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Current resource status of the database ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
CreateFailed: No description available. ,
Updating: No description available. ,
UpdateFailed: No description available. ,
Deleting: No description available. ,
DeleteFailed: No description available. ,
Enabling: No description available. ,
EnableFailed: No description available. ,
Disabling: No description available. ,
DisableFailed: No description available. ,
Disabled: No description available. ,
Scaling: No description available. ,
ScalingFailed: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
clusteringPolicy:
{
Description: Clustering policy - default is OSSCluster. This property must be chosen at create time, and cannot be changed without deleting the database. ,
Enum:
{
EnterpriseCluster: Enterprise clustering policy uses only the classic redis protocol, which does not support redis cluster commands. ,
OSSCluster: OSS clustering policy follows the redis cluster specification, and requires all clients to support redis clustering. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Redis eviction policy - default is VolatileLRU ,
Enum:
{
AllKeysLFU: No description available. ,
AllKeysLRU: No description available. ,
AllKeysRandom: No description available. ,
VolatileLRU: No description available. ,
VolatileLFU: No description available. ,
VolatileTTL: No description available. ,
VolatileRandom: No description available. ,
NoEviction: No description available. ,
}
,
Required: False ,
}
enum ,
persistence:
{
Description: Persistence settings ,
Required: False ,
}
{
aofEnabled:
{
Description: Sets whether AOF is enabled. Note that at most one of AOF or RDB persistence may be enabled. ,
Required: False ,
}
boolean ,
rdbEnabled:
{
Description: Sets whether RDB is enabled. Note that at most one of AOF or RDB persistence may be enabled. ,
Required: False ,
}
boolean ,
aofFrequency:
{
Description: Sets the frequency at which data is written to disk. Defaults to '1s', meaning 'every second'. Note that the 'always' setting is deprecated, because of its performance impact. ,
Enum:
{
1s: No description available. ,
always: No description available. ,
}
,
Required: False ,
}
enum ,
rdbFrequency:
{
Description: Sets the frequency at which a snapshot of the database is created. ,
Enum:
{
1h: No description available. ,
6h: No description available. ,
12h: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
modules:
{
Description: Optional set of redis modules to enable in this database - modules can only be added at creation time. ,
Required: False ,
}
[
{
name:
{
Description: The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries' ,
Required: True ,
}
string ,
args:
{
Description: Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'. ,
Required: False ,
}
string ,
version:
{
Description: The version of the module, e.g. '1.0'. ,
Required: False ,
}
string ,
}
,
]
,
geoReplication:
{
Description: Optional set of properties to configure geo replication for this database. ,
Required: False ,
}
{
groupNickname:
{
Description: Name for the group of linked database resources ,
Required: False ,
}
string ,
linkedDatabases:
{
Description: List of database resources to link with this database ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a database resource to link with this database. ,
Format: arm-id ,
Required: False ,
}
string ,
state:
{
Description: State of the link between the database resources. ,
Enum:
{
Linked: No description available. ,
Linking: No description available. ,
Unlinking: No description available. ,
LinkFailed: No description available. ,
UnlinkFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
redisVersion:
{
Description: Version of Redis the database is running on, e.g. '6.0' ,
Required: False ,
}
string ,
deferUpgrade:
{
Description: Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade ,
Enum:
{
Deferred: No description available. ,
NotDeferred: No description available. ,
}
,
Required: False ,
}
enum ,
accessKeysAuthentication:
{
Description: This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Other properties of the database. ,
Required: False ,
}
{
clientProtocol:
{
Description: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. ,
Enum:
{
Encrypted: No description available. ,
Plaintext: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: TCP port of the database endpoint. Specified at create time. Defaults to an available port. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Current provisioning status of the database ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Current resource status of the database ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
CreateFailed: No description available. ,
Updating: No description available. ,
UpdateFailed: No description available. ,
Deleting: No description available. ,
DeleteFailed: No description available. ,
Enabling: No description available. ,
EnableFailed: No description available. ,
Disabling: No description available. ,
DisableFailed: No description available. ,
Disabled: No description available. ,
Scaling: No description available. ,
ScalingFailed: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
clusteringPolicy:
{
Description: Clustering policy - default is OSSCluster. This property must be chosen at create time, and cannot be changed without deleting the database. ,
Enum:
{
EnterpriseCluster: Enterprise clustering policy uses only the classic redis protocol, which does not support redis cluster commands. ,
OSSCluster: OSS clustering policy follows the redis cluster specification, and requires all clients to support redis clustering. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Redis eviction policy - default is VolatileLRU ,
Enum:
{
AllKeysLFU: No description available. ,
AllKeysLRU: No description available. ,
AllKeysRandom: No description available. ,
VolatileLRU: No description available. ,
VolatileLFU: No description available. ,
VolatileTTL: No description available. ,
VolatileRandom: No description available. ,
NoEviction: No description available. ,
}
,
Required: False ,
}
enum ,
persistence:
{
Description: Persistence settings ,
Required: False ,
}
{
aofEnabled:
{
Description: Sets whether AOF is enabled. Note that at most one of AOF or RDB persistence may be enabled. ,
Required: False ,
}
boolean ,
rdbEnabled:
{
Description: Sets whether RDB is enabled. Note that at most one of AOF or RDB persistence may be enabled. ,
Required: False ,
}
boolean ,
aofFrequency:
{
Description: Sets the frequency at which data is written to disk. Defaults to '1s', meaning 'every second'. Note that the 'always' setting is deprecated, because of its performance impact. ,
Enum:
{
1s: No description available. ,
always: No description available. ,
}
,
Required: False ,
}
enum ,
rdbFrequency:
{
Description: Sets the frequency at which a snapshot of the database is created. ,
Enum:
{
1h: No description available. ,
6h: No description available. ,
12h: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
modules:
{
Description: Optional set of redis modules to enable in this database - modules can only be added at creation time. ,
Required: False ,
}
[
{
name:
{
Description: The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries' ,
Required: True ,
}
string ,
args:
{
Description: Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'. ,
Required: False ,
}
string ,
version:
{
Description: The version of the module, e.g. '1.0'. ,
Required: False ,
}
string ,
}
,
]
,
geoReplication:
{
Description: Optional set of properties to configure geo replication for this database. ,
Required: False ,
}
{
groupNickname:
{
Description: Name for the group of linked database resources ,
Required: False ,
}
string ,
linkedDatabases:
{
Description: List of database resources to link with this database ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a database resource to link with this database. ,
Format: arm-id ,
Required: False ,
}
string ,
state:
{
Description: State of the link between the database resources. ,
Enum:
{
Linked: No description available. ,
Linking: No description available. ,
Unlinking: No description available. ,
LinkFailed: No description available. ,
UnlinkFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
redisVersion:
{
Description: Version of Redis the database is running on, e.g. '6.0' ,
Required: False ,
}
string ,
deferUpgrade:
{
Description: Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade ,
Enum:
{
Deferred: No description available. ,
NotDeferred: No description available. ,
}
,
Required: False ,
}
enum ,
accessKeysAuthentication:
{
Description: This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation URI to poll for result ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Databases_Get (new)
Description :  Gets information about a database in a Redis Enterprise cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the Redis Enterprise database. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Other properties of the database. ,
Required: False ,
}
{
clientProtocol:
{
Description: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. ,
Enum:
{
Encrypted: No description available. ,
Plaintext: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: TCP port of the database endpoint. Specified at create time. Defaults to an available port. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Current provisioning status of the database ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Current resource status of the database ,
Enum:
{
Running: No description available. ,
Creating: No description available. ,
CreateFailed: No description available. ,
Updating: No description available. ,
UpdateFailed: No description available. ,
Deleting: No description available. ,
DeleteFailed: No description available. ,
Enabling: No description available. ,
EnableFailed: No description available. ,
Disabling: No description available. ,
DisableFailed: No description available. ,
Disabled: No description available. ,
Scaling: No description available. ,
ScalingFailed: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
clusteringPolicy:
{
Description: Clustering policy - default is OSSCluster. This property must be chosen at create time, and cannot be changed without deleting the database. ,
Enum:
{
EnterpriseCluster: Enterprise clustering policy uses only the classic redis protocol, which does not support redis cluster commands. ,
OSSCluster: OSS clustering policy follows the redis cluster specification, and requires all clients to support redis clustering. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Redis eviction policy - default is VolatileLRU ,
Enum:
{
AllKeysLFU: No description available. ,
AllKeysLRU: No description available. ,
AllKeysRandom: No description available. ,
VolatileLRU: No description available. ,
VolatileLFU: No description available. ,
VolatileTTL: No description available. ,
VolatileRandom: No description available. ,
NoEviction: No description available. ,
}
,
Required: False ,
}
enum ,
persistence:
{
Description: Persistence settings ,
Required: False ,
}
{
aofEnabled:
{
Description: Sets whether AOF is enabled. Note that at most one of AOF or RDB persistence may be enabled. ,
Required: False ,
}
boolean ,
rdbEnabled:
{
Description: Sets whether RDB is enabled. Note that at most one of AOF or RDB persistence may be enabled. ,
Required: False ,
}
boolean ,
aofFrequency:
{
Description: Sets the frequency at which data is written to disk. Defaults to '1s', meaning 'every second'. Note that the 'always' setting is deprecated, because of its performance impact. ,
Enum:
{
1s: No description available. ,
always: No description available. ,
}
,
Required: False ,
}
enum ,
rdbFrequency:
{
Description: Sets the frequency at which a snapshot of the database is created. ,
Enum:
{
1h: No description available. ,
6h: No description available. ,
12h: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
modules:
{
Description: Optional set of redis modules to enable in this database - modules can only be added at creation time. ,
Required: False ,
}
[
{
name:
{
Description: The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries' ,
Required: True ,
}
string ,
args:
{
Description: Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'. ,
Required: False ,
}
string ,
version:
{
Description: The version of the module, e.g. '1.0'. ,
Required: False ,
}
string ,
}
,
]
,
geoReplication:
{
Description: Optional set of properties to configure geo replication for this database. ,
Required: False ,
}
{
groupNickname:
{
Description: Name for the group of linked database resources ,
Required: False ,
}
string ,
linkedDatabases:
{
Description: List of database resources to link with this database ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a database resource to link with this database. ,
Format: arm-id ,
Required: False ,
}
string ,
state:
{
Description: State of the link between the database resources. ,
Enum:
{
Linked: No description available. ,
Linking: No description available. ,
Unlinking: No description available. ,
LinkFailed: No description available. ,
UnlinkFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
redisVersion:
{
Description: Version of Redis the database is running on, e.g. '6.0' ,
Required: False ,
}
string ,
deferUpgrade:
{
Description: Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade ,
Enum:
{
Deferred: No description available. ,
NotDeferred: No description available. ,
}
,
Required: False ,
}
enum ,
accessKeysAuthentication:
{
Description: This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Databases_Delete (new)
Description :  Deletes a single database
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the Redis Enterprise database. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation URI to poll for result ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Databases_ListKeys (new)
Description :  Retrieves the access keys for the Redis Enterprise database.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/listKeys
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the Redis Enterprise database. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryKey:
{
Description: The current primary key that clients can use to authenticate ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The current secondary key that clients can use to authenticate ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Databases_RegenerateKey (new)
Description :  Regenerates the Redis Enterprise database's access keys.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/regenerateKey
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the Redis Enterprise database. ,
Required: True ,
}
string ,
parameters:
{
Description: Specifies which key to regenerate. ,
Required: True ,
}
{
keyType:
{
Description: Which access key to regenerate. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryKey:
{
Description: The current primary key that clients can use to authenticate ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The current secondary key that clients can use to authenticate ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation URI to poll for result ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Databases_Import (new)
Description :  Imports database files to target database.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/import
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the Redis Enterprise database. ,
Required: True ,
}
string ,
parameters:
{
Description: Storage information for importing into the cluster ,
Required: True ,
}
{
sasUris:
{
Description: SAS URIs for the target blobs to import from ,
Required: True ,
}
[
string ,
]
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation URI to poll for result ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Databases_Export (new)
Description :  Exports a database file from target database.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/export
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the Redis Enterprise database. ,
Required: True ,
}
string ,
parameters:
{
Description: Storage information for exporting into the cluster ,
Required: True ,
}
{
sasUri:
{
Description: SAS URI for the target directory to export to ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation URI to poll for result ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AccessPolicyAssignment_CreateUpdate (new)
Description :  Creates/Updates a particular access policy assignment for a database
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/accessPolicyAssignments/{accessPolicyAssignmentName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the Redis Enterprise database. ,
Required: True ,
}
string ,
accessPolicyAssignmentName:
{
Description: The name of the Redis Enterprise database access policy assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create access policy assignment for database. ,
Required: True ,
}
{
properties:
{
Description: Properties of the access policy assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: Current provisioning status of the access policy assignment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
accessPolicyName:
{
Description: Name of access policy under specific access policy assignment. Only "default" policy is supported for now. ,
Required: True ,
}
string ,
user:
{
Description: The user associated with the access policy. ,
Required: True ,
}
{
objectId:
{
Description: The object ID of the user. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the access policy assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: Current provisioning status of the access policy assignment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
accessPolicyName:
{
Description: Name of access policy under specific access policy assignment. Only "default" policy is supported for now. ,
Required: True ,
}
string ,
user:
{
Description: The user associated with the access policy. ,
Required: True ,
}
{
objectId:
{
Description: The object ID of the user. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the access policy assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: Current provisioning status of the access policy assignment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
accessPolicyName:
{
Description: Name of access policy under specific access policy assignment. Only "default" policy is supported for now. ,
Required: True ,
}
string ,
user:
{
Description: The user associated with the access policy. ,
Required: True ,
}
{
objectId:
{
Description: The object ID of the user. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AccessPolicyAssignment_Get (new)
Description :  Gets information about access policy assignment for database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/accessPolicyAssignments/{accessPolicyAssignmentName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the Redis Enterprise database. ,
Required: True ,
}
string ,
accessPolicyAssignmentName:
{
Description: The name of the Redis Enterprise database access policy assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the access policy assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: Current provisioning status of the access policy assignment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
accessPolicyName:
{
Description: Name of access policy under specific access policy assignment. Only "default" policy is supported for now. ,
Required: True ,
}
string ,
user:
{
Description: The user associated with the access policy. ,
Required: True ,
}
{
objectId:
{
Description: The object ID of the user. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AccessPolicyAssignment_Delete (new)
Description :  Deletes a single access policy assignment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/accessPolicyAssignments/{accessPolicyAssignmentName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the Redis Enterprise database. ,
Required: True ,
}
string ,
accessPolicyAssignmentName:
{
Description: The name of the Redis Enterprise database access policy assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation URI to poll for result ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AccessPolicyAssignment_List (new)
Description :  Gets all access policy assignments..
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/accessPolicyAssignments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the Redis Enterprise database. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of access policy assignments. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the access policy assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: Current provisioning status of the access policy assignment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
accessPolicyName:
{
Description: Name of access policy under specific access policy assignment. Only "default" policy is supported for now. ,
Required: True ,
}
string ,
user:
{
Description: The user associated with the access policy. ,
Required: True ,
}
{
objectId:
{
Description: The object ID of the user. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_List (new)
Description :  Lists all the private endpoint connections associated with the Redis Enterprise cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (new)
Description :  Gets the specified private endpoint connection associated with the Redis Enterprise cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Put (new)
Description :  Updates the state of the specified private endpoint connection associated with the Redis Enterprise cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (new)
Description :  Deletes the specified private endpoint connection associated with the Redis Enterprise cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
azure-asyncoperation:
{
Description: URI to poll for the operation status ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_ListByCluster (new)
Description :  Gets the private link resources that need to be created for a Redis Enterprise cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateLinkResources
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Databases_ForceLinkToReplicationGroup (new)
Description :  Forcibly recreates an existing database on the specified cluster, and rejoins it to an existing replication group. **IMPORTANT NOTE:** All data in this database will be discarded, and the database will temporarily be unavailable while rejoining the replication group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/forceLinkToReplicationGroup
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the Redis Enterprise database. ,
Required: True ,
}
string ,
parameters:
{
Description: Information identifying the database to be unlinked. ,
Required: True ,
}
{
geoReplication:
{
Description: Properties to configure geo replication for this database. ,
Required: True ,
}
{
groupNickname:
{
Description: The name of the group of linked database resources. This should match the existing replication group name. ,
Required: False ,
}
string ,
linkedDatabases:
{
Description: The resource IDs of the databases that are expected to be linked and included in the replication group. This parameter is used to validate that the linking is to the expected (unlinked) part of the replication group, if it is splintered. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a database resource to link with this database. ,
Format: arm-id ,
Required: False ,
}
string ,
state:
{
Description: State of the link between the database resources. ,
Enum:
{
Linked: No description available. ,
Linking: No description available. ,
Unlinking: No description available. ,
LinkFailed: No description available. ,
UnlinkFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
azure-asyncoperation:
{
Description: Azure-AsyncOperation URI to poll for result ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Databases_Flush (new)
Description :  Flushes all the keys in this database and also from its linked databases.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/flush
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the Redis Enterprise database. ,
Required: True ,
}
string ,
parameters:
{
Description: Information identifying the databases to be flushed ,
Required: True ,
}
{
ids:
{
Description: The identifiers of all the other database resources in the georeplication group to be flushed. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
azure-asyncoperation:
{
Description: URI to poll for the operation status ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Databases_UpgradeDBRedisVersion (new)
Description :  Upgrades the database Redis version to the latest available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/upgradeDBRedisVersion
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: 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 ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the Redis Enterprise database. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
azure-asyncoperation:
{
Description: URI to poll for the operation status ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}