Package-level declarations

Types

data class ClusterPropertiesResponseCustomerManagedKeyEncryption(val keyEncryptionKeyIdentity: ClusterPropertiesResponseKeyEncryptionKeyIdentity? = null, val keyEncryptionKeyUrl: String? = null)

All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption.

Link copied to clipboard

Encryption-at-rest configuration for the cluster.

data class ClusterPropertiesResponseKeyEncryptionKeyIdentity(val identityType: String? = null, val userAssignedIdentityResourceId: String? = null)

All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.

Link copied to clipboard
data class DatabasePropertiesResponseGeoReplication(val groupNickname: String? = null, val linkedDatabases: List<LinkedDatabaseResponse>? = null)

Optional set of properties to configure geo replication for this database.

Link copied to clipboard
data class EnterpriseSkuResponse(val capacity: Int? = null, val name: String)

SKU parameters supplied to the create RedisEnterprise operation.

Link copied to clipboard
data class GetAccessPolicyAssignmentResult(val accessPolicyName: String, val id: String, val name: String, val objectId: String, val objectIdAlias: String, val provisioningState: String, val type: String)

Response to an operation on access policy assignment

Link copied to clipboard
data class GetAccessPolicyResult(val id: String, val name: String, val permissions: String, val provisioningState: String, val type: String)

Response to get/put access policy.

Link copied to clipboard
data class GetDatabaseResult(val clientProtocol: String? = null, val clusteringPolicy: String? = null, val evictionPolicy: String? = null, val geoReplication: DatabasePropertiesResponseGeoReplication? = null, val id: String, val modules: List<ModuleResponse>? = null, val name: String, val persistence: PersistenceResponse? = null, val port: Int? = null, val provisioningState: String, val resourceState: String, val systemData: SystemDataResponse, val type: String)

Describes a database on the RedisEnterprise cluster

data class GetEnterprisePrivateEndpointConnectionResult(val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

The Private Endpoint Connection resource.

Link copied to clipboard
data class GetFirewallRuleResult(val endIP: String, val id: String, val name: String, val startIP: String, val type: String)

A firewall rule on a redis cache has a name, and describes a contiguous range of IP addresses permitted to connect

Link copied to clipboard
data class GetLinkedServerResult(val geoReplicatedPrimaryHostName: String, val id: String, val linkedRedisCacheId: String, val linkedRedisCacheLocation: String, val name: String, val primaryHostName: String, val provisioningState: String, val serverRole: String, val type: String)

Response to put/get linked server (with properties) for Redis cache.

Link copied to clipboard
data class GetPatchScheduleResult(val id: String, val location: String, val name: String, val scheduleEntries: List<ScheduleEntryResponse>, val type: String)

Response to put/get patch schedules for Redis cache.

Link copied to clipboard
data class GetPrivateEndpointConnectionResult(val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val type: String)

The Private Endpoint Connection resource.

Link copied to clipboard
data class GetRedisEnterpriseResult(val encryption: ClusterPropertiesResponseEncryption? = null, val hostName: String, val id: String, val identity: ManagedServiceIdentityResponse? = null, val location: String, val minimumTlsVersion: String? = null, val name: String, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>, val provisioningState: String, val redisVersion: String, val resourceState: String, val sku: EnterpriseSkuResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val zones: List<String>? = null)

Describes the RedisEnterprise cluster

Link copied to clipboard
data class GetRedisResult(val accessKeys: RedisAccessKeysResponse, 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 zones: List<String>? = null)

A single Redis item in List or Get Operation.

Link copied to clipboard
data class LinkedDatabaseResponse(val id: String? = null, val state: String)

Specifies details of a linked database resource.

Link copied to clipboard
data class ListDatabaseKeysResult(val primaryKey: String, val secondaryKey: String)

The secret access keys used for authenticating connections to redis

Link copied to clipboard
data class ListRedisKeysResult(val primaryKey: String, val secondaryKey: String)

Redis cache access keys.

Link copied to clipboard
data class ManagedServiceIdentityResponse(val principalId: String, val tenantId: String, val type: String, val userAssignedIdentities: Map<String, UserAssignedIdentityResponse>? = null)

Managed service identity (system assigned and/or user assigned identities)

Link copied to clipboard
data class ModuleResponse(val args: String? = null, val name: String, val version: String)

Specifies configuration of a redis module

Link copied to clipboard
data class PersistenceResponse(val aofEnabled: Boolean? = null, val aofFrequency: String? = null, val rdbEnabled: Boolean? = null, val rdbFrequency: String? = null)

Persistence-related configuration for the RedisEnterprise database

Link copied to clipboard
data class PrivateEndpointConnectionResponse(val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

The Private Endpoint Connection resource.

Link copied to clipboard
data class PrivateEndpointResponse(val id: String)

The Private Endpoint resource.

data class PrivateLinkServiceConnectionStateResponse(val actionsRequired: String? = null, val description: String? = null, val status: String? = null)

A collection of information about the state of the connection between service consumer and provider.

Link copied to clipboard
data class RedisAccessKeysResponse(val primaryKey: String, val secondaryKey: String)

Redis cache access keys.

data class RedisCommonPropertiesResponseRedisConfiguration(val aofBackupEnabled: String? = null, val aofStorageConnectionString0: String? = null, val aofStorageConnectionString1: String? = null, val authnotrequired: String? = null, val maxclients: String, val maxfragmentationmemoryReserved: String? = null, val maxmemoryDelta: String? = null, val maxmemoryPolicy: String? = null, val maxmemoryReserved: String? = null, val preferredDataArchiveAuthMethod: String, val preferredDataPersistenceAuthMethod: String? = null, val rdbBackupEnabled: String? = null, val rdbBackupFrequency: String? = null, val rdbBackupMaxSnapshotCount: String? = null, val rdbStorageConnectionString: String? = null, val storageSubscriptionId: String? = null, val zonalConfiguration: String)

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.

Link copied to clipboard
data class RedisInstanceDetailsResponse(val isMaster: Boolean, val isPrimary: Boolean, val nonSslPort: Int, val shardId: Int, val sslPort: Int, val zone: String)

Details of single instance of redis.

Link copied to clipboard
data class RedisLinkedServerResponse(val id: String)

Linked server Id

Link copied to clipboard
data class ScheduleEntryResponse(val dayOfWeek: String, val maintenanceWindow: String? = null, val startHourUtc: Int)

Patch schedule entry for a Premium Redis Cache.

Link copied to clipboard
data class SkuResponse(val capacity: Int, val family: String, val name: String)

SKU parameters supplied to the create Redis operation.

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class UserAssignedIdentityResponse(val clientId: String, val principalId: String)

User assigned identity properties