cache.azure.com/v1beta20201201
cache.azure.com/v1beta20201201
Package v1beta20201201 contains API Schema definitions for the cache v1beta20201201 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2020-12-01" |
PrivateEndpointConnection_Status_SubResourceEmbedded
(Appears on:RedisResource_Status)
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
PrivateEndpointConnection_Status_SubResourceEmbeddedARM
(Appears on:RedisProperties_StatusARM)
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
Redis
Generated from: https://schema.management.azure.com/schemas/2020-12-01/Microsoft.Cache.json#/resourceDefinitions/redis
Field | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||
spec Redis_Spec |
|
||||||||||||||||||||||||||||||||||||
status RedisResource_Status |
RedisCreatePropertiesARM
(Appears on:Redis_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2020-12-01/Microsoft.Cache.json#/definitions/RedisCreateProperties
Field | Description |
---|---|
enableNonSslPort bool |
EnableNonSslPort: Specifies whether the non-ssl Redis server port (6379) is enabled. |
minimumTlsVersion RedisCreatePropertiesMinimumTlsVersion |
MinimumTlsVersion: Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, ‘1.0’, ‘1.1’, ‘1.2’). |
publicNetworkAccess RedisCreatePropertiesPublicNetworkAccess |
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 map[string]string |
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. Only major version will be used in PUT/PATCH request with current valid values: (4, 6) |
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 SkuARM |
Sku: SKU parameters supplied to the create Redis operation. |
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 |
|
tenantSettings map[string]string |
TenantSettings: A dictionary of tenant settings |
RedisCreatePropertiesMinimumTlsVersion
(string
alias)
(Appears on:RedisCreatePropertiesARM, Redis_Spec)
Value | Description |
---|---|
"1.0" |
|
"1.1" |
|
"1.2" |
RedisCreatePropertiesPublicNetworkAccess
(string
alias)
(Appears on:RedisCreatePropertiesARM, Redis_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
RedisFirewallRule
Generated from: https://schema.management.azure.com/schemas/2020-12-01/Microsoft.Cache.json#/resourceDefinitions/redis_firewallRules
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||
spec RedisFirewallRules_Spec |
|
||||||||||||
status RedisFirewallRule_Status |
RedisFirewallRulePropertiesARM
(Appears on:RedisFirewallRules_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2020-12-01/Microsoft.Cache.json#/definitions/RedisFirewallRuleProperties
Field | Description |
---|---|
endIP string |
EndIP: highest IP address included in the range |
startIP string |
StartIP: lowest IP address included in the range |
RedisFirewallRuleProperties_StatusARM
(Appears on:RedisFirewallRule_StatusARM)
Field | Description |
---|---|
endIP string |
EndIP: highest IP address included in the range |
startIP string |
StartIP: lowest IP address included in the range |
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_StatusARM
Field | Description |
---|---|
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 |
properties RedisFirewallRuleProperties_StatusARM |
Properties: redis cache firewall rule properties |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
RedisFirewallRules_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 |
location string |
Location: Location to deploy resource to |
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 |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
RedisFirewallRules_SpecARM
Field | Description |
---|---|
location string |
Location: Location to deploy resource to |
name string |
Name: The name of the firewall rule. |
properties RedisFirewallRulePropertiesARM |
Properties: Specifies a range of IP addresses permitted to connect to the cache |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
RedisInstanceDetails_Status
(Appears on:RedisResource_Status)
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. |
RedisInstanceDetails_StatusARM
(Appears on:RedisProperties_StatusARM)
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
Generated from: https://schema.management.azure.com/schemas/2020-12-01/Microsoft.Cache.json#/resourceDefinitions/redis_linkedServers
Field | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||
spec RedisLinkedServers_Spec |
|
||||||||||||||
status RedisLinkedServerWithProperties_Status |
RedisLinkedServerCreatePropertiesARM
(Appears on:RedisLinkedServers_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2020-12-01/Microsoft.Cache.json#/definitions/RedisLinkedServerCreateProperties
Field | Description |
---|---|
linkedRedisCacheId string |
|
linkedRedisCacheLocation string |
LinkedRedisCacheLocation: Location of the linked redis cache. |
serverRole RedisLinkedServerCreatePropertiesServerRole |
ServerRole: Role of the linked server. |
RedisLinkedServerCreatePropertiesServerRole
(string
alias)
(Appears on:RedisLinkedServerCreatePropertiesARM, RedisLinkedServers_Spec)
Value | Description |
---|---|
"Primary" |
|
"Secondary" |
RedisLinkedServerPropertiesStatusServerRole
(string
alias)
(Appears on:RedisLinkedServerProperties_StatusARM, RedisLinkedServerWithProperties_Status)
Value | Description |
---|---|
"Primary" |
|
"Secondary" |
RedisLinkedServerProperties_StatusARM
(Appears on:RedisLinkedServerWithProperties_StatusARM)
Field | Description |
---|---|
linkedRedisCacheId string |
LinkedRedisCacheId: Fully qualified resourceId of the linked redis cache. |
linkedRedisCacheLocation string |
LinkedRedisCacheLocation: Location of the linked redis cache. |
provisioningState string |
ProvisioningState: Terminal state of the link between primary and secondary redis cache. |
serverRole RedisLinkedServerPropertiesStatusServerRole |
ServerRole: Role of the linked server. |
RedisLinkedServerWithProperties_Status
(Appears on:RedisLinkedServer)
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> |
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 |
provisioningState string |
ProvisioningState: Terminal state of the link between primary and secondary redis cache. |
serverRole RedisLinkedServerPropertiesStatusServerRole |
ServerRole: Role of the linked server. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
RedisLinkedServerWithProperties_StatusARM
Field | Description |
---|---|
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 |
properties RedisLinkedServerProperties_StatusARM |
Properties: Properties of the linked server. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
RedisLinkedServer_Status
(Appears on:RedisResource_Status)
Field | Description |
---|---|
id string |
Id: Linked server Id. |
RedisLinkedServer_StatusARM
(Appears on:RedisProperties_StatusARM)
Field | Description |
---|---|
id string |
Id: Linked server Id. |
RedisLinkedServers_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. |
location string |
Location: Location to deploy resource to |
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 RedisLinkedServerCreatePropertiesServerRole |
ServerRole: Role of the linked server. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
RedisLinkedServers_SpecARM
Field | Description |
---|---|
location string |
Location: Location to deploy resource to |
name string |
Name: The name of the linked server that is being added to the Redis cache. |
properties RedisLinkedServerCreatePropertiesARM |
Properties: Create properties for a linked server |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
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 |
---|---|
secrets RedisOperatorSecrets |
Secrets: configures where to place Azure generated secrets. |
RedisPatchSchedule
Generated from: https://schema.management.azure.com/schemas/2020-12-01/Microsoft.Cache.json#/resourceDefinitions/redis_patchSchedules
Field | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||
spec RedisPatchSchedules_Spec |
|
||||||||
status RedisPatchSchedule_Status |
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_StatusARM
Field | Description |
---|---|
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 |
properties ScheduleEntries_StatusARM |
Properties: 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” |
RedisPatchSchedules_Spec
(Appears on:RedisPatchSchedule)
Field | Description |
---|---|
location string |
Location: Location to deploy resource to |
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. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
RedisPatchSchedules_SpecARM
Field | Description |
---|---|
location string |
Location: Location to deploy resource to |
name string |
Name: Default string modeled as parameter for auto generation to work correctly. |
properties ScheduleEntriesARM |
Properties: List of patch schedules for a Redis cache. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
RedisPropertiesStatusMinimumTlsVersion
(string
alias)
(Appears on:RedisProperties_StatusARM, RedisResource_Status)
Value | Description |
---|---|
"1.0" |
|
"1.1" |
|
"1.2" |
RedisPropertiesStatusProvisioningState
(string
alias)
(Appears on:RedisProperties_StatusARM, RedisResource_Status)
Value | Description |
---|---|
"Creating" |
|
"Deleting" |
|
"Disabled" |
|
"Failed" |
|
"Linking" |
|
"Provisioning" |
|
"RecoveringScaleFailure" |
|
"Scaling" |
|
"Succeeded" |
|
"Unlinking" |
|
"Unprovisioning" |
|
"Updating" |
RedisPropertiesStatusPublicNetworkAccess
(string
alias)
(Appears on:RedisProperties_StatusARM, RedisResource_Status)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
RedisProperties_StatusARM
(Appears on:RedisResource_StatusARM)
Field | Description |
---|---|
enableNonSslPort bool |
EnableNonSslPort: Specifies whether the non-ssl Redis server port (6379) is enabled. |
hostName string |
HostName: Redis host name. |
instances []RedisInstanceDetails_StatusARM |
Instances: List of the Redis instances associated with the cache |
linkedServers []RedisLinkedServer_StatusARM |
LinkedServers: List of the linked servers associated with the cache |
minimumTlsVersion RedisPropertiesStatusMinimumTlsVersion |
MinimumTlsVersion: Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, ‘1.0’, ‘1.1’, ‘1.2’) |
port int |
Port: Redis non-SSL port. |
privateEndpointConnections []PrivateEndpointConnection_Status_SubResourceEmbeddedARM |
PrivateEndpointConnections: List of private endpoint connection associated with the specified redis cache |
provisioningState RedisPropertiesStatusProvisioningState |
ProvisioningState: Redis instance provisioning status. |
publicNetworkAccess RedisPropertiesStatusPublicNetworkAccess |
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 map[string]string |
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. Only major version will be used in PUT/PATCH request with current valid values: (4, 6) |
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_StatusARM |
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> |
tenantSettings map[string]string |
TenantSettings: A dictionary of tenant settings |
RedisResource_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> |
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 RedisPropertiesStatusMinimumTlsVersion |
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_SubResourceEmbedded |
PrivateEndpointConnections: List of private endpoint connection associated with the specified redis cache |
provisioningState RedisPropertiesStatusProvisioningState |
ProvisioningState: Redis instance provisioning status. |
publicNetworkAccess RedisPropertiesStatusPublicNetworkAccess |
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 map[string]string |
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. Only major version will be used in PUT/PATCH request with current valid values: (4, 6) |
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” |
zones []string |
Zones: A list of availability zones denoting where the resource needs to come from. |
RedisResource_StatusARM
Field | Description |
---|---|
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 |
properties RedisProperties_StatusARM |
Properties: Redis cache properties. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
zones []string |
Zones: 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. |
location string |
Location: The geo-location where the resource lives |
minimumTlsVersion RedisCreatePropertiesMinimumTlsVersion |
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 RedisCreatePropertiesPublicNetworkAccess |
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 map[string]string |
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. Only major version will be used in PUT/PATCH request with current valid values: (4, 6) |
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: SKU parameters supplied to the create Redis operation. |
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: Name-value pairs to add to the resource |
tenantSettings map[string]string |
TenantSettings: A dictionary of tenant settings |
zones []string |
Zones: A list of availability zones denoting where the resource needs to come from. |
Redis_SpecARM
Field | Description |
---|---|
location string |
Location: The geo-location where the resource lives |
name string |
Name: The name of the Redis cache. |
properties RedisCreatePropertiesARM |
Properties: Properties supplied to Create Redis operation. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
zones []string |
Zones: A list of availability zones denoting where the resource needs to come from. |
ScheduleEntriesARM
(Appears on:RedisPatchSchedules_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2020-12-01/Microsoft.Cache.json#/definitions/ScheduleEntries
Field | Description |
---|---|
scheduleEntries []ScheduleEntryARM |
ScheduleEntries: List of patch schedules for a Redis cache. |
ScheduleEntries_StatusARM
(Appears on:RedisPatchSchedule_StatusARM)
Field | Description |
---|---|
scheduleEntries []ScheduleEntry_StatusARM |
ScheduleEntries: List of patch schedules for a Redis cache. |
ScheduleEntry
(Appears on:RedisPatchSchedules_Spec)
Generated from: https://schema.management.azure.com/schemas/2020-12-01/Microsoft.Cache.json#/definitions/ScheduleEntry
Field | Description |
---|---|
dayOfWeek ScheduleEntryDayOfWeek |
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. |
ScheduleEntryARM
(Appears on:ScheduleEntriesARM)
Generated from: https://schema.management.azure.com/schemas/2020-12-01/Microsoft.Cache.json#/definitions/ScheduleEntry
Field | Description |
---|---|
dayOfWeek ScheduleEntryDayOfWeek |
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. |
ScheduleEntryDayOfWeek
(string
alias)
(Appears on:ScheduleEntry, ScheduleEntryARM)
Value | Description |
---|---|
"Everyday" |
|
"Friday" |
|
"Monday" |
|
"Saturday" |
|
"Sunday" |
|
"Thursday" |
|
"Tuesday" |
|
"Wednesday" |
|
"Weekend" |
ScheduleEntryStatusDayOfWeek
(string
alias)
(Appears on:ScheduleEntry_Status, ScheduleEntry_StatusARM)
Value | Description |
---|---|
"Everyday" |
|
"Friday" |
|
"Monday" |
|
"Saturday" |
|
"Sunday" |
|
"Thursday" |
|
"Tuesday" |
|
"Wednesday" |
|
"Weekend" |
ScheduleEntry_Status
(Appears on:RedisPatchSchedule_Status)
Field | Description |
---|---|
dayOfWeek ScheduleEntryStatusDayOfWeek |
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_StatusARM
(Appears on:ScheduleEntries_StatusARM)
Field | Description |
---|---|
dayOfWeek ScheduleEntryStatusDayOfWeek |
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)
Generated from: https://schema.management.azure.com/schemas/2020-12-01/Microsoft.Cache.json#/definitions/Sku
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 SkuFamily |
Family: The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). |
name SkuName |
Name: The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium). |
SkuARM
(Appears on:RedisCreatePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2020-12-01/Microsoft.Cache.json#/definitions/Sku
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 SkuFamily |
Family: The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). |
name SkuName |
Name: The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium). |
SkuFamily
(string
alias)
Value | Description |
---|---|
"C" |
|
"P" |
SkuName
(string
alias)
Value | Description |
---|---|
"Basic" |
|
"Premium" |
|
"Standard" |
SkuStatusFamily
(string
alias)
(Appears on:Sku_Status, Sku_StatusARM)
Value | Description |
---|---|
"C" |
|
"P" |
SkuStatusName
(string
alias)
(Appears on:Sku_Status, Sku_StatusARM)
Value | Description |
---|---|
"Basic" |
|
"Premium" |
|
"Standard" |
Sku_Status
(Appears on:RedisResource_Status)
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 SkuStatusFamily |
Family: The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). |
name SkuStatusName |
Name: The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) |
Sku_StatusARM
(Appears on:RedisProperties_StatusARM)
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 SkuStatusFamily |
Family: The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). |
name SkuStatusName |
Name: The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) |