azure.mgmt.redis.models module

class azure.mgmt.redis.models.Sku(*, name, family, capacity: int, **kwargs)[source]

Bases: msrest.serialization.Model

SKU parameters supplied to the create Redis operation.

All required parameters must be populated in order to send to Azure.

Parameters

  • name (str or SkuName) – Required. The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium). Possible values include: ‘Basic’, ‘Standard’, ‘Premium’

  • family (str or SkuFamily) – Required. The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). Possible values include: ‘C’, ‘P’

  • capacity (int) – Required. 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).

class azure.mgmt.redis.models.RedisAccessKeys(**kwargs)[source]

Bases: msrest.serialization.Model

Redis cache access keys.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • primary_key (str) – The current primary key that clients can use to authenticate with Redis cache.

  • secondary_key (str) – The current secondary key that clients can use to authenticate with Redis cache.

class azure.mgmt.redis.models.RedisLinkedServer(**kwargs)[source]

Bases: msrest.serialization.Model

Linked server Id.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Linked server Id.

class azure.mgmt.redis.models.Resource(**kwargs)[source]

Bases: msrest.serialization.Model

The Resource definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – Resource ID.

  • name (str) – Resource name.

  • type (str) – Resource type.

class azure.mgmt.redis.models.ProxyResource(**kwargs)[source]

Bases: azure.mgmt.redis.models.resource_py3.Resource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – Resource ID.

  • name (str) – Resource name.

  • type (str) – Resource type.

class azure.mgmt.redis.models.TrackedResource(*, location: str, tags=None, **kwargs)[source]

Bases: azure.mgmt.redis.models.resource_py3.Resource

The resource model definition for a ARM tracked top level resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Resource ID.

  • name (str) – Resource name.

  • type (str) – Resource type.

Parameters

  • tags (dict[str, str]) – Resource tags.

  • location (str) – Required. The geo-location where the resource lives

class azure.mgmt.redis.models.RedisCreateParameters(*, sku, location: str, redis_configuration=None, enable_non_ssl_port: bool = None, tenant_settings=None, shard_count: int = None, minimum_tls_version=None, subnet_id: str = None, static_ip: str = None, zones=None, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

Parameters supplied to the Create Redis operation.

All required parameters must be populated in order to send to Azure.

Parameters

  • redis_configuration (dict[str, str]) – 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.

  • enable_non_ssl_port (bool) – Specifies whether the non-ssl Redis server port (6379) is enabled.

  • tenant_settings (dict[str, str]) – A dictionary of tenant settings

  • shard_count (int) – The number of shards to be created on a Premium Cluster Cache.

  • minimum_tls_version (str or TlsVersion) – Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, ‘1.0’, ‘1.1’, ‘1.2’). Possible values include: ‘1.0’, ‘1.1’, ‘1.2’

  • sku (Sku) – Required. The SKU of the Redis cache to deploy.

  • subnet_id (str) – 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

  • static_ip (str) – Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.

  • zones (list[str]) – A list of availability zones denoting where the resource needs to come from.

  • location (str) – Required. The geo-location where the resource lives

  • tags (dict[str, str]) – Resource tags.

class azure.mgmt.redis.models.RedisUpdateParameters(*, redis_configuration=None, enable_non_ssl_port: bool = None, tenant_settings=None, shard_count: int = None, minimum_tls_version=None, sku=None, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

Parameters supplied to the Update Redis operation.

Parameters

  • redis_configuration (dict[str, str]) – 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.

  • enable_non_ssl_port (bool) – Specifies whether the non-ssl Redis server port (6379) is enabled.

  • tenant_settings (dict[str, str]) – A dictionary of tenant settings

  • shard_count (int) – The number of shards to be created on a Premium Cluster Cache.

  • minimum_tls_version (str or TlsVersion) – Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, ‘1.0’, ‘1.1’, ‘1.2’). Possible values include: ‘1.0’, ‘1.1’, ‘1.2’

  • sku (Sku) – The SKU of the Redis cache to deploy.

  • tags (dict[str, str]) – Resource tags.

class azure.mgmt.redis.models.RedisFirewallRule(*, start_ip: str, end_ip: str, **kwargs)[source]

Bases: azure.mgmt.redis.models.proxy_resource_py3.ProxyResource

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Resource ID.

  • name (str) – Resource name.

  • type (str) – Resource type.

Parameters

  • start_ip (str) – Required. lowest IP address included in the range

  • end_ip (str) – Required. highest IP address included in the range

class azure.mgmt.redis.models.RedisFirewallRuleCreateParameters(*, start_ip: str, end_ip: str, **kwargs)[source]

Bases: msrest.serialization.Model

Parameters required for creating a firewall rule on redis cache.

All required parameters must be populated in order to send to Azure.

Parameters

  • start_ip (str) – Required. lowest IP address included in the range

  • end_ip (str) – Required. highest IP address included in the range

class azure.mgmt.redis.models.RedisResource(*, location: str, sku, tags=None, redis_configuration=None, enable_non_ssl_port: bool = None, tenant_settings=None, shard_count: int = None, minimum_tls_version=None, subnet_id: str = None, static_ip: str = None, zones=None, **kwargs)[source]

Bases: azure.mgmt.redis.models.tracked_resource_py3.TrackedResource

A single Redis item in List or Get Operation.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Resource ID.

  • name (str) – Resource name.

  • type (str) – Resource type.

  • redis_version (str) – Redis version.

  • provisioning_state (str or ProvisioningState) – Redis instance provisioning status. Possible values include: ‘Creating’, ‘Deleting’, ‘Disabled’, ‘Failed’, ‘Linking’, ‘Provisioning’, ‘RecoveringScaleFailure’, ‘Scaling’, ‘Succeeded’, ‘Unlinking’, ‘Unprovisioning’, ‘Updating’

  • host_name (str) – Redis host name.

  • port (int) – Redis non-SSL port.

  • ssl_port (int) – Redis SSL port.

  • access_keys (RedisAccessKeys) – The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache

  • linked_servers (list[RedisLinkedServer]) – List of the linked servers associated with the cache

Parameters

  • tags (dict[str, str]) – Resource tags.

  • location (str) – Required. The geo-location where the resource lives

  • redis_configuration (dict[str, str]) – 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.

  • enable_non_ssl_port (bool) – Specifies whether the non-ssl Redis server port (6379) is enabled.

  • tenant_settings (dict[str, str]) – A dictionary of tenant settings

  • shard_count (int) – The number of shards to be created on a Premium Cluster Cache.

  • minimum_tls_version (str or TlsVersion) – Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, ‘1.0’, ‘1.1’, ‘1.2’). Possible values include: ‘1.0’, ‘1.1’, ‘1.2’

  • sku (Sku) – Required. The SKU of the Redis cache to deploy.

  • subnet_id (str) – 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

  • static_ip (str) – Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.

  • zones (list[str]) – A list of availability zones denoting where the resource needs to come from.

class azure.mgmt.redis.models.RedisRegenerateKeyParameters(*, key_type, **kwargs)[source]

Bases: msrest.serialization.Model

Specifies which Redis access keys to reset.

All required parameters must be populated in order to send to Azure.

Parameters

key_type (str or RedisKeyType) – Required. The Redis access key to regenerate. Possible values include: ‘Primary’, ‘Secondary’

class azure.mgmt.redis.models.RedisRebootParameters(*, reboot_type, shard_id: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

Specifies which Redis node(s) to reboot.

All required parameters must be populated in order to send to Azure.

Parameters

  • reboot_type (str or RebootType) – Required. Which Redis node(s) to reboot. Depending on this value data loss is possible. Possible values include: ‘PrimaryNode’, ‘SecondaryNode’, ‘AllNodes’

  • shard_id (int) – If clustering is enabled, the ID of the shard to be rebooted.

class azure.mgmt.redis.models.ExportRDBParameters(*, prefix: str, container: str, format: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Parameters for Redis export operation.

All required parameters must be populated in order to send to Azure.

Parameters

  • format (str) – File format.

  • prefix (str) – Required. Prefix to use for exported files.

  • container (str) – Required. Container name to export to.

class azure.mgmt.redis.models.ImportRDBParameters(*, files, format: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Parameters for Redis import operation.

All required parameters must be populated in order to send to Azure.

Parameters

  • format (str) – File format.

  • files (list[str]) – Required. files to import.

class azure.mgmt.redis.models.ScheduleEntry(*, day_of_week, start_hour_utc: int, maintenance_window=None, **kwargs)[source]

Bases: msrest.serialization.Model

Patch schedule entry for a Premium Redis Cache.

All required parameters must be populated in order to send to Azure.

Parameters

  • day_of_week (str or DayOfWeek) – Required. Day of the week when a cache can be patched. Possible values include: ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’, ‘Saturday’, ‘Sunday’, ‘Everyday’, ‘Weekend’

  • start_hour_utc (int) – Required. Start hour after which cache patching can start.

  • maintenance_window (timedelta) – ISO8601 timespan specifying how much time cache patching can take.

class azure.mgmt.redis.models.RedisPatchSchedule(*, schedule_entries, **kwargs)[source]

Bases: azure.mgmt.redis.models.proxy_resource_py3.ProxyResource

Response to put/get patch schedules for Redis cache.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Resource ID.

  • name (str) – Resource name.

  • type (str) – Resource type.

Parameters

schedule_entries (list[ScheduleEntry]) – Required. List of patch schedules for a Redis cache.

class azure.mgmt.redis.models.RedisForceRebootResponse(**kwargs)[source]

Bases: msrest.serialization.Model

Response to force reboot for Redis cache.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

message (str) – Status message

class azure.mgmt.redis.models.RedisLinkedServerWithProperties(*, linked_redis_cache_id: str, linked_redis_cache_location: str, server_role, **kwargs)[source]

Bases: azure.mgmt.redis.models.proxy_resource_py3.ProxyResource

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Resource ID.

  • name (str) – Resource name.

  • type (str) – Resource type.

  • provisioning_state (str) – Terminal state of the link between primary and secondary redis cache.

Parameters

  • linked_redis_cache_id (str) – Required. Fully qualified resourceId of the linked redis cache.

  • linked_redis_cache_location (str) – Required. Location of the linked redis cache.

  • server_role (str or ReplicationRole) – Required. Role of the linked server. Possible values include: ‘Primary’, ‘Secondary’

class azure.mgmt.redis.models.RedisLinkedServerCreateParameters(*, linked_redis_cache_id: str, linked_redis_cache_location: str, server_role, **kwargs)[source]

Bases: msrest.serialization.Model

Parameter required for creating a linked server to redis cache.

All required parameters must be populated in order to send to Azure.

Parameters

  • linked_redis_cache_id (str) – Required. Fully qualified resourceId of the linked redis cache.

  • linked_redis_cache_location (str) – Required. Location of the linked redis cache.

  • server_role (str or ReplicationRole) – Required. Role of the linked server. Possible values include: ‘Primary’, ‘Secondary’

class azure.mgmt.redis.models.OperationDisplay(*, provider: str = None, operation: str = None, resource: str = None, description: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The object that describes the operation.

Parameters

  • provider (str) – Friendly name of the resource provider

  • operation (str) – Operation type: read, write, delete, listKeys/action, etc.

  • resource (str) – Resource type on which the operation is performed.

  • description (str) – Friendly name of the operation

class azure.mgmt.redis.models.Operation(*, name: str = None, display=None, **kwargs)[source]

Bases: msrest.serialization.Model

REST API operation.

Parameters

  • name (str) – Operation name: {provider}/{resource}/{operation}

  • display (OperationDisplay) – The object that describes the operation.

class azure.mgmt.redis.models.CheckNameAvailabilityParameters(*, name: str, type: str, **kwargs)[source]

Bases: msrest.serialization.Model

Parameters body to pass for resource name availability check.

All required parameters must be populated in order to send to Azure.

Parameters

  • name (str) – Required. Resource name.

  • type (str) – Required. Resource type. The only legal value of this property for checking redis cache name availability is ‘Microsoft.Cache/redis’.

class azure.mgmt.redis.models.UpgradeNotification(**kwargs)[source]

Bases: msrest.serialization.Model

Properties of upgrade notification.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • name (str) – Name of upgrade notification.

  • timestamp (datetime) – Timestamp when upgrade notification occurred.

  • upsell_notification (dict[str, str]) – Details about this upgrade notification

class azure.mgmt.redis.models.NotificationListResponse(*, value=None, **kwargs)[source]

Bases: msrest.serialization.Model

The response of listUpgradeNotifications.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

value (list[UpgradeNotification]) – List of all notifications.

Variables

next_link (str) – Link for next set of notifications.

class azure.mgmt.redis.models.OperationPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Operation object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.redis.models.RedisResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of RedisResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.redis.models.RedisFirewallRulePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of RedisFirewallRule object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.redis.models.RedisPatchSchedulePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of RedisPatchSchedule object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.redis.models.RedisLinkedServerWithPropertiesPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of RedisLinkedServerWithProperties object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.redis.models.SkuName[source]

Bases: str, enum.Enum

An enumeration.

basic = 'Basic'
premium = 'Premium'
standard = 'Standard'
class azure.mgmt.redis.models.SkuFamily[source]

Bases: str, enum.Enum

An enumeration.

c = 'C'
p = 'P'
class azure.mgmt.redis.models.TlsVersion[source]

Bases: str, enum.Enum

An enumeration.

one_full_stop_one = '1.1'
one_full_stop_two = '1.2'
one_full_stop_zero = '1.0'
class azure.mgmt.redis.models.ProvisioningState[source]

Bases: str, enum.Enum

An enumeration.

creating = 'Creating'
deleting = 'Deleting'
disabled = 'Disabled'
failed = 'Failed'
linking = 'Linking'
provisioning = 'Provisioning'
recovering_scale_failure = 'RecoveringScaleFailure'
scaling = 'Scaling'
succeeded = 'Succeeded'
unlinking = 'Unlinking'
unprovisioning = 'Unprovisioning'
updating = 'Updating'
class azure.mgmt.redis.models.RedisKeyType[source]

Bases: str, enum.Enum

An enumeration.

primary = 'Primary'
secondary = 'Secondary'
class azure.mgmt.redis.models.RebootType[source]

Bases: str, enum.Enum

An enumeration.

all_nodes = 'AllNodes'
primary_node = 'PrimaryNode'
secondary_node = 'SecondaryNode'
class azure.mgmt.redis.models.DayOfWeek[source]

Bases: str, enum.Enum

An enumeration.

everyday = 'Everyday'
friday = 'Friday'
monday = 'Monday'
saturday = 'Saturday'
sunday = 'Sunday'
thursday = 'Thursday'
tuesday = 'Tuesday'
wednesday = 'Wednesday'
weekend = 'Weekend'
class azure.mgmt.redis.models.ReplicationRole[source]

Bases: str, enum.Enum

An enumeration.

primary = 'Primary'
secondary = 'Secondary'