cache.azure.com/v1api20250401
APIVersion
| Value | Description |
|---|---|
| “2025-04-01” |
RedisEnterprise
Generator information: - Generated from: /redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/redisenterprise.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}
Used by: RedisEnterpriseList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | RedisEnterprise_Spec Optional |
|
| status | RedisEnterprise_STATUS Optional |
RedisEnterprise_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| encryption | Encryption-at-rest configuration for the cluster. | ClusterProperties_Encryption Optional |
| highAvailability | 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. | ClusterProperties_HighAvailability Optional |
| identity | The identity of the resource. | ManagedServiceIdentity Optional |
| kind | Distinguishes the kind of cluster. Read-only. | Kind Optional |
| location | The geo-location where the resource lives | string Required |
| minimumTlsVersion | 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. |
ClusterProperties_MinimumTlsVersion Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | RedisEnterpriseOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| sku | The SKU to create, which affects price, performance, and features. | Sku Required |
| tags | Resource tags. | map[string]string Optional |
| zones | The Availability Zones where this cluster will be deployed. | string[] Optional |
RedisEnterprise_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| encryption | Encryption-at-rest configuration for the cluster. | ClusterProperties_Encryption_STATUS Optional |
| highAvailability | 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. | ClusterProperties_HighAvailability_STATUS Optional |
| hostName | DNS name of the cluster endpoint | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| identity | The identity of the resource. | ManagedServiceIdentity_STATUS Optional |
| kind | Distinguishes the kind of cluster. Read-only. | Kind_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| minimumTlsVersion | 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. |
ClusterProperties_MinimumTlsVersion_STATUS Optional |
| name | The name of the resource | string Optional |
| privateEndpointConnections | List of private endpoint connections associated with the specified Redis Enterprise cluster | PrivateEndpointConnection_STATUS[] Optional |
| provisioningState | Current provisioning status of the cluster | ProvisioningState_STATUS Optional |
| redisVersion | Version of redis the cluster supports, e.g. 6 |
string Optional |
| redundancyMode | Explains the current redundancy strategy of the cluster, which affects the expected SLA. | ClusterProperties_RedundancyMode_STATUS Optional |
| resourceState | Current resource status of the cluster | ResourceState_STATUS Optional |
| sku | The SKU to create, which affects price, performance, and features. | Sku_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| zones | The Availability Zones where this cluster will be deployed. | string[] Optional |
RedisEnterpriseDatabase
Generator information: - Generated from: /redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/redisenterprise.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}
Used by: RedisEnterpriseDatabaseList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | RedisEnterpriseDatabase_Spec Optional |
|
| status | RedisEnterpriseDatabase_STATUS Optional |
RedisEnterpriseDatabase_Spec
| Property | Description | Type |
|---|---|---|
| accessKeysAuthentication | This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created. | DatabaseProperties_AccessKeysAuthentication Optional |
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| clientProtocol | Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. | DatabaseProperties_ClientProtocol Optional |
| clusteringPolicy | Clustering policy - default is OSSCluster. This property must be chosen at create time, and cannot be changed without deleting the database. | DatabaseProperties_ClusteringPolicy Optional |
| deferUpgrade | Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade | DatabaseProperties_DeferUpgrade Optional |
| evictionPolicy | Redis eviction policy - default is VolatileLRU | DatabaseProperties_EvictionPolicy Optional |
| geoReplication | Optional set of properties to configure geo replication for this database. | DatabaseProperties_GeoReplication Optional |
| modules | Optional set of redis modules to enable in this database - modules can only be added at creation time. | Module[] Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | RedisEnterpriseDatabaseOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a cache.azure.com/RedisEnterprise resource | genruntime.KnownResourceReference Required |
| persistence | Persistence settings | Persistence Optional |
| port | TCP port of the database endpoint. Specified at create time. Defaults to an available port. | int Optional |
RedisEnterpriseDatabase_STATUS
| Property | Description | Type |
|---|---|---|
| accessKeysAuthentication | This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created. | DatabaseProperties_AccessKeysAuthentication_STATUS Optional |
| clientProtocol | Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. | DatabaseProperties_ClientProtocol_STATUS Optional |
| clusteringPolicy | Clustering policy - default is OSSCluster. This property must be chosen at create time, and cannot be changed without deleting the database. | DatabaseProperties_ClusteringPolicy_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| deferUpgrade | Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade | DatabaseProperties_DeferUpgrade_STATUS Optional |
| evictionPolicy | Redis eviction policy - default is VolatileLRU | DatabaseProperties_EvictionPolicy_STATUS Optional |
| geoReplication | Optional set of properties to configure geo replication for this database. | DatabaseProperties_GeoReplication_STATUS Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| modules | Optional set of redis modules to enable in this database - modules can only be added at creation time. | Module_STATUS[] Optional |
| name | The name of the resource | string Optional |
| persistence | Persistence settings | Persistence_STATUS Optional |
| port | TCP port of the database endpoint. Specified at create time. Defaults to an available port. | int Optional |
| provisioningState | Current provisioning status of the database | ProvisioningState_STATUS Optional |
| redisVersion | Version of Redis the database is running on, e.g. 6.0 |
string Optional |
| resourceState | Current resource status of the database | ResourceState_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
RedisEnterpriseDatabaseList
Generator information: - Generated from: /redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/redisenterprise.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | RedisEnterpriseDatabase[] Optional |
RedisEnterpriseList
Generator information: - Generated from: /redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/redisenterprise.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | RedisEnterprise[] Optional |
RedisEnterprise_Spec
Used by: RedisEnterprise.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| encryption | Encryption-at-rest configuration for the cluster. | ClusterProperties_Encryption Optional |
| highAvailability | 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. | ClusterProperties_HighAvailability Optional |
| identity | The identity of the resource. | ManagedServiceIdentity Optional |
| kind | Distinguishes the kind of cluster. Read-only. | Kind Optional |
| location | The geo-location where the resource lives | string Required |
| minimumTlsVersion | 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. |
ClusterProperties_MinimumTlsVersion Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | RedisEnterpriseOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| sku | The SKU to create, which affects price, performance, and features. | Sku Required |
| tags | Resource tags. | map[string]string Optional |
| zones | The Availability Zones where this cluster will be deployed. | string[] Optional |
RedisEnterprise_STATUS
Used by: RedisEnterprise.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| encryption | Encryption-at-rest configuration for the cluster. | ClusterProperties_Encryption_STATUS Optional |
| highAvailability | 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. | ClusterProperties_HighAvailability_STATUS Optional |
| hostName | DNS name of the cluster endpoint | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| identity | The identity of the resource. | ManagedServiceIdentity_STATUS Optional |
| kind | Distinguishes the kind of cluster. Read-only. | Kind_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| minimumTlsVersion | 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. |
ClusterProperties_MinimumTlsVersion_STATUS Optional |
| name | The name of the resource | string Optional |
| privateEndpointConnections | List of private endpoint connections associated with the specified Redis Enterprise cluster | PrivateEndpointConnection_STATUS[] Optional |
| provisioningState | Current provisioning status of the cluster | ProvisioningState_STATUS Optional |
| redisVersion | Version of redis the cluster supports, e.g. 6 |
string Optional |
| redundancyMode | Explains the current redundancy strategy of the cluster, which affects the expected SLA. | ClusterProperties_RedundancyMode_STATUS Optional |
| resourceState | Current resource status of the cluster | ResourceState_STATUS Optional |
| sku | The SKU to create, which affects price, performance, and features. | Sku_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| zones | The Availability Zones where this cluster will be deployed. | string[] Optional |
RedisEnterpriseDatabase_Spec
Used by: RedisEnterpriseDatabase.
| Property | Description | Type |
|---|---|---|
| accessKeysAuthentication | This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created. | DatabaseProperties_AccessKeysAuthentication Optional |
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| clientProtocol | Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. | DatabaseProperties_ClientProtocol Optional |
| clusteringPolicy | Clustering policy - default is OSSCluster. This property must be chosen at create time, and cannot be changed without deleting the database. | DatabaseProperties_ClusteringPolicy Optional |
| deferUpgrade | Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade | DatabaseProperties_DeferUpgrade Optional |
| evictionPolicy | Redis eviction policy - default is VolatileLRU | DatabaseProperties_EvictionPolicy Optional |
| geoReplication | Optional set of properties to configure geo replication for this database. | DatabaseProperties_GeoReplication Optional |
| modules | Optional set of redis modules to enable in this database - modules can only be added at creation time. | Module[] Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | RedisEnterpriseDatabaseOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a cache.azure.com/RedisEnterprise resource | genruntime.KnownResourceReference Required |
| persistence | Persistence settings | Persistence Optional |
| port | TCP port of the database endpoint. Specified at create time. Defaults to an available port. | int Optional |
RedisEnterpriseDatabase_STATUS
Used by: RedisEnterpriseDatabase.
| Property | Description | Type |
|---|---|---|
| accessKeysAuthentication | This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created. | DatabaseProperties_AccessKeysAuthentication_STATUS Optional |
| clientProtocol | Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. | DatabaseProperties_ClientProtocol_STATUS Optional |
| clusteringPolicy | Clustering policy - default is OSSCluster. This property must be chosen at create time, and cannot be changed without deleting the database. | DatabaseProperties_ClusteringPolicy_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| deferUpgrade | Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade | DatabaseProperties_DeferUpgrade_STATUS Optional |
| evictionPolicy | Redis eviction policy - default is VolatileLRU | DatabaseProperties_EvictionPolicy_STATUS Optional |
| geoReplication | Optional set of properties to configure geo replication for this database. | DatabaseProperties_GeoReplication_STATUS Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| modules | Optional set of redis modules to enable in this database - modules can only be added at creation time. | Module_STATUS[] Optional |
| name | The name of the resource | string Optional |
| persistence | Persistence settings | Persistence_STATUS Optional |
| port | TCP port of the database endpoint. Specified at create time. Defaults to an available port. | int Optional |
| provisioningState | Current provisioning status of the database | ProvisioningState_STATUS Optional |
| redisVersion | Version of Redis the database is running on, e.g. 6.0 |
string Optional |
| resourceState | Current resource status of the database | ResourceState_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
ClusterProperties_Encryption
Used by: RedisEnterprise_Spec.
| Property | Description | Type |
|---|---|---|
| customerManagedKeyEncryption | All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption. | ClusterProperties_Encryption_CustomerManagedKeyEncryption Optional |
ClusterProperties_Encryption_STATUS
Used by: RedisEnterprise_STATUS.
| Property | Description | Type |
|---|---|---|
| customerManagedKeyEncryption | All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption. | ClusterProperties_Encryption_CustomerManagedKeyEncryption_STATUS Optional |
ClusterProperties_HighAvailability
Used by: RedisEnterprise_Spec.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
ClusterProperties_HighAvailability_STATUS
Used by: RedisEnterprise_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
ClusterProperties_MinimumTlsVersion
Used by: RedisEnterprise_Spec.
| Value | Description |
|---|---|
| “1.0” | |
| “1.1” | |
| “1.2” |
ClusterProperties_MinimumTlsVersion_STATUS
Used by: RedisEnterprise_STATUS.
| Value | Description |
|---|---|
| “1.0” | |
| “1.1” | |
| “1.2” |
ClusterProperties_RedundancyMode_STATUS
Used by: RedisEnterprise_STATUS.
| Value | Description |
|---|---|
| “LR” | |
| “None” | |
| “ZR” |
DatabaseProperties_AccessKeysAuthentication
Used by: RedisEnterpriseDatabase_Spec.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
DatabaseProperties_AccessKeysAuthentication_STATUS
Used by: RedisEnterpriseDatabase_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
DatabaseProperties_ClientProtocol
Used by: RedisEnterpriseDatabase_Spec.
| Value | Description |
|---|---|
| “Encrypted” | |
| “Plaintext” |
DatabaseProperties_ClientProtocol_STATUS
Used by: RedisEnterpriseDatabase_STATUS.
| Value | Description |
|---|---|
| “Encrypted” | |
| “Plaintext” |
DatabaseProperties_ClusteringPolicy
Used by: RedisEnterpriseDatabase_Spec.
| Value | Description |
|---|---|
| “EnterpriseCluster” | |
| “OSSCluster” |
DatabaseProperties_ClusteringPolicy_STATUS
Used by: RedisEnterpriseDatabase_STATUS.
| Value | Description |
|---|---|
| “EnterpriseCluster” | |
| “OSSCluster” |
DatabaseProperties_DeferUpgrade
Used by: RedisEnterpriseDatabase_Spec.
| Value | Description |
|---|---|
| “Deferred” | |
| “NotDeferred” |
DatabaseProperties_DeferUpgrade_STATUS
Used by: RedisEnterpriseDatabase_STATUS.
| Value | Description |
|---|---|
| “Deferred” | |
| “NotDeferred” |
DatabaseProperties_EvictionPolicy
Used by: RedisEnterpriseDatabase_Spec.
| Value | Description |
|---|---|
| “AllKeysLFU” | |
| “AllKeysLRU” | |
| “AllKeysRandom” | |
| “NoEviction” | |
| “VolatileLFU” | |
| “VolatileLRU” | |
| “VolatileRandom” | |
| “VolatileTTL” |
DatabaseProperties_EvictionPolicy_STATUS
Used by: RedisEnterpriseDatabase_STATUS.
| Value | Description |
|---|---|
| “AllKeysLFU” | |
| “AllKeysLRU” | |
| “AllKeysRandom” | |
| “NoEviction” | |
| “VolatileLFU” | |
| “VolatileLRU” | |
| “VolatileRandom” | |
| “VolatileTTL” |
DatabaseProperties_GeoReplication
Used by: RedisEnterpriseDatabase_Spec.
| Property | Description | Type |
|---|---|---|
| groupNickname | Name for the group of linked database resources | string Optional |
| linkedDatabases | List of database resources to link with this database | LinkedDatabase[] Optional |
DatabaseProperties_GeoReplication_STATUS
Used by: RedisEnterpriseDatabase_STATUS.
| Property | Description | Type |
|---|---|---|
| groupNickname | Name for the group of linked database resources | string Optional |
| linkedDatabases | List of database resources to link with this database | LinkedDatabase_STATUS[] Optional |
Kind
Distinguishes the kind of cluster. Read-only.
Used by: RedisEnterprise_Spec.
| Value | Description |
|---|---|
| “v1” | |
| “v2” |
Kind_STATUS
Distinguishes the kind of cluster. Read-only.
Used by: RedisEnterprise_STATUS.
| Value | Description |
|---|---|
| “v1” | |
| “v2” |
ManagedServiceIdentity
Managed service identity (system assigned and/or user assigned identities)
Used by: RedisEnterprise_Spec.
| Property | Description | Type |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | ManagedServiceIdentityType Required |
| userAssignedIdentities | UserAssignedIdentityDetails[] Optional |
ManagedServiceIdentity_STATUS
Managed service identity (system assigned and/or user assigned identities)
Used by: RedisEnterprise_STATUS.
| Property | Description | Type |
|---|---|---|
| principalId | The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. | string Optional |
| tenantId | The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. | string Optional |
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | ManagedServiceIdentityType_STATUS Optional |
| userAssignedIdentities | map[string]UserAssignedIdentity_STATUS Optional |
Module
Specifies configuration of a redis module
Used by: RedisEnterpriseDatabase_Spec.
| Property | Description | Type |
|---|---|---|
| args | Configuration options for the module, e.g. ‘ERROR_RATE 0.01 INITIAL_SIZE 400’. | string Optional |
| name | The name of the module, e.g. RedisBloom, RediSearch, RedisTimeSeries |
string Required |
Module_STATUS
Specifies configuration of a redis module
Used by: RedisEnterpriseDatabase_STATUS.
| Property | Description | Type |
|---|---|---|
| args | Configuration options for the module, e.g. ‘ERROR_RATE 0.01 INITIAL_SIZE 400’. | string Optional |
| name | The name of the module, e.g. RedisBloom, RediSearch, RedisTimeSeries |
string Optional |
| version | The version of the module, e.g. 1.0. |
string Optional |
Persistence
Persistence-related configuration for the Redis Enterprise database
Used by: RedisEnterpriseDatabase_Spec.
| Property | Description | Type |
|---|---|---|
| aofEnabled | Sets whether AOF is enabled. Note that at most one of AOF or RDB persistence may be enabled. | bool Optional |
| aofFrequency | 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. |
Persistence_AofFrequency Optional |
| rdbEnabled | Sets whether RDB is enabled. Note that at most one of AOF or RDB persistence may be enabled. | bool Optional |
| rdbFrequency | Sets the frequency at which a snapshot of the database is created. | Persistence_RdbFrequency Optional |
Persistence_STATUS
Persistence-related configuration for the Redis Enterprise database
Used by: RedisEnterpriseDatabase_STATUS.
| Property | Description | Type |
|---|---|---|
| aofEnabled | Sets whether AOF is enabled. Note that at most one of AOF or RDB persistence may be enabled. | bool Optional |
| aofFrequency | 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. |
Persistence_AofFrequency_STATUS Optional |
| rdbEnabled | Sets whether RDB is enabled. Note that at most one of AOF or RDB persistence may be enabled. | bool Optional |
| rdbFrequency | Sets the frequency at which a snapshot of the database is created. | Persistence_RdbFrequency_STATUS Optional |
PrivateEndpointConnection_STATUS
The Private Endpoint Connection resource.
Used by: RedisEnterprise_STATUS.
| Property | Description | Type |
|---|---|---|
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
ProvisioningState_STATUS
Current provisioning status
Used by: RedisEnterprise_STATUS, and RedisEnterpriseDatabase_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Succeeded” | |
| “Updating” |
RedisEnterpriseDatabaseOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: RedisEnterpriseDatabase_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
RedisEnterpriseOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: RedisEnterprise_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
ResourceState_STATUS
Current resource status
Used by: RedisEnterprise_STATUS, and RedisEnterpriseDatabase_STATUS.
| Value | Description |
|---|---|
| “CreateFailed” | |
| “Creating” | |
| “DeleteFailed” | |
| “Deleting” | |
| “DisableFailed” | |
| “Disabled” | |
| “Disabling” | |
| “EnableFailed” | |
| “Enabling” | |
| “Moving” | |
| “Running” | |
| “Scaling” | |
| “ScalingFailed” | |
| “UpdateFailed” | |
| “Updating” |
Sku
SKU parameters supplied to the create Redis Enterprise cluster operation.
Used by: RedisEnterprise_Spec.
| Property | Description | Type |
|---|---|---|
| capacity | 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. | int Optional |
| name | 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. |
Sku_Name Required |
Sku_STATUS
SKU parameters supplied to the create Redis Enterprise cluster operation.
Used by: RedisEnterprise_STATUS.
| Property | Description | Type |
|---|---|---|
| capacity | 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. | int Optional |
| name | 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. |
Sku_Name_STATUS Optional |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: RedisEnterpriseDatabase_STATUS.
| Property | Description | Type |
|---|---|---|
| createdAt | The timestamp of resource creation (UTC). | string Optional |
| createdBy | The identity that created the resource. | string Optional |
| createdByType | The type of identity that created the resource. | SystemData_CreatedByType_STATUS Optional |
| lastModifiedAt | The timestamp of resource last modification (UTC) | string Optional |
| lastModifiedBy | The identity that last modified the resource. | string Optional |
| lastModifiedByType | The type of identity that last modified the resource. | SystemData_LastModifiedByType_STATUS Optional |
ClusterProperties_Encryption_CustomerManagedKeyEncryption
Used by: ClusterProperties_Encryption.
| Property | Description | Type |
|---|---|---|
| keyEncryptionKeyIdentity | All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. | ClusterProperties_Encryption_CustomerManagedKeyEncryption_KeyEncryptionKeyIdentity Optional |
| keyEncryptionKeyUrl | Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 | string Optional |
ClusterProperties_Encryption_CustomerManagedKeyEncryption_STATUS
Used by: ClusterProperties_Encryption_STATUS.
| Property | Description | Type |
|---|---|---|
| keyEncryptionKeyIdentity | All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. | ClusterProperties_Encryption_CustomerManagedKeyEncryption_KeyEncryptionKeyIdentity_STATUS Optional |
| keyEncryptionKeyUrl | Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 | string Optional |
LinkedDatabase
Specifies details of a linked database resource.
Used by: DatabaseProperties_GeoReplication.
| Property | Description | Type |
|---|---|---|
| reference | Resource ID of a database resource to link with this database. | genruntime.ResourceReference Optional |
LinkedDatabase_STATUS
Specifies details of a linked database resource.
Used by: DatabaseProperties_GeoReplication_STATUS.
| Property | Description | Type |
|---|---|---|
| id | Resource ID of a database resource to link with this database. | string Optional |
| state | State of the link between the database resources. | LinkedDatabase_State_STATUS Optional |
ManagedServiceIdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Used by: ManagedServiceIdentity.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned, UserAssigned” | |
| “UserAssigned” |
ManagedServiceIdentityType_STATUS
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Used by: ManagedServiceIdentity_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned, UserAssigned” | |
| “UserAssigned” |
Persistence_AofFrequency
Used by: Persistence.
| Value | Description |
|---|---|
| “1s” | |
| “always” |
Persistence_AofFrequency_STATUS
Used by: Persistence_STATUS.
| Value | Description |
|---|---|
| “1s” | |
| “always” |
Persistence_RdbFrequency
Used by: Persistence.
| Value | Description |
|---|---|
| “12h” | |
| “1h” | |
| “6h” |
Persistence_RdbFrequency_STATUS
Used by: Persistence_STATUS.
| Value | Description |
|---|---|
| “12h” | |
| “1h” | |
| “6h” |
Sku_Name
Used by: Sku.
| Value | Description |
|---|---|
| “Balanced_B0” | |
| “Balanced_B1” | |
| “Balanced_B10” | |
| “Balanced_B100” | |
| “Balanced_B1000” | |
| “Balanced_B150” | |
| “Balanced_B20” | |
| “Balanced_B250” | |
| “Balanced_B3” | |
| “Balanced_B350” | |
| “Balanced_B5” | |
| “Balanced_B50” | |
| “Balanced_B500” | |
| “Balanced_B700” | |
| “ComputeOptimized_X10” | |
| “ComputeOptimized_X100” | |
| “ComputeOptimized_X150” | |
| “ComputeOptimized_X20” | |
| “ComputeOptimized_X250” | |
| “ComputeOptimized_X3” | |
| “ComputeOptimized_X350” | |
| “ComputeOptimized_X5” | |
| “ComputeOptimized_X50” | |
| “ComputeOptimized_X500” | |
| “ComputeOptimized_X700” | |
| “EnterpriseFlash_F1500” | |
| “EnterpriseFlash_F300” | |
| “EnterpriseFlash_F700” | |
| “Enterprise_E1” | |
| “Enterprise_E10” | |
| “Enterprise_E100” | |
| “Enterprise_E20” | |
| “Enterprise_E200” | |
| “Enterprise_E400” | |
| “Enterprise_E5” | |
| “Enterprise_E50” | |
| “FlashOptimized_A1000” | |
| “FlashOptimized_A1500” | |
| “FlashOptimized_A2000” | |
| “FlashOptimized_A250” | |
| “FlashOptimized_A4500” | |
| “FlashOptimized_A500” | |
| “FlashOptimized_A700” | |
| “MemoryOptimized_M10” | |
| “MemoryOptimized_M100” | |
| “MemoryOptimized_M1000” | |
| “MemoryOptimized_M150” | |
| “MemoryOptimized_M1500” | |
| “MemoryOptimized_M20” | |
| “MemoryOptimized_M2000” | |
| “MemoryOptimized_M250” | |
| “MemoryOptimized_M350” | |
| “MemoryOptimized_M50” | |
| “MemoryOptimized_M500” | |
| “MemoryOptimized_M700” |
Sku_Name_STATUS
Used by: Sku_STATUS.
| Value | Description |
|---|---|
| “Balanced_B0” | |
| “Balanced_B1” | |
| “Balanced_B10” | |
| “Balanced_B100” | |
| “Balanced_B1000” | |
| “Balanced_B150” | |
| “Balanced_B20” | |
| “Balanced_B250” | |
| “Balanced_B3” | |
| “Balanced_B350” | |
| “Balanced_B5” | |
| “Balanced_B50” | |
| “Balanced_B500” | |
| “Balanced_B700” | |
| “ComputeOptimized_X10” | |
| “ComputeOptimized_X100” | |
| “ComputeOptimized_X150” | |
| “ComputeOptimized_X20” | |
| “ComputeOptimized_X250” | |
| “ComputeOptimized_X3” | |
| “ComputeOptimized_X350” | |
| “ComputeOptimized_X5” | |
| “ComputeOptimized_X50” | |
| “ComputeOptimized_X500” | |
| “ComputeOptimized_X700” | |
| “EnterpriseFlash_F1500” | |
| “EnterpriseFlash_F300” | |
| “EnterpriseFlash_F700” | |
| “Enterprise_E1” | |
| “Enterprise_E10” | |
| “Enterprise_E100” | |
| “Enterprise_E20” | |
| “Enterprise_E200” | |
| “Enterprise_E400” | |
| “Enterprise_E5” | |
| “Enterprise_E50” | |
| “FlashOptimized_A1000” | |
| “FlashOptimized_A1500” | |
| “FlashOptimized_A2000” | |
| “FlashOptimized_A250” | |
| “FlashOptimized_A4500” | |
| “FlashOptimized_A500” | |
| “FlashOptimized_A700” | |
| “MemoryOptimized_M10” | |
| “MemoryOptimized_M100” | |
| “MemoryOptimized_M1000” | |
| “MemoryOptimized_M150” | |
| “MemoryOptimized_M1500” | |
| “MemoryOptimized_M20” | |
| “MemoryOptimized_M2000” | |
| “MemoryOptimized_M250” | |
| “MemoryOptimized_M350” | |
| “MemoryOptimized_M50” | |
| “MemoryOptimized_M500” | |
| “MemoryOptimized_M700” |
SystemData_CreatedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
UserAssignedIdentity_STATUS
User assigned identity properties
Used by: ManagedServiceIdentity_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | The client ID of the assigned identity. | string Optional |
| principalId | The principal ID of the assigned identity. | string Optional |
UserAssignedIdentityDetails
Information about the user assigned identity for the resource
Used by: ManagedServiceIdentity.
| Property | Description | Type |
|---|---|---|
| reference | genruntime.ResourceReference Optional |
ClusterProperties_Encryption_CustomerManagedKeyEncryption_KeyEncryptionKeyIdentity
Used by: ClusterProperties_Encryption_CustomerManagedKeyEncryption.
| Property | Description | Type |
|---|---|---|
| identityType | Only userAssignedIdentity is supported in this API version; other types may be supported in the future | ClusterProperties_Encryption_CustomerManagedKeyEncryption_KeyEncryptionKeyIdentity_IdentityType Optional |
| userAssignedIdentityResourceReference | User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups/ |
genruntime.ResourceReference Optional |
ClusterProperties_Encryption_CustomerManagedKeyEncryption_KeyEncryptionKeyIdentity_STATUS
Used by: ClusterProperties_Encryption_CustomerManagedKeyEncryption_STATUS.
| Property | Description | Type |
|---|---|---|
| identityType | Only userAssignedIdentity is supported in this API version; other types may be supported in the future | ClusterProperties_Encryption_CustomerManagedKeyEncryption_KeyEncryptionKeyIdentity_IdentityType_STATUS Optional |
| userAssignedIdentityResourceId | User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups/ |
string Optional |
LinkedDatabase_State_STATUS
Used by: LinkedDatabase_STATUS.
| Value | Description |
|---|---|
| “LinkFailed” | |
| “Linked” | |
| “Linking” | |
| “UnlinkFailed” | |
| “Unlinking” |
ClusterProperties_Encryption_CustomerManagedKeyEncryption_KeyEncryptionKeyIdentity_IdentityType
Used by: ClusterProperties_Encryption_CustomerManagedKeyEncryption_KeyEncryptionKeyIdentity.
| Value | Description |
|---|---|
| “systemAssignedIdentity” | |
| “userAssignedIdentity” |
ClusterProperties_Encryption_CustomerManagedKeyEncryption_KeyEncryptionKeyIdentity_IdentityType_STATUS
Used by: ClusterProperties_Encryption_CustomerManagedKeyEncryption_KeyEncryptionKeyIdentity_STATUS.
| Value | Description |
|---|---|
| “systemAssignedIdentity” | |
| “userAssignedIdentity” |