cache.azure.com/v1api20241101
APIVersion
| Value | Description |
|---|---|
| “2024-11-01” |
Redis
Generator information: - Generated from: /redis/resource-manager/Microsoft.Cache/Redis/stable/2024-11-01/redis.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}
Used by: RedisList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Redis_Spec Optional |
|
| status | Redis_STATUS Optional |
Redis_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 |
| disableAccessKeyAuthentication | Authentication to Redis through access keys is disabled when set as true. Default value is false. | bool Optional |
| enableNonSslPort | Specifies whether the non-ssl Redis server port (6379) is enabled. | bool Optional |
| identity | The identity of the resource. | ManagedServiceIdentity Optional |
| location | The geo-location where the resource lives | string Required |
| minimumTlsVersion | Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, 1.0, 1.1, 1.2) |
TlsVersion Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | RedisOperatorSpec 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 |
| publicNetworkAccess | Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be Enabled or Disabled. If Disabled, private endpoints are the exclusive access method. |
PublicNetworkAccess Optional |
| redisConfiguration | All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta, maxmemory-policy,notify-keyspace-events, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 etc. | RedisCommonPropertiesRedisConfiguration Optional |
| redisVersion | Redis version. This should be in the form major[.minor] (only major is required) or the value latest which refers to the latest stable Redis version that is available. Supported versions: 4.0, 6.0 (latest). Default value is latest. |
string Optional |
| replicasPerMaster | The number of replicas to be created per primary. | int Optional |
| replicasPerPrimary | The number of replicas to be created per primary. | int Optional |
| shardCount | The number of shards to be created on a Premium Cluster Cache. | int Optional |
| sku | The SKU of the Redis cache to deploy. | Sku Required |
| staticIP | Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default. | string Optional |
| subnetReference | The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network | ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1 |
| tags | Resource tags. | map[string]string Optional |
| tenantSettings | A dictionary of tenant settings | map[string]string Optional |
| updateChannel | Optional: Specifies the update channel for the monthly Redis updates your Redis Cache will receive. Caches using Preview update channel get latest Redis updates at least 4 weeks ahead of Stable channel caches. Default value is Stable. |
UpdateChannel Optional |
| zonalAllocationPolicy | Optional: Specifies how availability zones are allocated to the Redis cache. Automatic enables zone redundancy and Azure will automatically select zones based on regional availability and capacity. UserDefined will select availability zones passed in by you using the zones parameter. NoZones will produce a non-zonal cache. If zonalAllocationPolicy is not passed, it will be set to UserDefined when zones are passed in, otherwise, it will be set to Automatic in regions where zones are supported and NoZones in regions where zones are not supported. |
ZonalAllocationPolicy Optional |
| zones | A list of availability zones denoting where the resource needs to come from. | string[] Optional |
Redis_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| disableAccessKeyAuthentication | Authentication to Redis through access keys is disabled when set as true. Default value is false. | bool Optional |
| enableNonSslPort | Specifies whether the non-ssl Redis server port (6379) is enabled. | bool Optional |
| hostName | Redis host name. | string Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity_STATUS Optional |
| instances | List of the Redis instances associated with the cache | RedisInstanceDetails_STATUS[] Optional |
| linkedServers | List of the linked servers associated with the cache | RedisLinkedServer_STATUS[] Optional |
| location | The geo-location where the resource lives | string Optional |
| minimumTlsVersion | Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, 1.0, 1.1, 1.2) |
TlsVersion_STATUS Optional |
| name | The name of the resource | string Optional |
| port | Redis non-SSL port. | int Optional |
| privateEndpointConnections | List of private endpoint connection associated with the specified redis cache | PrivateEndpointConnection_STATUS[] Optional |
| provisioningState | Redis instance provisioning status. | ProvisioningState_STATUS Optional |
| publicNetworkAccess | Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be Enabled or Disabled. If Disabled, private endpoints are the exclusive access method. |
PublicNetworkAccess_STATUS Optional |
| redisConfiguration | All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta, maxmemory-policy,notify-keyspace-events, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 etc. | RedisCommonPropertiesRedisConfiguration_STATUS Optional |
| redisVersion | Redis version. This should be in the form major[.minor] (only major is required) or the value latest which refers to the latest stable Redis version that is available. Supported versions: 4.0, 6.0 (latest). Default value is latest. |
string Optional |
| replicasPerMaster | The number of replicas to be created per primary. | int Optional |
| replicasPerPrimary | The number of replicas to be created per primary. | int Optional |
| shardCount | The number of shards to be created on a Premium Cluster Cache. | int Optional |
| sku | The SKU of the Redis cache to deploy. | Sku_STATUS Optional |
| sslPort | Redis SSL port. | int Optional |
| staticIP | Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default. | string Optional |
| subnetId | The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network | ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1 |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| tenantSettings | A dictionary of tenant settings | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| updateChannel | Optional: Specifies the update channel for the monthly Redis updates your Redis Cache will receive. Caches using Preview update channel get latest Redis updates at least 4 weeks ahead of Stable channel caches. Default value is Stable. |
UpdateChannel_STATUS Optional |
| zonalAllocationPolicy | Optional: Specifies how availability zones are allocated to the Redis cache. Automatic enables zone redundancy and Azure will automatically select zones based on regional availability and capacity. UserDefined will select availability zones passed in by you using the zones parameter. NoZones will produce a non-zonal cache. If zonalAllocationPolicy is not passed, it will be set to UserDefined when zones are passed in, otherwise, it will be set to Automatic in regions where zones are supported and NoZones in regions where zones are not supported. |
ZonalAllocationPolicy_STATUS Optional |
| zones | The availability zones. | string[] Optional |
RedisAccessPolicy
Generator information: - Generated from: /redis/resource-manager/Microsoft.Cache/Redis/stable/2024-11-01/redis.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicies/{accessPolicyName}
Used by: RedisAccessPolicyList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | RedisAccessPolicy_Spec Optional |
|
| status | RedisAccessPolicy_STATUS Optional |
RedisAccessPolicy_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 |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | RedisAccessPolicyOperatorSpec 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/Redis resource | genruntime.KnownResourceReference Required |
| permissions | Permissions for the access policy. Learn how to configure permissions at https://aka.ms/redis/AADPreRequisites | string Required |
RedisAccessPolicy_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| name | The name of the resource | string Optional |
| permissions | Permissions for the access policy. Learn how to configure permissions at https://aka.ms/redis/AADPreRequisites | string Optional |
| properties_type | Built-In or Custom access policy | AccessPolicyType_STATUS Optional |
| provisioningState | Provisioning state of access policy | AccessPolicyProvisioningState_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 |
RedisAccessPolicyAssignment
Generator information: - Generated from: /redis/resource-manager/Microsoft.Cache/Redis/stable/2024-11-01/redis.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicyAssignments/{accessPolicyAssignmentName}
Used by: RedisAccessPolicyAssignmentList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | RedisAccessPolicyAssignment_Spec Optional |
|
| status | RedisAccessPolicyAssignment_STATUS Optional |
RedisAccessPolicyAssignment_Spec
| Property | Description | Type |
|---|---|---|
| accessPolicyName | The name of the access policy that is being assigned | string Required |
| 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 |
| objectId | Object Id to assign access policy to | string Optional |
| objectIdAlias | User friendly name for object id. Also represents username for token based authentication | string Optional |
| objectIdAliasFromConfig | User friendly name for object id. Also represents username for token based authentication | genruntime.ConfigMapReference Optional |
| objectIdFromConfig | Object Id to assign access policy to | genruntime.ConfigMapReference Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | RedisAccessPolicyAssignmentOperatorSpec 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/Redis resource | genruntime.KnownResourceReference Required |
RedisAccessPolicyAssignment_STATUS
| Property | Description | Type |
|---|---|---|
| accessPolicyName | The name of the access policy that is being assigned | string Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| name | The name of the resource | string Optional |
| objectId | Object Id to assign access policy to | string Optional |
| objectIdAlias | User friendly name for object id. Also represents username for token based authentication | string Optional |
| provisioningState | Provisioning state of an access policy assignment set | AccessPolicyAssignmentProvisioningState_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 |
RedisAccessPolicyAssignmentList
Generator information: - Generated from: /redis/resource-manager/Microsoft.Cache/Redis/stable/2024-11-01/redis.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicyAssignments/{accessPolicyAssignmentName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | RedisAccessPolicyAssignment[] Optional |
RedisAccessPolicyList
Generator information: - Generated from: /redis/resource-manager/Microsoft.Cache/Redis/stable/2024-11-01/redis.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicies/{accessPolicyName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | RedisAccessPolicy[] Optional |
RedisFirewallRule
Generator information: - Generated from: /redis/resource-manager/Microsoft.Cache/Redis/stable/2024-11-01/redis.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules/{ruleName}
Used by: RedisFirewallRuleList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | RedisFirewallRule_Spec Optional |
|
| status | RedisFirewallRule_STATUS Optional |
RedisFirewallRule_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 |
| endIP | highest IP address included in the range | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | RedisFirewallRuleOperatorSpec 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/Redis resource | genruntime.KnownResourceReference Required |
| startIP | lowest IP address included in the range | string Required |
RedisFirewallRule_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| endIP | highest IP address included in the range | string Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| name | The name of the resource | string Optional |
| startIP | lowest IP address included in the range | string 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 |
RedisFirewallRuleList
Generator information: - Generated from: /redis/resource-manager/Microsoft.Cache/Redis/stable/2024-11-01/redis.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules/{ruleName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | RedisFirewallRule[] Optional |
RedisLinkedServer
Generator information: - Generated from: /redis/resource-manager/Microsoft.Cache/Redis/stable/2024-11-01/redis.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/linkedServers/{linkedServerName}
Used by: RedisLinkedServerList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | RedisLinkedServer_Spec Optional |
|
| status | Redis_LinkedServer_STATUS Optional |
RedisLinkedServer_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 |
| linkedRedisCacheLocation | Location of the linked redis cache. | string Required |
| linkedRedisCacheReference | Fully qualified resourceId of the linked redis cache. | genruntime.ResourceReference Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | RedisLinkedServerOperatorSpec 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/Redis resource | genruntime.KnownResourceReference Required |
| serverRole | Role of the linked server. | ReplicationRole Required |
Redis_LinkedServer_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| geoReplicatedPrimaryHostName | The unchanging DNS name which will always point to current geo-primary cache among the linked redis caches for seamless Geo Failover experience. | string Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| linkedRedisCacheId | Fully qualified resourceId of the linked redis cache. | string Optional |
| linkedRedisCacheLocation | Location of the linked redis cache. | string Optional |
| name | The name of the resource | string Optional |
| primaryHostName | The changing DNS name that resolves to the current geo-primary cache among the linked redis caches before or after the Geo Failover. | string Optional |
| provisioningState | Terminal state of the link between primary and secondary redis cache. | string Optional |
| serverRole | Role of the linked server. | ReplicationRole_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 |
RedisLinkedServerList
Generator information: - Generated from: /redis/resource-manager/Microsoft.Cache/Redis/stable/2024-11-01/redis.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/linkedServers/{linkedServerName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | RedisLinkedServer[] Optional |
RedisList
Generator information: - Generated from: /redis/resource-manager/Microsoft.Cache/Redis/stable/2024-11-01/redis.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Redis[] Optional |
RedisPatchSchedule
Generator information: - Generated from: /redis/resource-manager/Microsoft.Cache/Redis/stable/2024-11-01/redis.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/patchSchedules/default
Used by: RedisPatchScheduleList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | RedisPatchSchedule_Spec Optional |
|
| status | RedisPatchSchedule_STATUS Optional |
RedisPatchSchedule_Spec
| Property | Description | Type |
|---|---|---|
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | RedisPatchScheduleOperatorSpec 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/Redis resource | genruntime.KnownResourceReference Required |
| scheduleEntries | List of patch schedules for a Redis cache. | ScheduleEntry[] Required |
RedisPatchSchedule_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| scheduleEntries | List of patch schedules for a Redis cache. | ScheduleEntry_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 |
RedisPatchScheduleList
Generator information: - Generated from: /redis/resource-manager/Microsoft.Cache/Redis/stable/2024-11-01/redis.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/patchSchedules/default
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | RedisPatchSchedule[] Optional |
Redis_LinkedServer_STATUS
Used by: RedisLinkedServer.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| geoReplicatedPrimaryHostName | The unchanging DNS name which will always point to current geo-primary cache among the linked redis caches for seamless Geo Failover experience. | string Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| linkedRedisCacheId | Fully qualified resourceId of the linked redis cache. | string Optional |
| linkedRedisCacheLocation | Location of the linked redis cache. | string Optional |
| name | The name of the resource | string Optional |
| primaryHostName | The changing DNS name that resolves to the current geo-primary cache among the linked redis caches before or after the Geo Failover. | string Optional |
| provisioningState | Terminal state of the link between primary and secondary redis cache. | string Optional |
| serverRole | Role of the linked server. | ReplicationRole_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 |
Redis_Spec
Used by: Redis.
| 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 |
| disableAccessKeyAuthentication | Authentication to Redis through access keys is disabled when set as true. Default value is false. | bool Optional |
| enableNonSslPort | Specifies whether the non-ssl Redis server port (6379) is enabled. | bool Optional |
| identity | The identity of the resource. | ManagedServiceIdentity Optional |
| location | The geo-location where the resource lives | string Required |
| minimumTlsVersion | Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, 1.0, 1.1, 1.2) |
TlsVersion Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | RedisOperatorSpec 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 |
| publicNetworkAccess | Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be Enabled or Disabled. If Disabled, private endpoints are the exclusive access method. |
PublicNetworkAccess Optional |
| redisConfiguration | All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta, maxmemory-policy,notify-keyspace-events, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 etc. | RedisCommonPropertiesRedisConfiguration Optional |
| redisVersion | Redis version. This should be in the form major[.minor] (only major is required) or the value latest which refers to the latest stable Redis version that is available. Supported versions: 4.0, 6.0 (latest). Default value is latest. |
string Optional |
| replicasPerMaster | The number of replicas to be created per primary. | int Optional |
| replicasPerPrimary | The number of replicas to be created per primary. | int Optional |
| shardCount | The number of shards to be created on a Premium Cluster Cache. | int Optional |
| sku | The SKU of the Redis cache to deploy. | Sku Required |
| staticIP | Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default. | string Optional |
| subnetReference | The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network | ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1 |
| tags | Resource tags. | map[string]string Optional |
| tenantSettings | A dictionary of tenant settings | map[string]string Optional |
| updateChannel | Optional: Specifies the update channel for the monthly Redis updates your Redis Cache will receive. Caches using Preview update channel get latest Redis updates at least 4 weeks ahead of Stable channel caches. Default value is Stable. |
UpdateChannel Optional |
| zonalAllocationPolicy | Optional: Specifies how availability zones are allocated to the Redis cache. Automatic enables zone redundancy and Azure will automatically select zones based on regional availability and capacity. UserDefined will select availability zones passed in by you using the zones parameter. NoZones will produce a non-zonal cache. If zonalAllocationPolicy is not passed, it will be set to UserDefined when zones are passed in, otherwise, it will be set to Automatic in regions where zones are supported and NoZones in regions where zones are not supported. |
ZonalAllocationPolicy Optional |
| zones | A list of availability zones denoting where the resource needs to come from. | string[] Optional |
Redis_STATUS
Used by: Redis.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| disableAccessKeyAuthentication | Authentication to Redis through access keys is disabled when set as true. Default value is false. | bool Optional |
| enableNonSslPort | Specifies whether the non-ssl Redis server port (6379) is enabled. | bool Optional |
| hostName | Redis host name. | string Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity_STATUS Optional |
| instances | List of the Redis instances associated with the cache | RedisInstanceDetails_STATUS[] Optional |
| linkedServers | List of the linked servers associated with the cache | RedisLinkedServer_STATUS[] Optional |
| location | The geo-location where the resource lives | string Optional |
| minimumTlsVersion | Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, 1.0, 1.1, 1.2) |
TlsVersion_STATUS Optional |
| name | The name of the resource | string Optional |
| port | Redis non-SSL port. | int Optional |
| privateEndpointConnections | List of private endpoint connection associated with the specified redis cache | PrivateEndpointConnection_STATUS[] Optional |
| provisioningState | Redis instance provisioning status. | ProvisioningState_STATUS Optional |
| publicNetworkAccess | Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be Enabled or Disabled. If Disabled, private endpoints are the exclusive access method. |
PublicNetworkAccess_STATUS Optional |
| redisConfiguration | All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta, maxmemory-policy,notify-keyspace-events, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 etc. | RedisCommonPropertiesRedisConfiguration_STATUS Optional |
| redisVersion | Redis version. This should be in the form major[.minor] (only major is required) or the value latest which refers to the latest stable Redis version that is available. Supported versions: 4.0, 6.0 (latest). Default value is latest. |
string Optional |
| replicasPerMaster | The number of replicas to be created per primary. | int Optional |
| replicasPerPrimary | The number of replicas to be created per primary. | int Optional |
| shardCount | The number of shards to be created on a Premium Cluster Cache. | int Optional |
| sku | The SKU of the Redis cache to deploy. | Sku_STATUS Optional |
| sslPort | Redis SSL port. | int Optional |
| staticIP | Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default. | string Optional |
| subnetId | The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network | ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1 |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| tenantSettings | A dictionary of tenant settings | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| updateChannel | Optional: Specifies the update channel for the monthly Redis updates your Redis Cache will receive. Caches using Preview update channel get latest Redis updates at least 4 weeks ahead of Stable channel caches. Default value is Stable. |
UpdateChannel_STATUS Optional |
| zonalAllocationPolicy | Optional: Specifies how availability zones are allocated to the Redis cache. Automatic enables zone redundancy and Azure will automatically select zones based on regional availability and capacity. UserDefined will select availability zones passed in by you using the zones parameter. NoZones will produce a non-zonal cache. If zonalAllocationPolicy is not passed, it will be set to UserDefined when zones are passed in, otherwise, it will be set to Automatic in regions where zones are supported and NoZones in regions where zones are not supported. |
ZonalAllocationPolicy_STATUS Optional |
| zones | The availability zones. | string[] Optional |
RedisAccessPolicy_Spec
Used by: RedisAccessPolicy.
| 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 |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | RedisAccessPolicyOperatorSpec 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/Redis resource | genruntime.KnownResourceReference Required |
| permissions | Permissions for the access policy. Learn how to configure permissions at https://aka.ms/redis/AADPreRequisites | string Required |
RedisAccessPolicy_STATUS
Used by: RedisAccessPolicy.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| name | The name of the resource | string Optional |
| permissions | Permissions for the access policy. Learn how to configure permissions at https://aka.ms/redis/AADPreRequisites | string Optional |
| properties_type | Built-In or Custom access policy | AccessPolicyType_STATUS Optional |
| provisioningState | Provisioning state of access policy | AccessPolicyProvisioningState_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 |
RedisAccessPolicyAssignment_Spec
Used by: RedisAccessPolicyAssignment.
| Property | Description | Type |
|---|---|---|
| accessPolicyName | The name of the access policy that is being assigned | string Required |
| 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 |
| objectId | Object Id to assign access policy to | string Optional |
| objectIdAlias | User friendly name for object id. Also represents username for token based authentication | string Optional |
| objectIdAliasFromConfig | User friendly name for object id. Also represents username for token based authentication | genruntime.ConfigMapReference Optional |
| objectIdFromConfig | Object Id to assign access policy to | genruntime.ConfigMapReference Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | RedisAccessPolicyAssignmentOperatorSpec 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/Redis resource | genruntime.KnownResourceReference Required |
RedisAccessPolicyAssignment_STATUS
Used by: RedisAccessPolicyAssignment.
| Property | Description | Type |
|---|---|---|
| accessPolicyName | The name of the access policy that is being assigned | string Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| name | The name of the resource | string Optional |
| objectId | Object Id to assign access policy to | string Optional |
| objectIdAlias | User friendly name for object id. Also represents username for token based authentication | string Optional |
| provisioningState | Provisioning state of an access policy assignment set | AccessPolicyAssignmentProvisioningState_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 |
RedisFirewallRule_Spec
Used by: RedisFirewallRule.
| 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 |
| endIP | highest IP address included in the range | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | RedisFirewallRuleOperatorSpec 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/Redis resource | genruntime.KnownResourceReference Required |
| startIP | lowest IP address included in the range | string Required |
RedisFirewallRule_STATUS
Used by: RedisFirewallRule.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| endIP | highest IP address included in the range | string Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| name | The name of the resource | string Optional |
| startIP | lowest IP address included in the range | string 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 |
RedisLinkedServer_Spec
Used by: RedisLinkedServer.
| 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 |
| linkedRedisCacheLocation | Location of the linked redis cache. | string Required |
| linkedRedisCacheReference | Fully qualified resourceId of the linked redis cache. | genruntime.ResourceReference Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | RedisLinkedServerOperatorSpec 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/Redis resource | genruntime.KnownResourceReference Required |
| serverRole | Role of the linked server. | ReplicationRole Required |
RedisPatchSchedule_Spec
Used by: RedisPatchSchedule.
| Property | Description | Type |
|---|---|---|
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | RedisPatchScheduleOperatorSpec 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/Redis resource | genruntime.KnownResourceReference Required |
| scheduleEntries | List of patch schedules for a Redis cache. | ScheduleEntry[] Required |
RedisPatchSchedule_STATUS
Used by: RedisPatchSchedule.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| scheduleEntries | List of patch schedules for a Redis cache. | ScheduleEntry_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 |
AccessPolicyAssignmentProvisioningState_STATUS
Provisioning state of an access policy assignment set
Used by: RedisAccessPolicyAssignment_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Deleted” | |
| “Deleting” | |
| “Failed” | |
| “Succeeded” | |
| “Updating” |
AccessPolicyProvisioningState_STATUS
Provisioning state of access policy
Used by: RedisAccessPolicy_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Deleted” | |
| “Deleting” | |
| “Failed” | |
| “Succeeded” | |
| “Updating” |
AccessPolicyType_STATUS
Built-In or Custom access policy
Used by: RedisAccessPolicy_STATUS.
| Value | Description |
|---|---|
| “BuiltIn” | |
| “Custom” |
ManagedServiceIdentity
Managed service identity (system assigned and/or user assigned identities)
Used by: Redis_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: Redis_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 |
PrivateEndpointConnection_STATUS
The private endpoint connection resource.
Used by: Redis_STATUS.
| Property | Description | Type |
|---|---|---|
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
ProvisioningState_STATUS
Redis instance provisioning status.
Used by: Redis_STATUS.
| Value | Description |
|---|---|
| “ConfiguringAAD” | |
| “Creating” | |
| “Deleting” | |
| “Disabled” | |
| “Failed” | |
| “Linking” | |
| “Provisioning” | |
| “RecoveringScaleFailure” | |
| “Scaling” | |
| “Succeeded” | |
| “Unlinking” | |
| “Unprovisioning” | |
| “Updating” |
PublicNetworkAccess
Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be Enabled or Disabled. If Disabled, private endpoints are the exclusive access method. Default value is Enabled
Used by: Redis_Spec.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
PublicNetworkAccess_STATUS
Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be Enabled or Disabled. If Disabled, private endpoints are the exclusive access method. Default value is Enabled
Used by: Redis_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
RedisAccessPolicyAssignmentOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: RedisAccessPolicyAssignment_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 |
RedisAccessPolicyOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: RedisAccessPolicy_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 |
RedisCommonPropertiesRedisConfiguration
All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta, maxmemory-policy,notify-keyspace-events, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 etc.
Used by: Redis_Spec.
| Property | Description | Type |
|---|---|---|
| aad-enabled | Specifies whether AAD based authentication has been enabled or disabled for the cache | string Optional |
| aof-backup-enabled | Specifies whether the aof backup is enabled | string Optional |
| aof-storage-connection-string-0 | First storage account connection string | string Optional |
| aof-storage-connection-string-1 | Second storage account connection string | string Optional |
| authnotrequired | Specifies whether the authentication is disabled. Setting this property is highly discouraged from security point of view; you should never disable authentication using this property! | string Optional |
| maxfragmentationmemory-reserved | Value in megabytes reserved for fragmentation per shard | string Optional |
| maxmemory-delta | Value in megabytes reserved for non-cache usage per shard e.g. failover. | string Optional |
| maxmemory-policy | The eviction strategy used when your data won’t fit within its memory limit. | string Optional |
| maxmemory-reserved | Value in megabytes reserved for non-cache usage per shard e.g. failover. | string Optional |
| notify-keyspace-events | The keyspace events which should be monitored. | string Optional |
| preferred-data-persistence-auth-method | Preferred auth method to communicate to storage account used for data persistence, specify SAS or ManagedIdentity, default value is SAS | string Optional |
| rdb-backup-enabled | Specifies whether the RDB backup is enabled | string Optional |
| rdb-backup-frequency | Specifies the frequency for creating rdb backup in minutes. Valid values: (15, 30, 60, 360, 720, 1440) | string Optional |
| rdb-backup-max-snapshot-count | Specifies the maximum number of snapshots for rdb backup | string Optional |
| rdb-storage-connection-string | The storage account connection string for storing rdb file | string Optional |
| storage-subscription-id | SubscriptionId of the storage account for persistence (aof/rdb) using ManagedIdentity. | string Optional |
RedisCommonPropertiesRedisConfiguration_STATUS
All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta, maxmemory-policy,notify-keyspace-events, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 etc.
Used by: Redis_STATUS.
| Property | Description | Type |
|---|---|---|
| aad-enabled | Specifies whether AAD based authentication has been enabled or disabled for the cache | string Optional |
| aof-backup-enabled | Specifies whether the aof backup is enabled | string Optional |
| aof-storage-connection-string-0 | First storage account connection string | string Optional |
| aof-storage-connection-string-1 | Second storage account connection string | string Optional |
| authnotrequired | Specifies whether the authentication is disabled. Setting this property is highly discouraged from security point of view; you should never disable authentication using this property! | string Optional |
| maxclients | The max clients config | string Optional |
| maxfragmentationmemory-reserved | Value in megabytes reserved for fragmentation per shard | string Optional |
| maxmemory-delta | Value in megabytes reserved for non-cache usage per shard e.g. failover. | string Optional |
| maxmemory-policy | The eviction strategy used when your data won’t fit within its memory limit. | string Optional |
| maxmemory-reserved | Value in megabytes reserved for non-cache usage per shard e.g. failover. | string Optional |
| notify-keyspace-events | The keyspace events which should be monitored. | string Optional |
| preferred-data-archive-auth-method | Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS | string Optional |
| preferred-data-persistence-auth-method | Preferred auth method to communicate to storage account used for data persistence, specify SAS or ManagedIdentity, default value is SAS | string Optional |
| rdb-backup-enabled | Specifies whether the RDB backup is enabled | string Optional |
| rdb-backup-frequency | Specifies the frequency for creating rdb backup in minutes. Valid values: (15, 30, 60, 360, 720, 1440) | string Optional |
| rdb-backup-max-snapshot-count | Specifies the maximum number of snapshots for rdb backup | string Optional |
| rdb-storage-connection-string | The storage account connection string for storing rdb file | string Optional |
| storage-subscription-id | SubscriptionId of the storage account for persistence (aof/rdb) using ManagedIdentity. | string Optional |
| zonal-configuration | Zonal Configuration | string Optional |
RedisFirewallRuleOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: RedisFirewallRule_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 |
RedisInstanceDetails_STATUS
Details of single instance of redis.
Used by: Redis_STATUS.
| Property | Description | Type |
|---|---|---|
| isMaster | Specifies whether the instance is a primary node. | bool Optional |
| isPrimary | Specifies whether the instance is a primary node. | bool Optional |
| nonSslPort | If enableNonSslPort is true, provides Redis instance Non-SSL port. | int Optional |
| shardId | If clustering is enabled, the Shard ID of Redis Instance | int Optional |
| sslPort | Redis instance SSL port. | int Optional |
| zone | If the Cache uses availability zones, specifies availability zone where this instance is located. | string Optional |
RedisLinkedServer_STATUS
Linked server Id
Used by: Redis_STATUS.
| Property | Description | Type |
|---|---|---|
| id | Linked server Id. | string Optional |
RedisLinkedServerOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: RedisLinkedServer_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 |
RedisOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Redis_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 |
| secrets | configures where to place Azure generated secrets. | RedisOperatorSecrets Optional |
RedisPatchScheduleOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: RedisPatchSchedule_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 |
ReplicationRole
Role of the linked server.
Used by: RedisLinkedServer_Spec.
| Value | Description |
|---|---|
| “Primary” | |
| “Secondary” |
ReplicationRole_STATUS
Role of the linked server.
Used by: Redis_LinkedServer_STATUS.
| Value | Description |
|---|---|
| “Primary” | |
| “Secondary” |
ScheduleEntry
Patch schedule entry for a Premium Redis Cache.
Used by: RedisPatchSchedule_Spec.
| Property | Description | Type |
|---|---|---|
| dayOfWeek | Day of the week when a cache can be patched. | DayOfWeek Required |
| maintenanceWindow | ISO8601 timespan specifying how much time cache patching can take. | string Optional |
| startHourUtc | Start hour after which cache patching can start. | int Required |
ScheduleEntry_STATUS
Patch schedule entry for a Premium Redis Cache.
Used by: RedisPatchSchedule_STATUS.
| Property | Description | Type |
|---|---|---|
| dayOfWeek | Day of the week when a cache can be patched. | DayOfWeek_STATUS Optional |
| maintenanceWindow | ISO8601 timespan specifying how much time cache patching can take. | string Optional |
| startHourUtc | Start hour after which cache patching can start. | int Optional |
Sku
SKU parameters supplied to the create Redis operation.
Used by: Redis_Spec.
| Property | Description | Type |
|---|---|---|
| capacity | The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4). | int Required |
| family | The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). | SkuFamily Required |
| name | The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) | SkuName Required |
Sku_STATUS
SKU parameters supplied to the create Redis operation.
Used by: Redis_STATUS.
| Property | Description | Type |
|---|---|---|
| capacity | The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4). | int Optional |
| family | The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). | SkuFamily_STATUS Optional |
| name | The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) | SkuName_STATUS Optional |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: Redis_LinkedServer_STATUS, Redis_STATUS, RedisAccessPolicy_STATUS, RedisAccessPolicyAssignment_STATUS, RedisFirewallRule_STATUS, and RedisPatchSchedule_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 |
TlsVersion
Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, 1.0, 1.1, 1.2)
Used by: Redis_Spec.
| Value | Description |
|---|---|
| “1.0” | |
| “1.1” | |
| “1.2” |
TlsVersion_STATUS
Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, 1.0, 1.1, 1.2)
Used by: Redis_STATUS.
| Value | Description |
|---|---|
| “1.0” | |
| “1.1” | |
| “1.2” |
UpdateChannel
Optional: Specifies the update channel for the monthly Redis updates your Redis Cache will receive. Caches using Preview update channel get latest Redis updates at least 4 weeks ahead of Stable channel caches. Default value is Stable.
Used by: Redis_Spec.
| Value | Description |
|---|---|
| “Preview” | |
| “Stable” |
UpdateChannel_STATUS
Optional: Specifies the update channel for the monthly Redis updates your Redis Cache will receive. Caches using Preview update channel get latest Redis updates at least 4 weeks ahead of Stable channel caches. Default value is Stable.
Used by: Redis_STATUS.
| Value | Description |
|---|---|
| “Preview” | |
| “Stable” |
ZonalAllocationPolicy
Optional: Specifies how availability zones are allocated to the Redis cache. Automatic enables zone redundancy and Azure will automatically select zones based on regional availability and capacity. UserDefined will select availability zones passed in by you using the zones parameter. NoZones will produce a non-zonal cache. If zonalAllocationPolicy is not passed, it will be set to UserDefined when zones are passed in, otherwise, it will be set to Automatic in regions where zones are supported and NoZones in regions where zones are not supported.
Used by: Redis_Spec.
| Value | Description |
|---|---|
| “Automatic” | |
| “NoZones” | |
| “UserDefined” |
ZonalAllocationPolicy_STATUS
Optional: Specifies how availability zones are allocated to the Redis cache. Automatic enables zone redundancy and Azure will automatically select zones based on regional availability and capacity. UserDefined will select availability zones passed in by you using the zones parameter. NoZones will produce a non-zonal cache. If zonalAllocationPolicy is not passed, it will be set to UserDefined when zones are passed in, otherwise, it will be set to Automatic in regions where zones are supported and NoZones in regions where zones are not supported.
Used by: Redis_STATUS.
| Value | Description |
|---|---|
| “Automatic” | |
| “NoZones” | |
| “UserDefined” |
DayOfWeek
Day of the week when a cache can be patched.
Used by: ScheduleEntry.
| Value | Description |
|---|---|
| “Everyday” | |
| “Friday” | |
| “Monday” | |
| “Saturday” | |
| “Sunday” | |
| “Thursday” | |
| “Tuesday” | |
| “Wednesday” | |
| “Weekend” |
DayOfWeek_STATUS
Day of the week when a cache can be patched.
Used by: ScheduleEntry_STATUS.
| Value | Description |
|---|---|
| “Everyday” | |
| “Friday” | |
| “Monday” | |
| “Saturday” | |
| “Sunday” | |
| “Thursday” | |
| “Tuesday” | |
| “Wednesday” | |
| “Weekend” |
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” |
RedisOperatorSecrets
Used by: RedisOperatorSpec.
| Property | Description | Type |
|---|---|---|
| hostName | indicates where the HostName secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| port | indicates where the Port secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| primaryKey | indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| secondaryKey | indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| sslPort | indicates where the SSLPort secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
SkuFamily
The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
Used by: Sku.
| Value | Description |
|---|---|
| “C” | |
| “P” |
SkuFamily_STATUS
The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
Used by: Sku_STATUS.
| Value | Description |
|---|---|
| “C” | |
| “P” |
SkuName
The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
Used by: Sku.
| Value | Description |
|---|---|
| “Basic” | |
| “Premium” | |
| “Standard” |
SkuName_STATUS
The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
Used by: Sku_STATUS.
| Value | Description |
|---|---|
| “Basic” | |
| “Premium” | |
| “Standard” |
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 |