azure.mgmt.redis.operations module

class azure.mgmt.redis.operations.Operations(client, config, serializer, deserializer)[source]

Bases: object

Operations operations.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client Api Version. Constant value: “2018-03-01”.

list(custom_headers=None, raw=False, **operation_config)[source]

Lists all of the available REST API operations of the Microsoft.Cache provider.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of Operation

Return type

OperationPaged[Operation]

Raises

CloudError

models = <module 'azure.mgmt.redis.models' from '/home/vsts/work/1/s/sdk/redis/azure-mgmt-redis/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/redis/models/__init__.py'>
class azure.mgmt.redis.operations.RedisOperations(client, config, serializer, deserializer)[source]

Bases: object

RedisOperations operations.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client Api Version. Constant value: “2018-03-01”.

check_name_availability(name, type, custom_headers=None, raw=False, **operation_config)[source]

Checks that the redis cache name is valid and is not already in use.

Parameters

  • name (str) – Resource name.

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

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

create(resource_group_name, name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Create or replace (overwrite/recreate, with potential downtime) an existing Redis cache.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the Redis cache.

  • parameters (RedisCreateParameters) – Parameters supplied to the Create Redis operation.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns RedisResource or ClientRawResponse<RedisResource> if raw==True

Return type

AzureOperationPoller[RedisResource] or AzureOperationPoller[ClientRawResponse[RedisResource]]

Raises

CloudError

delete(resource_group_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes a Redis cache.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the Redis cache.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

export_data(resource_group_name, name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Export data from the redis cache to blobs in a container.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the Redis cache.

  • parameters (ExportRDBParameters) – Parameters for Redis export operation.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

force_reboot(resource_group_name, name, reboot_type, shard_id=None, custom_headers=None, raw=False, **operation_config)[source]

Reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the Redis cache.

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

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

RedisForceRebootResponse or ClientRawResponse if raw=true

Return type

RedisForceRebootResponse or ClientRawResponse

Raises

CloudError

get(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Gets a Redis cache (resource description).

Parameters

  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the Redis cache.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

RedisResource or ClientRawResponse if raw=true

Return type

RedisResource or ClientRawResponse

Raises

CloudError

import_data(resource_group_name, name, files, format=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Import data into Redis cache.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the Redis cache.

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

  • format (str) – File format.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]

Gets all Redis caches in the specified subscription.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of RedisResource

Return type

RedisResourcePaged[RedisResource]

Raises

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Lists all Redis caches in a resource group.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of RedisResource

Return type

RedisResourcePaged[RedisResource]

Raises

CloudError

list_keys(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Retrieve a Redis cache’s access keys. This operation requires write permission to the cache resource.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the Redis cache.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

RedisAccessKeys or ClientRawResponse if raw=true

Return type

RedisAccessKeys or ClientRawResponse

Raises

CloudError

list_upgrade_notifications(resource_group_name, name, history, custom_headers=None, raw=False, **operation_config)[source]

Gets any upgrade notifications for a Redis cache.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the Redis cache.

  • history (float) – how many minutes in past to look for upgrade notifications

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

NotificationListResponse or ClientRawResponse if raw=true

Return type

NotificationListResponse or ClientRawResponse

Raises

CloudError

regenerate_key(resource_group_name, name, key_type, custom_headers=None, raw=False, **operation_config)[source]

Regenerate Redis cache’s access keys. This operation requires write permission to the cache resource.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the Redis cache.

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

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

RedisAccessKeys or ClientRawResponse if raw=true

Return type

RedisAccessKeys or ClientRawResponse

Raises

CloudError

update(resource_group_name, name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Update an existing Redis cache.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the Redis cache.

  • parameters (RedisUpdateParameters) – Parameters supplied to the Update Redis operation.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

RedisResource or ClientRawResponse if raw=true

Return type

RedisResource or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.redis.models' from '/home/vsts/work/1/s/sdk/redis/azure-mgmt-redis/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/redis/models/__init__.py'>
class azure.mgmt.redis.operations.FirewallRulesOperations(client, config, serializer, deserializer)[source]

Bases: object

FirewallRulesOperations operations.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client Api Version. Constant value: “2018-03-01”.

create_or_update(resource_group_name, cache_name, rule_name, start_ip, end_ip, custom_headers=None, raw=False, **operation_config)[source]

Create or update a redis cache firewall rule.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cache_name (str) – The name of the Redis cache.

  • rule_name (str) – The name of the firewall rule.

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

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

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

RedisFirewallRule or ClientRawResponse if raw=true

Return type

RedisFirewallRule or ClientRawResponse

Raises

CloudError

delete(resource_group_name, cache_name, rule_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes a single firewall rule in a specified redis cache.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cache_name (str) – The name of the Redis cache.

  • rule_name (str) – The name of the firewall rule.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, cache_name, rule_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a single firewall rule in a specified redis cache.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cache_name (str) – The name of the Redis cache.

  • rule_name (str) – The name of the firewall rule.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

RedisFirewallRule or ClientRawResponse if raw=true

Return type

RedisFirewallRule or ClientRawResponse

Raises

CloudError

list_by_redis_resource(resource_group_name, cache_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all firewall rules in the specified redis cache.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cache_name (str) – The name of the Redis cache.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of RedisFirewallRule

Return type

RedisFirewallRulePaged[RedisFirewallRule]

Raises

CloudError

models = <module 'azure.mgmt.redis.models' from '/home/vsts/work/1/s/sdk/redis/azure-mgmt-redis/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/redis/models/__init__.py'>
class azure.mgmt.redis.operations.PatchSchedulesOperations(client, config, serializer, deserializer)[source]

Bases: object

PatchSchedulesOperations operations.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

  • api_version – Client Api Version. Constant value: “2018-03-01”.

  • default – Default string modeled as parameter for auto generation to work correctly. Constant value: “default”.

create_or_update(resource_group_name, name, schedule_entries, custom_headers=None, raw=False, **operation_config)[source]

Create or replace the patching schedule for Redis cache (requires Premium SKU).

Parameters

  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the Redis cache.

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

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

RedisPatchSchedule or ClientRawResponse if raw=true

Return type

RedisPatchSchedule or ClientRawResponse

Raises

CloudError

delete(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the patching schedule of a redis cache (requires Premium SKU).

Parameters

  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the redis cache.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Gets the patching schedule of a redis cache (requires Premium SKU).

Parameters

  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the redis cache.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

RedisPatchSchedule or ClientRawResponse if raw=true

Return type

RedisPatchSchedule or ClientRawResponse

Raises

CloudError

list_by_redis_resource(resource_group_name, cache_name, custom_headers=None, raw=False, **operation_config)[source]

Gets all patch schedules in the specified redis cache (there is only one).

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cache_name (str) – The name of the Redis cache.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of RedisPatchSchedule

Return type

RedisPatchSchedulePaged[RedisPatchSchedule]

Raises

CloudError

models = <module 'azure.mgmt.redis.models' from '/home/vsts/work/1/s/sdk/redis/azure-mgmt-redis/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/redis/models/__init__.py'>
class azure.mgmt.redis.operations.LinkedServerOperations(client, config, serializer, deserializer)[source]

Bases: object

LinkedServerOperations operations.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client Api Version. Constant value: “2018-03-01”.

create(resource_group_name, name, linked_server_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Adds a linked server to the Redis cache (requires Premium SKU).

Parameters

  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the Redis cache.

  • linked_server_name (str) – The name of the linked server that is being added to the Redis cache.

  • parameters (RedisLinkedServerCreateParameters) – Parameters supplied to the Create Linked server operation.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns RedisLinkedServerWithProperties or ClientRawResponse<RedisLinkedServerWithProperties> if raw==True

Return type

AzureOperationPoller[RedisLinkedServerWithProperties] or AzureOperationPoller[ClientRawResponse[RedisLinkedServerWithProperties]]

Raises

CloudError

delete(resource_group_name, name, linked_server_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the linked server from a redis cache (requires Premium SKU).

Parameters

  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the redis cache.

  • linked_server_name (str) – The name of the linked server that is being added to the Redis cache.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, name, linked_server_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the detailed information about a linked server of a redis cache (requires Premium SKU).

Parameters

  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the redis cache.

  • linked_server_name (str) – The name of the linked server.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

RedisLinkedServerWithProperties or ClientRawResponse if raw=true

Return type

RedisLinkedServerWithProperties or ClientRawResponse

Raises

CloudError

list(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Gets the list of linked servers associated with this redis cache (requires Premium SKU).

Parameters

  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the redis cache.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of RedisLinkedServerWithProperties

Return type

RedisLinkedServerWithPropertiesPaged[RedisLinkedServerWithProperties]

Raises

CloudError

models = <module 'azure.mgmt.redis.models' from '/home/vsts/work/1/s/sdk/redis/azure-mgmt-redis/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/redis/models/__init__.py'>