GetRedisResult

data class GetRedisResult(val accessKeys: RedisAccessKeysResponse, val azureApiVersion: String, val disableAccessKeyAuthentication: Boolean? = null, val enableNonSslPort: Boolean? = null, val hostName: String, val id: String, val identity: ManagedServiceIdentityResponse? = null, val instances: List<RedisInstanceDetailsResponse>, val linkedServers: List<RedisLinkedServerResponse>, val location: String, val minimumTlsVersion: String? = null, val name: String, val port: Int, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>, val provisioningState: String, val publicNetworkAccess: String? = null, val redisConfiguration: RedisCommonPropertiesResponseRedisConfiguration? = null, val redisVersion: String? = null, val replicasPerMaster: Int? = null, val replicasPerPrimary: Int? = null, val shardCount: Int? = null, val sku: SkuResponse, val sslPort: Int, val staticIP: String? = null, val subnetId: String? = null, val tags: Map<String, String>? = null, val tenantSettings: Map<String, String>? = null, val type: String, val updateChannel: String? = null, val zonalAllocationPolicy: String? = null, val zones: List<String>? = null)

A single Redis item in List or Get Operation.

Constructors

Link copied to clipboard
constructor(accessKeys: RedisAccessKeysResponse, azureApiVersion: String, disableAccessKeyAuthentication: Boolean? = null, enableNonSslPort: Boolean? = null, hostName: String, id: String, identity: ManagedServiceIdentityResponse? = null, instances: List<RedisInstanceDetailsResponse>, linkedServers: List<RedisLinkedServerResponse>, location: String, minimumTlsVersion: String? = null, name: String, port: Int, privateEndpointConnections: List<PrivateEndpointConnectionResponse>, provisioningState: String, publicNetworkAccess: String? = null, redisConfiguration: RedisCommonPropertiesResponseRedisConfiguration? = null, redisVersion: String? = null, replicasPerMaster: Int? = null, replicasPerPrimary: Int? = null, shardCount: Int? = null, sku: SkuResponse, sslPort: Int, staticIP: String? = null, subnetId: String? = null, tags: Map<String, String>? = null, tenantSettings: Map<String, String>? = null, type: String, updateChannel: String? = null, zonalAllocationPolicy: String? = null, zones: List<String>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache

Link copied to clipboard

The Azure API version of the resource.

Link copied to clipboard

Authentication to Redis through access keys is disabled when set as true. Default value is false.

Link copied to clipboard

Specifies whether the non-ssl Redis server port (6379) is enabled.

Link copied to clipboard

Redis host name.

Link copied to clipboard
val id: String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Link copied to clipboard

The identity of the resource.

Link copied to clipboard

List of the Redis instances associated with the cache

Link copied to clipboard

List of the linked servers associated with the cache

Link copied to clipboard

The geo-location where the resource lives

Link copied to clipboard

Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')

Link copied to clipboard

The name of the resource

Link copied to clipboard
val port: Int

Redis non-SSL port.

Link copied to clipboard

List of private endpoint connection associated with the specified redis cache

Link copied to clipboard

Redis instance provisioning status.

Link copied to clipboard

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'

Link copied to clipboard

All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta, maxmemory-policy,notify-keyspace-events, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 etc.

Link copied to clipboard
val redisVersion: String? = null

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'.

Link copied to clipboard
val replicasPerMaster: Int? = null

The number of replicas to be created per primary.

Link copied to clipboard
val replicasPerPrimary: Int? = null

The number of replicas to be created per primary.

Link copied to clipboard
val shardCount: Int? = null

The number of shards to be created on a Premium Cluster Cache.

Link copied to clipboard

The SKU of the Redis cache to deploy.

Link copied to clipboard

Redis SSL port.

Link copied to clipboard
val staticIP: String? = null

Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default.

Link copied to clipboard
val subnetId: String? = null

The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1

Link copied to clipboard
val tags: Map<String, String>? = null

Resource tags.

Link copied to clipboard

A dictionary of tenant settings

Link copied to clipboard

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Link copied to clipboard
val updateChannel: String? = null

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'.

Link copied to clipboard

Optional: Specifies how availability zones are allocated to the Redis cache. 'Automatic' enables zone redundancy and Azure will automatically select zones based on regional availability and capacity. 'UserDefined' will select availability zones passed in by you using the 'zones' parameter. 'NoZones' will produce a non-zonal cache. If 'zonalAllocationPolicy' is not passed, it will be set to 'UserDefined' when zones are passed in, otherwise, it will be set to 'Automatic' in regions where zones are supported and 'NoZones' in regions where zones are not supported.

Link copied to clipboard
val zones: List<String>? = null

A list of availability zones denoting where the resource needs to come from.