azure.mgmt.redis.models module

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

Bases: msrest.serialization.Model

SKU parameters supplied to the create Redis operation.

Parameters:
  • name (str or SkuName) – The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium). Possible values include: ‘Basic’, ‘Standard’, ‘Premium’
  • family (str or SkuFamily) – The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). Possible values include: ‘C’, ‘P’
  • capacity (int) – 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.Resource(location, tags=None)[source]

Bases: msrest.serialization.Model

The Resource definition.

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

Variables:
Parameters:
  • location (str) – Resource location.
  • tags (dict) – Resource tags.
class azure.mgmt.redis.models.RedisCreateParameters(location, sku, tags=None, redis_configuration=None, enable_non_ssl_port=None, tenant_settings=None, shard_count=None, subnet_id=None, static_ip=None)[source]

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

Parameters supplied to the Create Redis operation.

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

Variables:
Parameters:
  • location (str) – Resource location.
  • tags (dict) – Resource tags.
  • redis_configuration (dict) – 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) – tenantSettings
  • shard_count (int) – The number of shards to be created on a Premium Cluster Cache.
  • subnet_id (str) – The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subid}/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.
  • sku (Sku) – The SKU of the Redis cache to deploy.
class azure.mgmt.redis.models.RedisUpdateParameters(redis_configuration=None, enable_non_ssl_port=None, tenant_settings=None, shard_count=None, subnet_id=None, static_ip=None, sku=None, tags=None)[source]

Bases: msrest.serialization.Model

Parameters supplied to the Update Redis operation.

Parameters:
  • redis_configuration (dict) – 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) – tenantSettings
  • shard_count (int) – The number of shards to be created on a Premium Cluster Cache.
  • subnet_id (str) – The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subid}/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.
  • sku (Sku) – The SKU of the Redis cache to deploy.
  • tags (dict) – Resource tags.
class azure.mgmt.redis.models.RedisAccessKeys[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.RedisFirewallRule(start_ip, end_ip)[source]

Bases: msrest.serialization.Model

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.

Variables:
  • id (str) – resource ID (of the firewall rule)
  • name (str) – name of the firewall rule
  • type (str) – type (of the firewall rule resource = ‘Microsoft.Cache/redis/firewallRule’)
Parameters:
  • start_ip (str) – lowest IP address included in the range
  • end_ip (str) – highest IP address included in the range
class azure.mgmt.redis.models.RedisResource(location, tags=None, redis_configuration=None, enable_non_ssl_port=None, tenant_settings=None, shard_count=None, subnet_id=None, static_ip=None, sku=None)[source]

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

A single Redis item in List or Get Operation.

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.
  • redis_version (str) – Redis version.
  • provisioning_state (str) – Redis instance provisioning status.
  • 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
Parameters:
  • location (str) – Resource location.
  • tags (dict) – Resource tags.
  • redis_configuration (dict) – 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) – tenantSettings
  • shard_count (int) – The number of shards to be created on a Premium Cluster Cache.
  • subnet_id (str) – The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subid}/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.
  • sku (Sku) – The SKU of the Redis cache to deploy.
class azure.mgmt.redis.models.RedisRegenerateKeyParameters(key_type)[source]

Bases: msrest.serialization.Model

Specifies which Redis access keys to reset.

Parameters:key_type (str or RedisKeyType) – The Redis access key to regenerate. Possible values include: ‘Primary’, ‘Secondary’
class azure.mgmt.redis.models.RedisRebootParameters(reboot_type, shard_id=None)[source]

Bases: msrest.serialization.Model

Specifies which Redis node(s) to reboot.

Parameters:
  • reboot_type (str or RebootType) – 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, container, format=None)[source]

Bases: msrest.serialization.Model

Parameters for Redis export operation.

Parameters:
  • format (str) – File format.
  • prefix (str) – Prefix to use for exported files.
  • container (str) – Container name to export to.
class azure.mgmt.redis.models.ImportRDBParameters(files, format=None)[source]

Bases: msrest.serialization.Model

Parameters for Redis import operation.

Parameters:
  • format (str) – File format.
  • files (list of str) – files to import.
class azure.mgmt.redis.models.ScheduleEntry(day_of_week, start_hour_utc, maintenance_window=None)[source]

Bases: msrest.serialization.Model

Patch schedule entry for a Premium Redis Cache.

Parameters:
  • day_of_week (str or DayOfWeek) – 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) – 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)[source]

Bases: msrest.serialization.Model

Response to put/get patch schedules for Redis cache.

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.
  • location (str) – Resource location.
Parameters:

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

class azure.mgmt.redis.models.RedisForceRebootResponse[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.OperationDisplay(provider=None, operation=None, resource=None, description=None)[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=None, display=None)[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.OperationPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Operation object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of RedisResource object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of RedisFirewallRule object

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

Bases: enum.Enum

An enumeration.

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

Bases: enum.Enum

An enumeration.

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

Bases: enum.Enum

An enumeration.

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

Bases: enum.Enum

An enumeration.

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

Bases: enum.Enum

An enumeration.

everyday = 'Everyday'
friday = 'Friday'
monday = 'Monday'
saturday = 'Saturday'
sunday = 'Sunday'
thursday = 'Thursday'
tuesday = 'Tuesday'
wednesday = 'Wednesday'
weekend = 'Weekend'