cache.azure.com/v1api20230801
cache.azure.com/v1api20230801
Package v1api20230801 contains API Schema definitions for the cache v1api20230801 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2023-08-01" |
ManagedServiceIdentity
(Appears on:Redis_Spec)
Managed service identity (system assigned and/or user assigned identities)
Field | Description |
---|---|
type ManagedServiceIdentityType |
Type: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
userAssignedIdentities []UserAssignedIdentityDetails |
ManagedServiceIdentityType
(string
alias)
(Appears on:ManagedServiceIdentity)
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned, UserAssigned" |
|
"UserAssigned" |
ManagedServiceIdentityType_STATUS
(string
alias)
(Appears on:ManagedServiceIdentity_STATUS)
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned, UserAssigned" |
|
"UserAssigned" |
ManagedServiceIdentity_STATUS
(Appears on:Redis_STATUS)
Managed service identity (system assigned and/or user assigned identities)
Field | Description |
---|---|
principalId string |
PrincipalId: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. |
tenantId string |
TenantId: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. |
type ManagedServiceIdentityType_STATUS |
Type: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
userAssignedIdentities map[string]./api/cache/v1api20230801.UserAssignedIdentity_STATUS |
PrivateEndpointConnection_STATUS
(Appears on:Redis_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}p> |
Redis
Generator information: - Generated from: /redis/resource-manager/Microsoft.Cache/stable/2023-08-01/redis.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}p>
Field | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||||||
spec Redis_Spec |
|
||||||||||||||||||||||||||||||||||||||||
status Redis_STATUS |
RedisCreateProperties_MinimumTlsVersion
(string
alias)
(Appears on:Redis_Spec)
Value | Description |
---|---|
"1.0" |
|
"1.1" |
|
"1.2" |
RedisCreateProperties_PublicNetworkAccess
(string
alias)
(Appears on:Redis_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
RedisCreateProperties_RedisConfiguration
(Appears on:Redis_Spec)
Field | Description |
---|---|
aad-enabled string |
AadEnabled: Specifies whether AAD based authentication has been enabled or disabled for the cache |
aof-backup-enabled string |
AofBackupEnabled: Specifies whether the aof backup is enabled |
aof-storage-connection-string-0 string |
AofStorageConnectionString0: First storage account connection string |
aof-storage-connection-string-1 string |
AofStorageConnectionString1: Second storage account connection string |
authnotrequired string |
Authnotrequired: Specifies whether the authentication is disabled. Setting this property is highly discouraged from security point of view. |
maxfragmentationmemory-reserved string |
MaxfragmentationmemoryReserved: Value in megabytes reserved for fragmentation per shard |
maxmemory-delta string |
MaxmemoryDelta: Value in megabytes reserved for non-cache usage per shard e.g. failover. |
maxmemory-policy string |
MaxmemoryPolicy: The eviction strategy used when your data won’t fit within its memory limit. |
maxmemory-reserved string |
MaxmemoryReserved: Value in megabytes reserved for non-cache usage per shard e.g. failover. |
notify-keyspace-events string |
NotifyKeyspaceEvents: The keyspace events which should be monitored. |
preferred-data-persistence-auth-method string |
PreferredDataPersistenceAuthMethod: Preferred auth method to communicate to storage account used for data persistence, specify SAS or ManagedIdentity, default value is SAS |
rdb-backup-enabled string |
RdbBackupEnabled: Specifies whether the rdb backup is enabled |
rdb-backup-frequency string |
RdbBackupFrequency: Specifies the frequency for creating rdb backup in minutes. Valid values: (15, 30, 60, 360, 720, 1440) |
rdb-backup-max-snapshot-count string |
RdbBackupMaxSnapshotCount: Specifies the maximum number of snapshots for rdb backup |
rdb-storage-connection-string string |
RdbStorageConnectionString: The storage account connection string for storing rdb file |
storage-subscription-id string |
StorageSubscriptionId: SubscriptionId of the storage account for persistence (aof/rdb) using ManagedIdentity. |
RedisCreateProperties_UpdateChannel
(string
alias)
(Appears on:Redis_Spec)
Value | Description |
---|---|
"Preview" |
|
"Stable" |
RedisFirewallRule
Generator information: - Generated from: /redis/resource-manager/Microsoft.Cache/stable/2023-08-01/redis.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules/{ruleName}p>
Field | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||
spec RedisFirewallRule_Spec |
|
||||||||||
status RedisFirewallRule_STATUS |
RedisFirewallRuleOperatorSpec
(Appears on:RedisFirewallRule_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). |
RedisFirewallRule_STATUS
(Appears on:RedisFirewallRule)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
endIP string |
EndIP: highest IP address included in the range |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
startIP string |
StartIP: lowest IP address included in the range |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
RedisFirewallRule_Spec
(Appears on:RedisFirewallRule)
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. |
endIP string |
EndIP: highest IP address included in the range |
operatorSpec RedisFirewallRuleOperatorSpec |
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/Redis resource |
startIP string |
StartIP: lowest IP address included in the range |
RedisInstanceDetails_STATUS
(Appears on:Redis_STATUS)
Details of single instance of redis.
Field | Description |
---|---|
isMaster bool |
IsMaster: Specifies whether the instance is a primary node. |
isPrimary bool |
IsPrimary: Specifies whether the instance is a primary node. |
nonSslPort int |
NonSslPort: If enableNonSslPort is true, provides Redis instance Non-SSL port. |
shardId int |
ShardId: If clustering is enabled, the Shard ID of Redis Instance |
sslPort int |
SslPort: Redis instance SSL port. |
zone string |
Zone: If the Cache uses availability zones, specifies availability zone where this instance is located. |
RedisLinkedServer
Generator information: - Generated from: /redis/resource-manager/Microsoft.Cache/stable/2023-08-01/redis.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/linkedServers/{linkedServerName}p>
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||
spec RedisLinkedServer_Spec |
|
||||||||||||
status Redis_LinkedServer_STATUS |
RedisLinkedServerCreateProperties_ServerRole
(string
alias)
(Appears on:RedisLinkedServer_Spec)
Value | Description |
---|---|
"Primary" |
|
"Secondary" |
RedisLinkedServerOperatorSpec
(Appears on:RedisLinkedServer_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). |
RedisLinkedServerProperties_ServerRole_STATUS
(string
alias)
(Appears on:Redis_LinkedServer_STATUS)
Value | Description |
---|---|
"Primary" |
|
"Secondary" |
RedisLinkedServer_STATUS
(Appears on:Redis_STATUS)
Linked server Id
Field | Description |
---|---|
id string |
Id: Linked server Id. |
RedisLinkedServer_Spec
(Appears on:RedisLinkedServer)
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. |
linkedRedisCacheLocation string |
LinkedRedisCacheLocation: Location of the linked redis cache. |
linkedRedisCacheReference genruntime.ResourceReference |
LinkedRedisCacheReference: Fully qualified resourceId of the linked redis cache. |
operatorSpec RedisLinkedServerOperatorSpec |
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/Redis resource |
serverRole RedisLinkedServerCreateProperties_ServerRole |
ServerRole: Role of the linked server. |
RedisOperatorSecrets
(Appears on:RedisOperatorSpec)
Field | Description |
---|---|
hostName genruntime.SecretDestination |
HostName: indicates where the HostName secret should be placed. If omitted, the secret will not be retrieved from Azure. |
port genruntime.SecretDestination |
Port: indicates where the Port secret should be placed. If omitted, the secret will not be retrieved from Azure. |
primaryKey genruntime.SecretDestination |
PrimaryKey: indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. |
sslPort genruntime.SecretDestination |
SSLPort: indicates where the SSLPort secret should be placed. If omitted, the secret will not be retrieved from Azure. |
secondaryKey genruntime.SecretDestination |
SecondaryKey: indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. |
RedisOperatorSpec
(Appears on:Redis_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). |
secrets RedisOperatorSecrets |
Secrets: configures where to place Azure generated secrets. |
RedisPatchSchedule
Generator information: - Generated from: /redis/resource-manager/Microsoft.Cache/stable/2023-08-01/redis.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/patchSchedules/defaultp>
Field | Description | ||||||
---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||
spec RedisPatchSchedule_Spec |
|
||||||
status RedisPatchSchedule_STATUS |
RedisPatchScheduleOperatorSpec
(Appears on:RedisPatchSchedule_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). |
RedisPatchSchedule_STATUS
(Appears on:RedisPatchSchedule)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
location string |
Location: The geo-location where the resource lives |
name string |
Name: The name of the resource |
scheduleEntries []ScheduleEntry_STATUS |
ScheduleEntries: List of patch schedules for a Redis cache. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
RedisPatchSchedule_Spec
(Appears on:RedisPatchSchedule)
Field | Description |
---|---|
operatorSpec RedisPatchScheduleOperatorSpec |
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/Redis resource |
scheduleEntries []ScheduleEntry |
ScheduleEntries: List of patch schedules for a Redis cache. |
RedisProperties_MinimumTlsVersion_STATUS
(string
alias)
(Appears on:Redis_STATUS)
Value | Description |
---|---|
"1.0" |
|
"1.1" |
|
"1.2" |
RedisProperties_ProvisioningState_STATUS
(string
alias)
(Appears on:Redis_STATUS)
Value | Description |
---|---|
"ConfiguringAAD" |
|
"Creating" |
|
"Deleting" |
|
"Disabled" |
|
"Failed" |
|
"Linking" |
|
"Provisioning" |
|
"RecoveringScaleFailure" |
|
"Scaling" |
|
"Succeeded" |
|
"Unlinking" |
|
"Unprovisioning" |
|
"Updating" |
RedisProperties_PublicNetworkAccess_STATUS
(string
alias)
(Appears on:Redis_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
RedisProperties_RedisConfiguration_STATUS
(Appears on:Redis_STATUS)
Field | Description |
---|---|
aad-enabled string |
AadEnabled: Specifies whether AAD based authentication has been enabled or disabled for the cache |
aof-backup-enabled string |
AofBackupEnabled: Specifies whether the aof backup is enabled |
aof-storage-connection-string-0 string |
AofStorageConnectionString0: First storage account connection string |
aof-storage-connection-string-1 string |
AofStorageConnectionString1: Second storage account connection string |
authnotrequired string |
Authnotrequired: Specifies whether the authentication is disabled. Setting this property is highly discouraged from security point of view. |
maxclients string |
Maxclients: The max clients config |
maxfragmentationmemory-reserved string |
MaxfragmentationmemoryReserved: Value in megabytes reserved for fragmentation per shard |
maxmemory-delta string |
MaxmemoryDelta: Value in megabytes reserved for non-cache usage per shard e.g. failover. |
maxmemory-policy string |
MaxmemoryPolicy: The eviction strategy used when your data won’t fit within its memory limit. |
maxmemory-reserved string |
MaxmemoryReserved: Value in megabytes reserved for non-cache usage per shard e.g. failover. |
notify-keyspace-events string |
NotifyKeyspaceEvents: The keyspace events which should be monitored. |
preferred-data-archive-auth-method string |
PreferredDataArchiveAuthMethod: Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS |
preferred-data-persistence-auth-method string |
PreferredDataPersistenceAuthMethod: Preferred auth method to communicate to storage account used for data persistence, specify SAS or ManagedIdentity, default value is SAS |
rdb-backup-enabled string |
RdbBackupEnabled: Specifies whether the rdb backup is enabled |
rdb-backup-frequency string |
RdbBackupFrequency: Specifies the frequency for creating rdb backup in minutes. Valid values: (15, 30, 60, 360, 720, 1440) |
rdb-backup-max-snapshot-count string |
RdbBackupMaxSnapshotCount: Specifies the maximum number of snapshots for rdb backup |
rdb-storage-connection-string string |
RdbStorageConnectionString: The storage account connection string for storing rdb file |
storage-subscription-id string |
StorageSubscriptionId: SubscriptionId of the storage account for persistence (aof/rdb) using ManagedIdentity. |
zonal-configuration string |
ZonalConfiguration: Zonal Configuration |
RedisProperties_UpdateChannel_STATUS
(string
alias)
(Appears on:Redis_STATUS)
Value | Description |
---|---|
"Preview" |
|
"Stable" |
Redis_LinkedServer_STATUS
(Appears on:RedisLinkedServer)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
geoReplicatedPrimaryHostName string |
GeoReplicatedPrimaryHostName: The unchanging DNS name which will always point to current geo-primary cache among the linked redis caches for seamless Geo Failover experience. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
linkedRedisCacheId string |
LinkedRedisCacheId: Fully qualified resourceId of the linked redis cache. |
linkedRedisCacheLocation string |
LinkedRedisCacheLocation: Location of the linked redis cache. |
name string |
Name: The name of the resource |
primaryHostName string |
PrimaryHostName: The changing DNS name that resolves to the current geo-primary cache among the linked redis caches before or after the Geo Failover. |
provisioningState string |
ProvisioningState: Terminal state of the link between primary and secondary redis cache. |
serverRole RedisLinkedServerProperties_ServerRole_STATUS |
ServerRole: Role of the linked server. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
Redis_STATUS
(Appears on:Redis)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
enableNonSslPort bool |
EnableNonSslPort: Specifies whether the non-ssl Redis server port (6379) is enabled. |
hostName string |
HostName: Redis host name. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
identity ManagedServiceIdentity_STATUS |
Identity: The identity of the resource. |
instances []RedisInstanceDetails_STATUS |
Instances: List of the Redis instances associated with the cache |
linkedServers []RedisLinkedServer_STATUS |
LinkedServers: List of the linked servers associated with the cache |
location string |
Location: The geo-location where the resource lives |
minimumTlsVersion RedisProperties_MinimumTlsVersion_STATUS |
MinimumTlsVersion: Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, ‘1.0’, ‘1.1’, ‘1.2’) |
name string |
Name: The name of the resource |
port int |
Port: Redis non-SSL port. |
privateEndpointConnections []PrivateEndpointConnection_STATUS |
PrivateEndpointConnections: List of private endpoint connection associated with the specified redis cache |
provisioningState RedisProperties_ProvisioningState_STATUS |
ProvisioningState: Redis instance provisioning status. |
publicNetworkAccess RedisProperties_PublicNetworkAccess_STATUS |
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’ |
redisConfiguration RedisProperties_RedisConfiguration_STATUS |
RedisConfiguration: All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc. |
redisVersion string |
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’. |
replicasPerMaster int |
ReplicasPerMaster: The number of replicas to be created per primary. |
replicasPerPrimary int |
ReplicasPerPrimary: The number of replicas to be created per primary. |
shardCount int |
ShardCount: The number of shards to be created on a Premium Cluster Cache. |
sku Sku_STATUS |
Sku: The SKU of the Redis cache to deploy. |
sslPort int |
SslPort: Redis SSL port. |
staticIP string |
StaticIP: Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default. |
subnetId string |
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/subnet1p> |
tags map[string]string |
Tags: Resource tags. |
tenantSettings map[string]string |
TenantSettings: A dictionary of tenant settings |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
updateChannel RedisProperties_UpdateChannel_STATUS |
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’. |
zones []string |
Zones: A list of availability zones denoting where the resource needs to come from. |
Redis_Spec
(Appears on:Redis)
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. |
enableNonSslPort bool |
EnableNonSslPort: Specifies whether the non-ssl Redis server port (6379) is enabled. |
identity ManagedServiceIdentity |
Identity: The identity of the resource. |
location string |
Location: The geo-location where the resource lives |
minimumTlsVersion RedisCreateProperties_MinimumTlsVersion |
MinimumTlsVersion: Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, ‘1.0’, ‘1.1’, ‘1.2’) |
operatorSpec RedisOperatorSpec |
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 |
publicNetworkAccess RedisCreateProperties_PublicNetworkAccess |
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’ |
redisConfiguration RedisCreateProperties_RedisConfiguration |
RedisConfiguration: All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc. |
redisVersion string |
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’. |
replicasPerMaster int |
ReplicasPerMaster: The number of replicas to be created per primary. |
replicasPerPrimary int |
ReplicasPerPrimary: The number of replicas to be created per primary. |
shardCount int |
ShardCount: The number of shards to be created on a Premium Cluster Cache. |
sku Sku |
Sku: The SKU of the Redis cache to deploy. |
staticIP string |
StaticIP: Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default. |
subnetReference genruntime.ResourceReference |
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/subnet1p> |
tags map[string]string |
Tags: Resource tags. |
tenantSettings map[string]string |
TenantSettings: A dictionary of tenant settings |
updateChannel RedisCreateProperties_UpdateChannel |
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’. |
zones []string |
Zones: A list of availability zones denoting where the resource needs to come from. |
ScheduleEntry
(Appears on:RedisPatchSchedule_Spec)
Patch schedule entry for a Premium Redis Cache.
Field | Description |
---|---|
dayOfWeek ScheduleEntry_DayOfWeek |
DayOfWeek: Day of the week when a cache can be patched. |
maintenanceWindow string |
MaintenanceWindow: ISO8601 timespan specifying how much time cache patching can take. |
startHourUtc int |
StartHourUtc: Start hour after which cache patching can start. |
ScheduleEntry_DayOfWeek
(string
alias)
(Appears on:ScheduleEntry)
Value | Description |
---|---|
"Everyday" |
|
"Friday" |
|
"Monday" |
|
"Saturday" |
|
"Sunday" |
|
"Thursday" |
|
"Tuesday" |
|
"Wednesday" |
|
"Weekend" |
ScheduleEntry_DayOfWeek_STATUS
(string
alias)
(Appears on:ScheduleEntry_STATUS)
Value | Description |
---|---|
"Everyday" |
|
"Friday" |
|
"Monday" |
|
"Saturday" |
|
"Sunday" |
|
"Thursday" |
|
"Tuesday" |
|
"Wednesday" |
|
"Weekend" |
ScheduleEntry_STATUS
(Appears on:RedisPatchSchedule_STATUS)
Patch schedule entry for a Premium Redis Cache.
Field | Description |
---|---|
dayOfWeek ScheduleEntry_DayOfWeek_STATUS |
DayOfWeek: Day of the week when a cache can be patched. |
maintenanceWindow string |
MaintenanceWindow: ISO8601 timespan specifying how much time cache patching can take. |
startHourUtc int |
StartHourUtc: Start hour after which cache patching can start. |
Sku
(Appears on:Redis_Spec)
SKU parameters supplied to the create Redis operation.
Field | Description |
---|---|
capacity int |
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). |
family Sku_Family |
Family: The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). |
name Sku_Name |
Name: The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) |
Sku_Family
(string
alias)
(Appears on:Sku)
Value | Description |
---|---|
"C" |
|
"P" |
Sku_Family_STATUS
(string
alias)
(Appears on:Sku_STATUS)
Value | Description |
---|---|
"C" |
|
"P" |
Sku_Name
(string
alias)
(Appears on:Sku)
Value | Description |
---|---|
"Basic" |
|
"Premium" |
|
"Standard" |
Sku_Name_STATUS
(string
alias)
(Appears on:Sku_STATUS)
Value | Description |
---|---|
"Basic" |
|
"Premium" |
|
"Standard" |
Sku_STATUS
(Appears on:Redis_STATUS)
SKU parameters supplied to the create Redis operation.
Field | Description |
---|---|
capacity int |
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). |
family Sku_Family_STATUS |
Family: The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). |
name Sku_Name_STATUS |
Name: The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) |
UserAssignedIdentityDetails
(Appears on:ManagedServiceIdentity)
Information about the user assigned identity for the resource
Field | Description |
---|---|
reference genruntime.ResourceReference |
UserAssignedIdentity_STATUS
(Appears on:ManagedServiceIdentity_STATUS)
User assigned identity properties
Field | Description |
---|---|
clientId string |
ClientId: The client ID of the assigned identity. |
principalId string |
PrincipalId: The principal ID of the assigned identity. |