cache.azure.com/v1api20201201
cache.azure.com/v1api20201201
Package v1api20201201 contains API Schema definitions for the cache v1api20201201 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2020-12-01" |
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> |
PrivateEndpointConnection_STATUS_ARM
(Appears on:RedisProperties_STATUS_ARM)
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/2020-12-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_ARM
(Appears on:Redis_Spec_ARM)
Properties supplied to Create Redis operation.
Field | Description |
---|---|
enableNonSslPort bool |
EnableNonSslPort: Specifies whether the non-ssl Redis server port (6379) is enabled. |
minimumTlsVersion RedisCreateProperties_MinimumTlsVersion_ARM |
MinimumTlsVersion: Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, ‘1.0’, ‘1.1’, ‘1.2’) |
publicNetworkAccess RedisCreateProperties_PublicNetworkAccess_ARM |
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_ARM |
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[.build]]’ (only ‘major’ is required) or the value ‘latest’ which refers to the latest stable Redis version that is available. Only the major and minor version are used in a PUT/PATCH request. Supported versions: 4.0, 6.0. |
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_ARM |
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. |
subnetId string |
|
tenantSettings map[string]string |
TenantSettings: A dictionary of tenant settings |
RedisCreateProperties_MinimumTlsVersion
(string
alias)
(Appears on:Redis_Spec)
Value | Description |
---|---|
"1.0" |
|
"1.1" |
|
"1.2" |
RedisCreateProperties_MinimumTlsVersion_ARM
(string
alias)
(Appears on:RedisCreateProperties_ARM)
Value | Description |
---|---|
"1.0" |
|
"1.1" |
|
"1.2" |
RedisCreateProperties_PublicNetworkAccess
(string
alias)
(Appears on:Redis_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
RedisCreateProperties_PublicNetworkAccess_ARM
(string
alias)
(Appears on:RedisCreateProperties_ARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
RedisCreateProperties_RedisConfiguration
(Appears on:Redis_Spec)
Field | Description |
---|---|
additionalProperties map[string]string |
|
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. |
rdb-backup-enabled string |
RdbBackupEnabled: Specifies whether the rdb backup is enabled |
rdb-backup-frequency string |
RdbBackupFrequency: Specifies the frequency for creating rdb backup |
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 |
RedisCreateProperties_RedisConfiguration_ARM
(Appears on:RedisCreateProperties_ARM)
Field | Description |
---|---|
additionalProperties map[string]string |
|
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. |
rdb-backup-enabled string |
RdbBackupEnabled: Specifies whether the rdb backup is enabled |
rdb-backup-frequency string |
RdbBackupFrequency: Specifies the frequency for creating rdb backup |
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 |
RedisFirewallRule
Generator information: - Generated from: /redis/resource-manager/Microsoft.Cache/stable/2020-12-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 Redis_FirewallRule_Spec |
|
||||||||
status Redis_FirewallRule_STATUS |
RedisFirewallRuleProperties_ARM
(Appears on:Redis_FirewallRule_Spec_ARM)
Specifies a range of IP addresses permitted to connect to the cache
Field | Description |
---|---|
endIP string |
EndIP: highest IP address included in the range |
startIP string |
StartIP: lowest IP address included in the range |
RedisFirewallRuleProperties_STATUS_ARM
(Appears on:Redis_FirewallRule_STATUS_ARM)
Specifies a range of IP addresses permitted to connect to the cache
Field | Description |
---|---|
endIP string |
EndIP: highest IP address included in the range |
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. |
RedisInstanceDetails_STATUS_ARM
(Appears on:RedisProperties_STATUS_ARM)
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/2020-12-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 Redis_LinkedServer_Spec |
|
||||||||||
status Redis_LinkedServer_STATUS |
RedisLinkedServerCreateProperties_ARM
(Appears on:Redis_LinkedServer_Spec_ARM)
Create properties for a linked server
Field | Description |
---|---|
linkedRedisCacheId string |
|
linkedRedisCacheLocation string |
LinkedRedisCacheLocation: Location of the linked redis cache. |
serverRole RedisLinkedServerCreateProperties_ServerRole_ARM |
ServerRole: Role of the linked server. |
RedisLinkedServerCreateProperties_ServerRole
(string
alias)
(Appears on:Redis_LinkedServer_Spec)
Value | Description |
---|---|
"Primary" |
|
"Secondary" |
RedisLinkedServerCreateProperties_ServerRole_ARM
(string
alias)
(Appears on:RedisLinkedServerCreateProperties_ARM)
Value | Description |
---|---|
"Primary" |
|
"Secondary" |
RedisLinkedServerProperties_STATUS_ARM
(Appears on:Redis_LinkedServer_STATUS_ARM)
Properties of a linked server to be returned in get/put response
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 RedisLinkedServerProperties_ServerRole_STATUS_ARM |
ServerRole: Role of the linked server. |
RedisLinkedServerProperties_ServerRole_STATUS
(string
alias)
(Appears on:Redis_LinkedServer_STATUS)
Value | Description |
---|---|
"Primary" |
|
"Secondary" |
RedisLinkedServerProperties_ServerRole_STATUS_ARM
(string
alias)
(Appears on:RedisLinkedServerProperties_STATUS_ARM)
Value | Description |
---|---|
"Primary" |
|
"Secondary" |
RedisLinkedServer_STATUS
(Appears on:Redis_STATUS)
Linked server Id
Field | Description |
---|---|
id string |
Id: Linked server Id. |
RedisLinkedServer_STATUS_ARM
(Appears on:RedisProperties_STATUS_ARM)
Linked server Id
Field | Description |
---|---|
id string |
Id: Linked server Id. |
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
Generator information: - Generated from: /redis/resource-manager/Microsoft.Cache/stable/2020-12-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 Redis_PatchSchedule_Spec |
|
||||
status Redis_PatchSchedule_STATUS |
RedisProperties_MinimumTlsVersion_STATUS
(string
alias)
(Appears on:Redis_STATUS)
Value | Description |
---|---|
"1.0" |
|
"1.1" |
|
"1.2" |
RedisProperties_MinimumTlsVersion_STATUS_ARM
(string
alias)
(Appears on:RedisProperties_STATUS_ARM)
Value | Description |
---|---|
"1.0" |
|
"1.1" |
|
"1.2" |
RedisProperties_ProvisioningState_STATUS
(string
alias)
(Appears on:Redis_STATUS)
Value | Description |
---|---|
"Creating" |
|
"Deleting" |
|
"Disabled" |
|
"Failed" |
|
"Linking" |
|
"Provisioning" |
|
"RecoveringScaleFailure" |
|
"Scaling" |
|
"Succeeded" |
|
"Unlinking" |
|
"Unprovisioning" |
|
"Updating" |
RedisProperties_ProvisioningState_STATUS_ARM
(string
alias)
(Appears on:RedisProperties_STATUS_ARM)
Value | Description |
---|---|
"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_PublicNetworkAccess_STATUS_ARM
(string
alias)
(Appears on:RedisProperties_STATUS_ARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
RedisProperties_RedisConfiguration_STATUS
(Appears on:Redis_STATUS)
Field | Description |
---|---|
additionalProperties map[string]string |
|
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. |
rdb-backup-enabled string |
RdbBackupEnabled: Specifies whether the rdb backup is enabled |
rdb-backup-frequency string |
RdbBackupFrequency: Specifies the frequency for creating rdb backup |
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 |
zonal-configuration string |
ZonalConfiguration: Zonal Configuration |
RedisProperties_RedisConfiguration_STATUS_ARM
(Appears on:RedisProperties_STATUS_ARM)
Field | Description |
---|---|
additionalProperties map[string]string |
|
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. |
rdb-backup-enabled string |
RdbBackupEnabled: Specifies whether the rdb backup is enabled |
rdb-backup-frequency string |
RdbBackupFrequency: Specifies the frequency for creating rdb backup |
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 |
zonal-configuration string |
ZonalConfiguration: Zonal Configuration |
RedisProperties_STATUS_ARM
(Appears on:Redis_STATUS_ARM)
Properties of the redis cache.
Field | Description |
---|---|
enableNonSslPort bool |
EnableNonSslPort: Specifies whether the non-ssl Redis server port (6379) is enabled. |
hostName string |
HostName: Redis host name. |
instances []RedisInstanceDetails_STATUS_ARM |
Instances: List of the Redis instances associated with the cache |
linkedServers []RedisLinkedServer_STATUS_ARM |
LinkedServers: List of the linked servers associated with the cache |
minimumTlsVersion RedisProperties_MinimumTlsVersion_STATUS_ARM |
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_ARM |
PrivateEndpointConnections: List of private endpoint connection associated with the specified redis cache |
provisioningState RedisProperties_ProvisioningState_STATUS_ARM |
ProvisioningState: Redis instance provisioning status. |
publicNetworkAccess RedisProperties_PublicNetworkAccess_STATUS_ARM |
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_ARM |
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[.build]]’ (only ‘major’ is required) or the value ‘latest’ which refers to the latest stable Redis version that is available. Only the major and minor version are used in a PUT/PATCH request. Supported versions: 4.0, 6.0. |
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_ARM |
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 |
Redis_FirewallRule_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” |
Redis_FirewallRule_STATUS_ARM
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_STATUS_ARM |
Properties: redis cache firewall rule properties |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
Redis_FirewallRule_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 |
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 |
Redis_FirewallRule_Spec_ARM
Field | Description |
---|---|
name string |
|
properties RedisFirewallRuleProperties_ARM |
Properties: redis cache firewall rule properties |
Redis_LinkedServer_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 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_LinkedServer_STATUS_ARM
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_STATUS_ARM |
Properties: Properties of the linked server. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
Redis_LinkedServer_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. |
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. |
Redis_LinkedServer_Spec_ARM
Field | Description |
---|---|
name string |
|
properties RedisLinkedServerCreateProperties_ARM |
Properties: Properties required to create a linked server. |
Redis_PatchSchedule_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” |
Redis_PatchSchedule_STATUS_ARM
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_STATUS_ARM |
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” |
Redis_PatchSchedule_Spec
(Appears on:RedisPatchSchedule)
Field | Description |
---|---|
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. |
Redis_PatchSchedule_Spec_ARM
Field | Description |
---|---|
name string |
|
properties ScheduleEntries_ARM |
Properties: List of patch schedules for a Redis cache. |
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> |
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[.build]]’ (only ‘major’ is required) or the value ‘latest’ which refers to the latest stable Redis version that is available. Only the major and minor version are used in a PUT/PATCH request. Supported versions: 4.0, 6.0. |
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. |
Redis_STATUS_ARM
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_STATUS_ARM |
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 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[.build]]’ (only ‘major’ is required) or the value ‘latest’ which refers to the latest stable Redis version that is available. Only the major and minor version are used in a PUT/PATCH request. Supported versions: 4.0, 6.0. |
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 |
zones []string |
Zones: A list of availability zones denoting where the resource needs to come from. |
Redis_Spec_ARM
Field | Description |
---|---|
location string |
Location: The geo-location where the resource lives |
name string |
|
properties RedisCreateProperties_ARM |
Properties: Redis cache properties. |
tags map[string]string |
Tags: Resource tags. |
zones []string |
Zones: A list of availability zones denoting where the resource needs to come from. |
ScheduleEntries_ARM
(Appears on:Redis_PatchSchedule_Spec_ARM)
List of patch schedules for a Redis cache.
Field | Description |
---|---|
scheduleEntries []ScheduleEntry_ARM |
ScheduleEntries: List of patch schedules for a Redis cache. |
ScheduleEntries_STATUS_ARM
(Appears on:Redis_PatchSchedule_STATUS_ARM)
List of patch schedules for a Redis cache.
Field | Description |
---|---|
scheduleEntries []ScheduleEntry_STATUS_ARM |
ScheduleEntries: List of patch schedules for a Redis cache. |
ScheduleEntry
(Appears on:Redis_PatchSchedule_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_ARM
(Appears on:ScheduleEntries_ARM)
Patch schedule entry for a Premium Redis Cache.
Field | Description |
---|---|
dayOfWeek ScheduleEntry_DayOfWeek_ARM |
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_ARM
(string
alias)
(Appears on:ScheduleEntry_ARM)
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_DayOfWeek_STATUS_ARM
(string
alias)
(Appears on:ScheduleEntry_STATUS_ARM)
Value | Description |
---|---|
"Everyday" |
|
"Friday" |
|
"Monday" |
|
"Saturday" |
|
"Sunday" |
|
"Thursday" |
|
"Tuesday" |
|
"Wednesday" |
|
"Weekend" |
ScheduleEntry_STATUS
(Appears on:Redis_PatchSchedule_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. |
ScheduleEntry_STATUS_ARM
(Appears on:ScheduleEntries_STATUS_ARM)
Patch schedule entry for a Premium Redis Cache.
Field | Description |
---|---|
dayOfWeek ScheduleEntry_DayOfWeek_STATUS_ARM |
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_ARM
(Appears on:RedisCreateProperties_ARM)
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_ARM |
Family: The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). |
name Sku_Name_ARM |
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_ARM
(string
alias)
(Appears on:Sku_ARM)
Value | Description |
---|---|
"C" |
|
"P" |
Sku_Family_STATUS
(string
alias)
(Appears on:Sku_STATUS)
Value | Description |
---|---|
"C" |
|
"P" |
Sku_Family_STATUS_ARM
(string
alias)
(Appears on:Sku_STATUS_ARM)
Value | Description |
---|---|
"C" |
|
"P" |
Sku_Name
(string
alias)
(Appears on:Sku)
Value | Description |
---|---|
"Basic" |
|
"Premium" |
|
"Standard" |
Sku_Name_ARM
(string
alias)
(Appears on:Sku_ARM)
Value | Description |
---|---|
"Basic" |
|
"Premium" |
|
"Standard" |
Sku_Name_STATUS
(string
alias)
(Appears on:Sku_STATUS)
Value | Description |
---|---|
"Basic" |
|
"Premium" |
|
"Standard" |
Sku_Name_STATUS_ARM
(string
alias)
(Appears on:Sku_STATUS_ARM)
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) |
Sku_STATUS_ARM
(Appears on:RedisProperties_STATUS_ARM)
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_ARM |
Family: The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). |
name Sku_Name_STATUS_ARM |
Name: The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) |