cache.azure.com/v1api20230701

Package v1api20230701 contains API Schema definitions for the cache v1api20230701 API group

Resource Types:

APIVersion (`string` alias)

Value	Description
"2023-07-01"

ClusterProperties_MinimumTlsVersion (`string` alias)

(Appears on:RedisEnterprise_Spec)

Value	Description
"1.0"
"1.1"
"1.2"

ClusterProperties_MinimumTlsVersion_STATUS (`string` alias)

(Appears on:RedisEnterprise_STATUS)

Value	Description
"1.0"
"1.1"
"1.2"

DatabaseProperties_ClientProtocol (`string` alias)

(Appears on:RedisEnterpriseDatabase_Spec)

Value	Description
"Encrypted"
"Plaintext"

DatabaseProperties_ClientProtocol_STATUS (`string` alias)

(Appears on:RedisEnterpriseDatabase_STATUS)

Value	Description
"Encrypted"
"Plaintext"

DatabaseProperties_ClusteringPolicy (`string` alias)

(Appears on:RedisEnterpriseDatabase_Spec)

Value	Description
"EnterpriseCluster"
"OSSCluster"

DatabaseProperties_ClusteringPolicy_STATUS (`string` alias)

(Appears on:RedisEnterpriseDatabase_STATUS)

Value	Description
"EnterpriseCluster"
"OSSCluster"

DatabaseProperties_EvictionPolicy (`string` alias)

(Appears on:RedisEnterpriseDatabase_Spec)

Value	Description
"AllKeysLFU"
"AllKeysLRU"
"AllKeysRandom"
"NoEviction"
"VolatileLFU"
"VolatileLRU"
"VolatileRandom"
"VolatileTTL"

DatabaseProperties_EvictionPolicy_STATUS (`string` alias)

(Appears on:RedisEnterpriseDatabase_STATUS)

Value	Description
"AllKeysLFU"
"AllKeysLRU"
"AllKeysRandom"
"NoEviction"
"VolatileLFU"
"VolatileLRU"
"VolatileRandom"
"VolatileTTL"

DatabaseProperties_GeoReplication

(Appears on:RedisEnterpriseDatabase_Spec)

Field	Description
`groupNickname` string	GroupNickname: Name for the group of linked database resources
`linkedDatabases` []LinkedDatabase	LinkedDatabases: List of database resources to link with this database

DatabaseProperties_GeoReplication_STATUS

(Appears on:RedisEnterpriseDatabase_STATUS)

Field	Description
`groupNickname` string	GroupNickname: Name for the group of linked database resources
`linkedDatabases` []LinkedDatabase_STATUS	LinkedDatabases: List of database resources to link with this database

LinkedDatabase

(Appears on:DatabaseProperties_GeoReplication)

Specifies details of a linked database resource.

Field	Description
`reference` genruntime.ResourceReference	Reference: Resource ID of a database resource to link with this database.

LinkedDatabase_STATUS

(Appears on:DatabaseProperties_GeoReplication_STATUS)

Specifies details of a linked database resource.

Field	Description
`id` string	Id: Resource ID of a database resource to link with this database.
`state` LinkedDatabase_State_STATUS	State: State of the link between the database resources.

LinkedDatabase_State_STATUS (`string` alias)

(Appears on:LinkedDatabase_STATUS)

Value	Description
"LinkFailed"
"Linked"
"Linking"
"UnlinkFailed"
"Unlinking"

Module

(Appears on:RedisEnterpriseDatabase_Spec)

Specifies configuration of a redis module

Field	Description
`args` string	Args: Configuration options for the module, e.g. ‘ERROR_RATE 0.01 INITIAL_SIZE 400’.
`name` string	Name: The name of the module, e.g. ‘RedisBloom’, ‘RediSearch’, ‘RedisTimeSeries’

Module_STATUS

(Appears on:RedisEnterpriseDatabase_STATUS)

Specifies configuration of a redis module

Field	Description
`args` string	Args: Configuration options for the module, e.g. ‘ERROR_RATE 0.01 INITIAL_SIZE 400’.
`name` string	Name: The name of the module, e.g. ‘RedisBloom’, ‘RediSearch’, ‘RedisTimeSeries’
`version` string	Version: The version of the module, e.g. ‘1.0’.

Persistence

(Appears on:RedisEnterpriseDatabase_Spec)

Persistence-related configuration for the RedisEnterprise database

Field	Description
`aofEnabled` bool	AofEnabled: Sets whether AOF is enabled.
`aofFrequency` Persistence_AofFrequency	AofFrequency: Sets the frequency at which data is written to disk.
`rdbEnabled` bool	RdbEnabled: Sets whether RDB is enabled.
`rdbFrequency` Persistence_RdbFrequency	RdbFrequency: Sets the frequency at which a snapshot of the database is created.

Persistence_AofFrequency (`string` alias)

(Appears on:Persistence)

Value	Description
"1s"
"always"

Persistence_AofFrequency_STATUS (`string` alias)

(Appears on:Persistence_STATUS)

Value	Description
"1s"
"always"

Persistence_RdbFrequency (`string` alias)

(Appears on:Persistence)

Value	Description
"12h"
"1h"
"6h"

Persistence_RdbFrequency_STATUS (`string` alias)

(Appears on:Persistence_STATUS)

Value	Description
"12h"
"1h"
"6h"

Persistence_STATUS

(Appears on:RedisEnterpriseDatabase_STATUS)

Persistence-related configuration for the RedisEnterprise database

Field	Description
`aofEnabled` bool	AofEnabled: Sets whether AOF is enabled.
`aofFrequency` Persistence_AofFrequency_STATUS	AofFrequency: Sets the frequency at which data is written to disk.
`rdbEnabled` bool	RdbEnabled: Sets whether RDB is enabled.
`rdbFrequency` Persistence_RdbFrequency_STATUS	RdbFrequency: Sets the frequency at which a snapshot of the database is created.

PrivateEndpointConnection_STATUS

(Appears on:RedisEnterprise_STATUS)

The Private Endpoint Connection resource.

Field	Description
`id` string	Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

ProvisioningState_STATUS (`string` alias)

(Appears on:RedisEnterpriseDatabase_STATUS, RedisEnterprise_STATUS)

Current provisioning status

Value	Description
"Canceled"
"Creating"
"Deleting"
"Failed"
"Succeeded"
"Updating"

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}

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
RedisEnterprise_Spec

`azureName` string	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.
`location` string	Location: The geo-location where the resource lives
`minimumTlsVersion` ClusterProperties_MinimumTlsVersion	MinimumTlsVersion: The minimum TLS version for the cluster to support, e.g. ‘1.2’
`operatorSpec` RedisEnterpriseOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	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
`sku` Sku	Sku: The SKU to create, which affects price, performance, and features.
`tags` map[string]string	Tags: Resource tags.
`zones` []string	Zones: The Availability Zones where this cluster will be deployed.

status
RedisEnterprise_STATUS

RedisEnterpriseDatabase

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
RedisEnterpriseDatabase_Spec

`azureName` string	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.
`clientProtocol` DatabaseProperties_ClientProtocol	ClientProtocol: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
`clusteringPolicy` DatabaseProperties_ClusteringPolicy	ClusteringPolicy: Clustering policy - default is OSSCluster. Specified at create time.
`evictionPolicy` DatabaseProperties_EvictionPolicy	EvictionPolicy: Redis eviction policy - default is VolatileLRU
`geoReplication` DatabaseProperties_GeoReplication	GeoReplication: Optional set of properties to configure geo replication for this database.
`modules` []Module	Modules: Optional set of redis modules to enable in this database - modules can only be added at creation time.
`operatorSpec` RedisEnterpriseDatabaseOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	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
`persistence` Persistence	Persistence: Persistence settings
`port` int	Port: TCP port of the database endpoint. Specified at create time. Defaults to an available port.

status
RedisEnterpriseDatabase_STATUS

RedisEnterpriseDatabaseOperatorSpec

(Appears on:RedisEnterpriseDatabase_Spec)

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Field	Description
`configMapExpressions` []genruntime/core.DestinationExpression	ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
`secretExpressions` []genruntime/core.DestinationExpression	SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

RedisEnterpriseDatabase_STATUS

(Appears on:RedisEnterpriseDatabase)

Field	Description
`clientProtocol` DatabaseProperties_ClientProtocol_STATUS	ClientProtocol: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
`clusteringPolicy` DatabaseProperties_ClusteringPolicy_STATUS	ClusteringPolicy: Clustering policy - default is OSSCluster. Specified at create time.
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`evictionPolicy` DatabaseProperties_EvictionPolicy_STATUS	EvictionPolicy: Redis eviction policy - default is VolatileLRU
`geoReplication` DatabaseProperties_GeoReplication_STATUS	GeoReplication: Optional set of properties to configure geo replication for this database.
`id` string	Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
`modules` []Module_STATUS	Modules: Optional set of redis modules to enable in this database - modules can only be added at creation time.
`name` string	Name: The name of the resource
`persistence` Persistence_STATUS	Persistence: Persistence settings
`port` int	Port: TCP port of the database endpoint. Specified at create time. Defaults to an available port.
`provisioningState` ProvisioningState_STATUS	ProvisioningState: Current provisioning status of the database
`resourceState` ResourceState_STATUS	ResourceState: Current resource status of the database
`type` string	Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

RedisEnterpriseDatabase_Spec

(Appears on:RedisEnterpriseDatabase)

Field	Description
`azureName` string	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.
`clientProtocol` DatabaseProperties_ClientProtocol	ClientProtocol: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
`clusteringPolicy` DatabaseProperties_ClusteringPolicy	ClusteringPolicy: Clustering policy - default is OSSCluster. Specified at create time.
`evictionPolicy` DatabaseProperties_EvictionPolicy	EvictionPolicy: Redis eviction policy - default is VolatileLRU
`geoReplication` DatabaseProperties_GeoReplication	GeoReplication: Optional set of properties to configure geo replication for this database.
`modules` []Module	Modules: Optional set of redis modules to enable in this database - modules can only be added at creation time.
`operatorSpec` RedisEnterpriseDatabaseOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	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
`persistence` Persistence	Persistence: Persistence settings
`port` int	Port: TCP port of the database endpoint. Specified at create time. Defaults to an available port.

RedisEnterpriseOperatorSpec

(Appears on:RedisEnterprise_Spec)

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Field	Description
`configMapExpressions` []genruntime/core.DestinationExpression	ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
`secretExpressions` []genruntime/core.DestinationExpression	SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

RedisEnterprise_STATUS

(Appears on:RedisEnterprise)

Field	Description
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`hostName` string	HostName: DNS name of the cluster endpoint
`id` string	Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
`location` string	Location: The geo-location where the resource lives
`minimumTlsVersion` ClusterProperties_MinimumTlsVersion_STATUS	MinimumTlsVersion: The minimum TLS version for the cluster to support, e.g. ‘1.2’
`name` string	Name: The name of the resource
`privateEndpointConnections` []PrivateEndpointConnection_STATUS	PrivateEndpointConnections: List of private endpoint connections associated with the specified RedisEnterprise cluster
`provisioningState` ProvisioningState_STATUS	ProvisioningState: Current provisioning status of the cluster
`redisVersion` string	RedisVersion: Version of redis the cluster supports, e.g. ‘6’
`resourceState` ResourceState_STATUS	ResourceState: Current resource status of the cluster
`sku` Sku_STATUS	Sku: The SKU to create, which affects price, performance, and features.
`tags` map[string]string	Tags: Resource tags.
`type` string	Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
`zones` []string	Zones: The Availability Zones where this cluster will be deployed.

RedisEnterprise_Spec

(Appears on:RedisEnterprise)

Field	Description
`azureName` string	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.
`location` string	Location: The geo-location where the resource lives
`minimumTlsVersion` ClusterProperties_MinimumTlsVersion	MinimumTlsVersion: The minimum TLS version for the cluster to support, e.g. ‘1.2’
`operatorSpec` RedisEnterpriseOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	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
`sku` Sku	Sku: The SKU to create, which affects price, performance, and features.
`tags` map[string]string	Tags: Resource tags.
`zones` []string	Zones: The Availability Zones where this cluster will be deployed.

ResourceState_STATUS (`string` alias)

(Appears on:RedisEnterpriseDatabase_STATUS, RedisEnterprise_STATUS)

Current resource status

Value	Description
"CreateFailed"
"Creating"
"DeleteFailed"
"Deleting"
"DisableFailed"
"Disabled"
"Disabling"
"EnableFailed"
"Enabling"
"Running"
"UpdateFailed"
"Updating"

Sku

(Appears on:RedisEnterprise_Spec)

SKU parameters supplied to the create RedisEnterprise operation.

Field	Description
`capacity` int	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.
`name` Sku_Name	Name: The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.)

Sku_Name (`string` alias)

(Appears on:Sku)

Value	Description
"EnterpriseFlash_F1500"
"EnterpriseFlash_F300"
"EnterpriseFlash_F700"
"Enterprise_E10"
"Enterprise_E100"
"Enterprise_E20"
"Enterprise_E50"

Sku_Name_STATUS (`string` alias)

(Appears on:Sku_STATUS)

Value	Description
"EnterpriseFlash_F1500"
"EnterpriseFlash_F300"
"EnterpriseFlash_F700"
"Enterprise_E10"
"Enterprise_E100"
"Enterprise_E20"
"Enterprise_E50"

Sku_STATUS

(Appears on:RedisEnterprise_STATUS)

SKU parameters supplied to the create RedisEnterprise operation.

Field	Description
`capacity` int	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.
`name` Sku_Name_STATUS	Name: The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.)

cache.azure.com/v1api20230701