cache.azure.com/v1api20230701
APIVersion
| Value | Description |
|---|---|
| “2023-07-01” |
RedisEnterprise
Generator information: - Generated from: /redisenterprise/resource-manager/Microsoft.Cache/stable/2023-07-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 |
| location | The geo-location where the resource lives | string Required |
| minimumTlsVersion | The minimum TLS version for the cluster to support, e.g. ‘1.2’ | 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 |
| 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 |
| location | The geo-location where the resource lives | string Optional |
| minimumTlsVersion | The minimum TLS version for the cluster to support, e.g. ‘1.2’ | ClusterProperties_MinimumTlsVersion_STATUS Optional |
| name | The name of the resource | string Optional |
| privateEndpointConnections | List of private endpoint connections associated with the specified RedisEnterprise 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 |
| 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/2023-07-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 |
|---|---|---|
| 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. Specified at create time. | DatabaseProperties_ClusteringPolicy 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 |
|---|---|---|
| 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. Specified at create time. | DatabaseProperties_ClusteringPolicy_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] 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 |
| resourceState | Current resource status of the database | ResourceState_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/2023-07-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/2023-07-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 |
| location | The geo-location where the resource lives | string Required |
| minimumTlsVersion | The minimum TLS version for the cluster to support, e.g. ‘1.2’ | 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 |
| 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 |
| location | The geo-location where the resource lives | string Optional |
| minimumTlsVersion | The minimum TLS version for the cluster to support, e.g. ‘1.2’ | ClusterProperties_MinimumTlsVersion_STATUS Optional |
| name | The name of the resource | string Optional |
| privateEndpointConnections | List of private endpoint connections associated with the specified RedisEnterprise 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 |
| 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 |
|---|---|---|
| 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. Specified at create time. | DatabaseProperties_ClusteringPolicy 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 |
|---|---|---|
| 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. Specified at create time. | DatabaseProperties_ClusteringPolicy_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] 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 |
| resourceState | Current resource status of the database | ResourceState_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
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” |
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_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 |
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 RedisEnterprise database
Used by: RedisEnterpriseDatabase_Spec.
| Property | Description | Type |
|---|---|---|
| aofEnabled | Sets whether AOF is enabled. | bool Optional |
| aofFrequency | Sets the frequency at which data is written to disk. | Persistence_AofFrequency Optional |
| rdbEnabled | Sets whether RDB is 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 RedisEnterprise database
Used by: RedisEnterpriseDatabase_STATUS.
| Property | Description | Type |
|---|---|---|
| aofEnabled | Sets whether AOF is enabled. | bool Optional |
| aofFrequency | Sets the frequency at which data is written to disk. | Persistence_AofFrequency_STATUS Optional |
| rdbEnabled | Sets whether RDB is 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” | |
| “Running” | |
| “UpdateFailed” | |
| “Updating” |
Sku
SKU parameters supplied to the create RedisEnterprise operation.
Used by: RedisEnterprise_Spec.
| Property | Description | Type |
|---|---|---|
| capacity | The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, …) for Enterprise SKUs and (3, 9, 15, …) for Flash SKUs. | int Optional |
| name | The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.) | Sku_Name Required |
Sku_STATUS
SKU parameters supplied to the create RedisEnterprise operation.
Used by: RedisEnterprise_STATUS.
| Property | Description | Type |
|---|---|---|
| capacity | The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, …) for Enterprise SKUs and (3, 9, 15, …) for Flash SKUs. | int Optional |
| name | The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.) | Sku_Name_STATUS 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 |
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 |
|---|---|
| “EnterpriseFlash_F1500” | |
| “EnterpriseFlash_F300” | |
| “EnterpriseFlash_F700” | |
| “Enterprise_E10” | |
| “Enterprise_E100” | |
| “Enterprise_E20” | |
| “Enterprise_E50” |
Sku_Name_STATUS
Used by: Sku_STATUS.
| Value | Description |
|---|---|
| “EnterpriseFlash_F1500” | |
| “EnterpriseFlash_F300” | |
| “EnterpriseFlash_F700” | |
| “Enterprise_E10” | |
| “Enterprise_E100” | |
| “Enterprise_E20” | |
| “Enterprise_E50” |
LinkedDatabase_State_STATUS
Used by: LinkedDatabase_STATUS.
| Value | Description |
|---|---|
| “LinkFailed” | |
| “Linked” | |
| “Linking” | |
| “UnlinkFailed” | |
| “Unlinking” |