diff --git a/azure-mgmt-redis/azure/mgmt/redis/models/export_rdb_parameters.py b/azure-mgmt-redis/azure/mgmt/redis/models/export_rdb_parameters.py index 5179e868f45f..aa236a40447d 100644 --- a/azure-mgmt-redis/azure/mgmt/redis/models/export_rdb_parameters.py +++ b/azure-mgmt-redis/azure/mgmt/redis/models/export_rdb_parameters.py @@ -13,7 +13,7 @@ class ExportRDBParameters(Model): - """Parameters for redis export operation. + """Parameters for Redis export operation. :param format: File format. :type format: str diff --git a/azure-mgmt-redis/azure/mgmt/redis/models/import_rdb_parameters.py b/azure-mgmt-redis/azure/mgmt/redis/models/import_rdb_parameters.py index 0055ae2eef71..3045f71e5aa3 100644 --- a/azure-mgmt-redis/azure/mgmt/redis/models/import_rdb_parameters.py +++ b/azure-mgmt-redis/azure/mgmt/redis/models/import_rdb_parameters.py @@ -13,11 +13,11 @@ class ImportRDBParameters(Model): - """Parameters for redis import operation. + """Parameters for Redis import operation. :param format: File format. :type format: str - :param files: files to import + :param files: files to import. :type files: list of str """ diff --git a/azure-mgmt-redis/azure/mgmt/redis/models/redis_access_keys.py b/azure-mgmt-redis/azure/mgmt/redis/models/redis_access_keys.py index ece00160c14a..65a2d15b5b25 100644 --- a/azure-mgmt-redis/azure/mgmt/redis/models/redis_access_keys.py +++ b/azure-mgmt-redis/azure/mgmt/redis/models/redis_access_keys.py @@ -19,10 +19,10 @@ class RedisAccessKeys(Model): sending a request. :ivar primary_key: The current primary key that clients can use to - authenticate with redis cache. + authenticate with Redis cache. :vartype primary_key: str :ivar secondary_key: The current secondary key that clients can use to - authenticate with redis cache. + authenticate with Redis cache. :vartype secondary_key: str """ diff --git a/azure-mgmt-redis/azure/mgmt/redis/models/redis_create_parameters.py b/azure-mgmt-redis/azure/mgmt/redis/models/redis_create_parameters.py index 376581dca206..b73a9a6645a7 100644 --- a/azure-mgmt-redis/azure/mgmt/redis/models/redis_create_parameters.py +++ b/azure-mgmt-redis/azure/mgmt/redis/models/redis_create_parameters.py @@ -18,22 +18,22 @@ class RedisCreateParameters(Resource): Variables are only populated by the server, and will be ignored when sending a request. - :ivar id: Resource Id + :ivar id: Resource ID. :vartype id: str - :ivar name: Resource name + :ivar name: Resource name. :vartype name: str - :ivar type: Resource type + :ivar type: Resource type. :vartype type: str - :param location: Resource location + :param location: Resource location. :type location: str - :param tags: Resource tags + :param tags: Resource tags. :type tags: dict :param redis_configuration: 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. :type redis_configuration: dict - :param enable_non_ssl_port: If the value is true, then the non-ssl redis - server port (6379) will be enabled. + :param enable_non_ssl_port: Specifies whether the non-ssl Redis server + port (6379) is enabled. :type enable_non_ssl_port: bool :param tenant_settings: tenantSettings :type tenant_settings: dict @@ -41,13 +41,13 @@ class RedisCreateParameters(Resource): Cluster Cache. :type shard_count: int :param subnet_id: The full resource ID of a subnet in a virtual network - to deploy the redis cache in. Example format: + to deploy the Redis cache in. Example format: /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1 :type subnet_id: str - :param static_ip: Required when deploying a redis cache inside an - existing Azure Virtual Network. + :param static_ip: Static IP address. Required when deploying a Redis + cache inside an existing Azure Virtual Network. :type static_ip: str - :param sku: What sku of redis cache to deploy. + :param sku: The SKU of the Redis cache to deploy. :type sku: :class:`Sku ` """ @@ -67,7 +67,7 @@ class RedisCreateParameters(Resource): 'type': {'key': 'type', 'type': 'str'}, 'location': {'key': 'location', 'type': 'str'}, 'tags': {'key': 'tags', 'type': '{str}'}, - 'redis_configuration': {'key': 'properties.redisConfiguration', 'type': '{str}'}, + 'redis_configuration': {'key': 'properties.RedisConfiguration', 'type': '{str}'}, 'enable_non_ssl_port': {'key': 'properties.enableNonSslPort', 'type': 'bool'}, 'tenant_settings': {'key': 'properties.tenantSettings', 'type': '{str}'}, 'shard_count': {'key': 'properties.shardCount', 'type': 'int'}, diff --git a/azure-mgmt-redis/azure/mgmt/redis/models/redis_management_client_enums.py b/azure-mgmt-redis/azure/mgmt/redis/models/redis_management_client_enums.py index 1afdd8175668..82b2e95e1179 100644 --- a/azure-mgmt-redis/azure/mgmt/redis/models/redis_management_client_enums.py +++ b/azure-mgmt-redis/azure/mgmt/redis/models/redis_management_client_enums.py @@ -47,3 +47,5 @@ class DayOfWeek(Enum): friday = "Friday" saturday = "Saturday" sunday = "Sunday" + everyday = "Everyday" + weekend = "Weekend" diff --git a/azure-mgmt-redis/azure/mgmt/redis/models/redis_patch_schedule.py b/azure-mgmt-redis/azure/mgmt/redis/models/redis_patch_schedule.py index 47aa35867b9a..976be2e65762 100644 --- a/azure-mgmt-redis/azure/mgmt/redis/models/redis_patch_schedule.py +++ b/azure-mgmt-redis/azure/mgmt/redis/models/redis_patch_schedule.py @@ -13,20 +13,20 @@ class RedisPatchSchedule(Model): - """Response to put/get patch schedules for redis cache. + """Response to put/get patch schedules for Redis cache. Variables are only populated by the server, and will be ignored when sending a request. - :ivar id: Resource Id + :ivar id: Resource ID. :vartype id: str - :ivar name: Resource name + :ivar name: Resource name. :vartype name: str - :ivar type: Resource type + :ivar type: Resource type. :vartype type: str - :ivar location: Resource location + :ivar location: Resource location. :vartype location: str - :param schedule_entries: List of patch schedules for redis cache. + :param schedule_entries: List of patch schedules for a Redis cache. :type schedule_entries: list of :class:`ScheduleEntry ` """ diff --git a/azure-mgmt-redis/azure/mgmt/redis/models/redis_reboot_parameters.py b/azure-mgmt-redis/azure/mgmt/redis/models/redis_reboot_parameters.py index 22c474783eaa..b7486e7fa73c 100644 --- a/azure-mgmt-redis/azure/mgmt/redis/models/redis_reboot_parameters.py +++ b/azure-mgmt-redis/azure/mgmt/redis/models/redis_reboot_parameters.py @@ -13,15 +13,15 @@ class RedisRebootParameters(Model): - """Specifies which redis node(s) to reboot. + """Specifies which Redis node(s) to reboot. - :param reboot_type: Which redis node(s) to reboot. Depending on this + :param reboot_type: Which Redis node(s) to reboot. Depending on this value data loss is possible. Possible values include: 'PrimaryNode', 'SecondaryNode', 'AllNodes' :type reboot_type: str or :class:`RebootType ` - :param shard_id: In case of cluster cache, this specifies shard id which - should be rebooted. + :param shard_id: If clustering is enabled, the ID of the shard to be + rebooted. :type shard_id: int """ diff --git a/azure-mgmt-redis/azure/mgmt/redis/models/redis_regenerate_key_parameters.py b/azure-mgmt-redis/azure/mgmt/redis/models/redis_regenerate_key_parameters.py index 3b218b3d7c80..f5b8828ec2ba 100644 --- a/azure-mgmt-redis/azure/mgmt/redis/models/redis_regenerate_key_parameters.py +++ b/azure-mgmt-redis/azure/mgmt/redis/models/redis_regenerate_key_parameters.py @@ -13,9 +13,9 @@ class RedisRegenerateKeyParameters(Model): - """Specifies which redis access keys to reset. + """Specifies which Redis access keys to reset. - :param key_type: Which redis access key to reset. Possible values + :param key_type: The Redis access key to regenerate. Possible values include: 'Primary', 'Secondary' :type key_type: str or :class:`RedisKeyType ` diff --git a/azure-mgmt-redis/azure/mgmt/redis/models/redis_resource.py b/azure-mgmt-redis/azure/mgmt/redis/models/redis_resource.py index 4e45177c621d..e7443de6dee0 100644 --- a/azure-mgmt-redis/azure/mgmt/redis/models/redis_resource.py +++ b/azure-mgmt-redis/azure/mgmt/redis/models/redis_resource.py @@ -13,37 +13,37 @@ class RedisResource(Resource): - """A single redis item in List or Get Operation. + """A single Redis item in List or Get Operation. Variables are only populated by the server, and will be ignored when sending a request. - :ivar id: Resource Id + :ivar id: Resource ID. :vartype id: str - :ivar name: Resource name + :ivar name: Resource name. :vartype name: str - :ivar type: Resource type + :ivar type: Resource type. :vartype type: str - :param location: Resource location + :param location: Resource location. :type location: str - :param tags: Resource tags + :param tags: Resource tags. :type tags: dict - :ivar redis_version: Redis Version. + :ivar redis_version: Redis version. :vartype redis_version: str - :ivar provisioning_state: Redis instance provisioning status + :ivar provisioning_state: Redis instance provisioning status. :vartype provisioning_state: str - :ivar host_name: Redis host name + :ivar host_name: Redis host name. :vartype host_name: str - :ivar port: Redis non-ssl port + :ivar port: Redis non-SSL port. :vartype port: int - :ivar ssl_port: Redis ssl port + :ivar ssl_port: Redis SSL port. :vartype ssl_port: int :param redis_configuration: 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. :type redis_configuration: dict - :param enable_non_ssl_port: If the value is true, then the non-ssl redis - server port (6379) will be enabled. + :param enable_non_ssl_port: Specifies whether the non-ssl Redis server + port (6379) is enabled. :type enable_non_ssl_port: bool :param tenant_settings: tenantSettings :type tenant_settings: dict @@ -51,13 +51,13 @@ class RedisResource(Resource): Cluster Cache. :type shard_count: int :param subnet_id: The full resource ID of a subnet in a virtual network - to deploy the redis cache in. Example format: + to deploy the Redis cache in. Example format: /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1 :type subnet_id: str - :param static_ip: Required when deploying a redis cache inside an - existing Azure Virtual Network. + :param static_ip: Static IP address. Required when deploying a Redis + cache inside an existing Azure Virtual Network. :type static_ip: str - :param sku: What sku of redis cache to deploy. + :param sku: The SKU of the Redis cache to deploy. :type sku: :class:`Sku ` """ @@ -82,12 +82,12 @@ class RedisResource(Resource): 'type': {'key': 'type', 'type': 'str'}, 'location': {'key': 'location', 'type': 'str'}, 'tags': {'key': 'tags', 'type': '{str}'}, - 'redis_version': {'key': 'properties.redisVersion', 'type': 'str'}, + 'redis_version': {'key': 'properties.RedisVersion', 'type': 'str'}, 'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'}, 'host_name': {'key': 'properties.hostName', 'type': 'str'}, 'port': {'key': 'properties.port', 'type': 'int'}, 'ssl_port': {'key': 'properties.sslPort', 'type': 'int'}, - 'redis_configuration': {'key': 'properties.redisConfiguration', 'type': '{str}'}, + 'redis_configuration': {'key': 'properties.RedisConfiguration', 'type': '{str}'}, 'enable_non_ssl_port': {'key': 'properties.enableNonSslPort', 'type': 'bool'}, 'tenant_settings': {'key': 'properties.tenantSettings', 'type': '{str}'}, 'shard_count': {'key': 'properties.shardCount', 'type': 'int'}, diff --git a/azure-mgmt-redis/azure/mgmt/redis/models/redis_update_parameters.py b/azure-mgmt-redis/azure/mgmt/redis/models/redis_update_parameters.py index 67bde8cf5228..0fd157c2926a 100644 --- a/azure-mgmt-redis/azure/mgmt/redis/models/redis_update_parameters.py +++ b/azure-mgmt-redis/azure/mgmt/redis/models/redis_update_parameters.py @@ -19,8 +19,8 @@ class RedisUpdateParameters(Model): 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. :type redis_configuration: dict - :param enable_non_ssl_port: If the value is true, then the non-ssl redis - server port (6379) will be enabled. + :param enable_non_ssl_port: Specifies whether the non-ssl Redis server + port (6379) is enabled. :type enable_non_ssl_port: bool :param tenant_settings: tenantSettings :type tenant_settings: dict @@ -28,15 +28,15 @@ class RedisUpdateParameters(Model): Cluster Cache. :type shard_count: int :param subnet_id: The full resource ID of a subnet in a virtual network - to deploy the redis cache in. Example format: + to deploy the Redis cache in. Example format: /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1 :type subnet_id: str - :param static_ip: Required when deploying a redis cache inside an - existing Azure Virtual Network. + :param static_ip: Static IP address. Required when deploying a Redis + cache inside an existing Azure Virtual Network. :type static_ip: str - :param sku: What sku of redis cache to deploy. + :param sku: The SKU of the Redis cache to deploy. :type sku: :class:`Sku ` - :param tags: Resource tags + :param tags: Resource tags. :type tags: dict """ @@ -46,7 +46,7 @@ class RedisUpdateParameters(Model): } _attribute_map = { - 'redis_configuration': {'key': 'properties.redisConfiguration', 'type': '{str}'}, + 'redis_configuration': {'key': 'properties.RedisConfiguration', 'type': '{str}'}, 'enable_non_ssl_port': {'key': 'properties.enableNonSslPort', 'type': 'bool'}, 'tenant_settings': {'key': 'properties.tenantSettings', 'type': '{str}'}, 'shard_count': {'key': 'properties.shardCount', 'type': 'int'}, diff --git a/azure-mgmt-redis/azure/mgmt/redis/models/resource.py b/azure-mgmt-redis/azure/mgmt/redis/models/resource.py index cfbc560b4dff..b36a9713507a 100644 --- a/azure-mgmt-redis/azure/mgmt/redis/models/resource.py +++ b/azure-mgmt-redis/azure/mgmt/redis/models/resource.py @@ -18,15 +18,15 @@ class Resource(Model): Variables are only populated by the server, and will be ignored when sending a request. - :ivar id: Resource Id + :ivar id: Resource ID. :vartype id: str - :ivar name: Resource name + :ivar name: Resource name. :vartype name: str - :ivar type: Resource type + :ivar type: Resource type. :vartype type: str - :param location: Resource location + :param location: Resource location. :type location: str - :param tags: Resource tags + :param tags: Resource tags. :type tags: dict """ diff --git a/azure-mgmt-redis/azure/mgmt/redis/models/schedule_entry.py b/azure-mgmt-redis/azure/mgmt/redis/models/schedule_entry.py index 51e770fb3627..17eaa2cf6e43 100644 --- a/azure-mgmt-redis/azure/mgmt/redis/models/schedule_entry.py +++ b/azure-mgmt-redis/azure/mgmt/redis/models/schedule_entry.py @@ -13,11 +13,11 @@ class ScheduleEntry(Model): - """Patch schedule entry for Premium Redis Cache. + """Patch schedule entry for a Premium Redis Cache. - :param day_of_week: Day of week when cache can be patched. Possible + :param day_of_week: Day of the week when a cache can be patched. Possible values include: 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', - 'Saturday', 'Sunday' + 'Saturday', 'Sunday', 'Everyday', 'Weekend' :type day_of_week: str or :class:`DayOfWeek ` :param start_hour_utc: Start hour after which cache patching can start. diff --git a/azure-mgmt-redis/azure/mgmt/redis/models/sku.py b/azure-mgmt-redis/azure/mgmt/redis/models/sku.py index 0beb34c88b16..0fba6847d5fe 100644 --- a/azure-mgmt-redis/azure/mgmt/redis/models/sku.py +++ b/azure-mgmt-redis/azure/mgmt/redis/models/sku.py @@ -13,18 +13,19 @@ class Sku(Model): - """Sku parameters supplied to the create redis operation. + """SKU parameters supplied to the create Redis operation. - :param name: What type of redis cache to deploy. Valid values: (Basic, + :param name: The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium). Possible values include: 'Basic', 'Standard', 'Premium' :type name: str or :class:`SkuName ` - :param family: Which family to use. Valid values: (C, P). Possible values - include: 'C', 'P' + :param family: The SKU family to use. Valid values: (C, P). (C = + Basic/Standard, P = Premium). Possible values include: 'C', 'P' :type family: str or :class:`SkuFamily ` - :param capacity: What size of redis cache to deploy. Valid values: for C - family (0, 1, 2, 3, 4, 5, 6), for P family (1, 2, 3, 4) + :param capacity: 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). :type capacity: int """ diff --git a/azure-mgmt-redis/azure/mgmt/redis/operations/patch_schedules_operations.py b/azure-mgmt-redis/azure/mgmt/redis/operations/patch_schedules_operations.py index 259cf4e63a22..0cd1a0a097d2 100644 --- a/azure-mgmt-redis/azure/mgmt/redis/operations/patch_schedules_operations.py +++ b/azure-mgmt-redis/azure/mgmt/redis/operations/patch_schedules_operations.py @@ -34,16 +34,16 @@ def __init__(self, client, config, serializer, deserializer): self.config = config def create_or_update( - self, resource_group_name, name, parameters, custom_headers=None, raw=False, **operation_config): - """Create or replace the patching schedule for redis cache. + self, resource_group_name, name, schedule_entries, custom_headers=None, raw=False, **operation_config): + """Create or replace the patching schedule for Redis cache. :param resource_group_name: The name of the resource group. :type resource_group_name: str - :param name: The name of the redis cache. + :param name: The name of the Redis cache. :type name: str - :param parameters: Parameters to set patch schedules for redis cache. - :type parameters: :class:`RedisPatchSchedule - ` + :param schedule_entries: List of patch schedules for a Redis cache. + :type schedule_entries: list of :class:`ScheduleEntry + ` :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the deserialized response @@ -53,7 +53,10 @@ def create_or_update( ` :rtype: :class:`ClientRawResponse` if raw=true + :raises: :class:`CloudError` """ + parameters = models.RedisPatchSchedule(schedule_entries=schedule_entries) + # Construct URL url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/default' path_format_arguments = { @@ -103,11 +106,11 @@ def create_or_update( def delete( self, resource_group_name, name, custom_headers=None, raw=False, **operation_config): - """Deletes the patching schedule for redis cache. + """Deletes the patching schedule for Redis cache. :param resource_group_name: The name of the resource group. :type resource_group_name: str - :param name: The name of the redis cache. + :param name: The name of the Redis cache. :type name: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -117,6 +120,7 @@ def delete( :rtype: None :rtype: :class:`ClientRawResponse` if raw=true + :raises: :class:`CloudError` """ # Construct URL url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/default' @@ -156,11 +160,11 @@ def delete( def get( self, resource_group_name, name, custom_headers=None, raw=False, **operation_config): - """Gets the patching schedule for redis cache. + """Gets the patching schedule for Redis cache. :param resource_group_name: The name of the resource group. :type resource_group_name: str - :param name: The name of the redis cache. + :param name: The name of the Redis cache. :type name: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -171,6 +175,7 @@ def get( ` :rtype: :class:`ClientRawResponse` if raw=true + :raises: :class:`CloudError` """ # Construct URL url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/default' diff --git a/azure-mgmt-redis/azure/mgmt/redis/operations/redis_operations.py b/azure-mgmt-redis/azure/mgmt/redis/operations/redis_operations.py index 201862235553..39ee05a333f9 100644 --- a/azure-mgmt-redis/azure/mgmt/redis/operations/redis_operations.py +++ b/azure-mgmt-redis/azure/mgmt/redis/operations/redis_operations.py @@ -37,13 +37,13 @@ def __init__(self, client, config, serializer, deserializer): def create( self, resource_group_name, name, parameters, custom_headers=None, raw=False, **operation_config): """Create or replace (overwrite/recreate, with potential downtime) an - existing redis cache. + existing Redis cache. :param resource_group_name: The name of the resource group. :type resource_group_name: str - :param name: The name of the redis cache. + :param name: The name of the Redis cache. :type name: str - :param parameters: Parameters supplied to the Create redis operation. + :param parameters: Parameters supplied to the Create Redis operation. :type parameters: :class:`RedisCreateParameters ` :param dict custom_headers: headers that will be added to the request @@ -55,6 +55,7 @@ def create( ` :rtype: :class:`ClientRawResponse` if raw=true + :raises: :class:`CloudError` """ # Construct URL url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}' @@ -132,9 +133,9 @@ def update( :param resource_group_name: The name of the resource group. :type resource_group_name: str - :param name: The name of the redis cache. + :param name: The name of the Redis cache. :type name: str - :param parameters: Parameters supplied to the Update redis operation. + :param parameters: Parameters supplied to the Update Redis operation. :type parameters: :class:`RedisUpdateParameters ` :param dict custom_headers: headers that will be added to the request @@ -146,6 +147,7 @@ def update( ` :rtype: :class:`ClientRawResponse` if raw=true + :raises: :class:`CloudError` """ # Construct URL url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}' @@ -219,11 +221,11 @@ def get_long_running_output(response): def delete( self, resource_group_name, name, custom_headers=None, raw=False, **operation_config): - """Deletes a redis cache. This operation takes a while to complete. + """Deletes a Redis cache. :param resource_group_name: The name of the resource group. :type resource_group_name: str - :param name: The name of the redis cache. + :param name: The name of the Redis cache. :type name: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -233,6 +235,7 @@ def delete( instance that returns None :rtype: :class:`ClientRawResponse` if raw=true + :raises: :class:`CloudError` """ # Construct URL url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}' @@ -295,11 +298,11 @@ def get_long_running_output(response): def get( self, resource_group_name, name, custom_headers=None, raw=False, **operation_config): - """Gets a redis cache (resource description). + """Gets a Redis cache (resource description). :param resource_group_name: The name of the resource group. :type resource_group_name: str - :param name: The name of the redis cache. + :param name: The name of the Redis cache. :type name: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -309,6 +312,7 @@ def get( :rtype: :class:`RedisResource ` :rtype: :class:`ClientRawResponse` if raw=true + :raises: :class:`CloudError` """ # Construct URL url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}' @@ -355,7 +359,7 @@ def get( def list_by_resource_group( self, resource_group_name, custom_headers=None, raw=False, **operation_config): - """Gets all redis caches in a resource group. + """Lists all Redis caches in a resource group. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -366,6 +370,7 @@ def list_by_resource_group( overrides`. :rtype: :class:`RedisResourcePaged ` + :raises: :class:`CloudError` """ def internal_paging(next_link=None, raw=False): @@ -420,7 +425,7 @@ def internal_paging(next_link=None, raw=False): def list( self, custom_headers=None, raw=False, **operation_config): - """Gets all redis caches in the specified subscription. + """Gets all Redis caches in the specified subscription. :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -429,6 +434,7 @@ def list( overrides`. :rtype: :class:`RedisResourcePaged ` + :raises: :class:`CloudError` """ def internal_paging(next_link=None, raw=False): @@ -482,12 +488,12 @@ def internal_paging(next_link=None, raw=False): def list_keys( self, resource_group_name, name, custom_headers=None, raw=False, **operation_config): - """Retrieve a redis cache's access keys. This operation requires write + """Retrieve a Redis cache's access keys. This operation requires write permission to the cache resource. :param resource_group_name: The name of the resource group. :type resource_group_name: str - :param name: The name of the redis cache. + :param name: The name of the Redis cache. :type name: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -498,6 +504,7 @@ def list_keys( ` :rtype: :class:`ClientRawResponse` if raw=true + :raises: :class:`CloudError` """ # Construct URL url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/listKeys' @@ -544,14 +551,14 @@ def list_keys( def regenerate_key( self, resource_group_name, name, key_type, custom_headers=None, raw=False, **operation_config): - """Regenerate redis cache's access keys. This operation requires write + """Regenerate Redis cache's access keys. This operation requires write permission to the cache resource. :param resource_group_name: The name of the resource group. :type resource_group_name: str - :param name: The name of the redis cache. + :param name: The name of the Redis cache. :type name: str - :param key_type: Which redis access key to reset. Possible values + :param key_type: The Redis access key to regenerate. Possible values include: 'Primary', 'Secondary' :type key_type: str or :class:`RedisKeyType ` @@ -564,6 +571,7 @@ def regenerate_key( ` :rtype: :class:`ClientRawResponse` if raw=true + :raises: :class:`CloudError` """ parameters = models.RedisRegenerateKeyParameters(key_type=key_type) @@ -616,20 +624,20 @@ def regenerate_key( def force_reboot( self, resource_group_name, name, reboot_type, shard_id=None, custom_headers=None, raw=False, **operation_config): - """Reboot specified redis node(s). This operation requires write + """Reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss. :param resource_group_name: The name of the resource group. :type resource_group_name: str - :param name: The name of the redis cache. + :param name: The name of the Redis cache. :type name: str - :param reboot_type: Which redis node(s) to reboot. Depending on this + :param reboot_type: Which Redis node(s) to reboot. Depending on this value data loss is possible. Possible values include: 'PrimaryNode', 'SecondaryNode', 'AllNodes' :type reboot_type: str or :class:`RebootType ` - :param shard_id: In case of cluster cache, this specifies shard id - which should be rebooted. + :param shard_id: If clustering is enabled, the ID of the shard to be + rebooted. :type shard_id: int :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -639,6 +647,7 @@ def force_reboot( :rtype: None :rtype: :class:`ClientRawResponse` if raw=true + :raises: :class:`CloudError` """ parameters = models.RedisRebootParameters(reboot_type=reboot_type, shard_id=shard_id) @@ -684,13 +693,13 @@ def force_reboot( def import_data( self, resource_group_name, name, files, format=None, custom_headers=None, raw=False, **operation_config): - """Import data into redis cache. + """Import data into Redis cache. :param resource_group_name: The name of the resource group. :type resource_group_name: str - :param name: The name of the redis cache. + :param name: The name of the Redis cache. :type name: str - :param files: files to import + :param files: files to import. :type files: list of str :param format: File format. :type format: str @@ -702,6 +711,7 @@ def import_data( instance that returns None :rtype: :class:`ClientRawResponse` if raw=true + :raises: :class:`CloudError` """ parameters = models.ImportRDBParameters(format=format, files=files) @@ -770,13 +780,13 @@ def get_long_running_output(response): def export_data( self, resource_group_name, name, parameters, custom_headers=None, raw=False, **operation_config): - """Import data into redis cache. + """Import data into Redis cache. :param resource_group_name: The name of the resource group. :type resource_group_name: str - :param name: The name of the redis cache. + :param name: The name of the Redis cache. :type name: str - :param parameters: Parameters for redis export operation. + :param parameters: Parameters for Redis export operation. :type parameters: :class:`ExportRDBParameters ` :param dict custom_headers: headers that will be added to the request @@ -787,6 +797,7 @@ def export_data( instance that returns None :rtype: :class:`ClientRawResponse` if raw=true + :raises: :class:`CloudError` """ # Construct URL url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/export' diff --git a/azure-mgmt-redis/azure/mgmt/redis/redis_management_client.py b/azure-mgmt-redis/azure/mgmt/redis/redis_management_client.py index d366f5b9052a..01d9d6eb80ca 100644 --- a/azure-mgmt-redis/azure/mgmt/redis/redis_management_client.py +++ b/azure-mgmt-redis/azure/mgmt/redis/redis_management_client.py @@ -27,8 +27,8 @@ class RedisManagementClientConfiguration(AzureConfiguration): :type credentials: :mod:`A msrestazure Credentials object` :param subscription_id: Gets subscription credentials which uniquely - identify Microsoft Azure subscription. The subscription ID forms part of - the URI for every service call. + identify the Microsoft Azure subscription. The subscription ID forms + part of the URI for every service call. :type subscription_id: str :param api_version: Client Api Version. :type api_version: str @@ -76,7 +76,7 @@ def __init__( class RedisManagementClient(object): - """REST API for Azure Redis Cache Service + """REST API for Azure Redis Cache Service. :ivar config: Configuration for client. :vartype config: RedisManagementClientConfiguration @@ -90,8 +90,8 @@ class RedisManagementClient(object): :type credentials: :mod:`A msrestazure Credentials object` :param subscription_id: Gets subscription credentials which uniquely - identify Microsoft Azure subscription. The subscription ID forms part of - the URI for every service call. + identify the Microsoft Azure subscription. The subscription ID forms + part of the URI for every service call. :type subscription_id: str :param api_version: Client Api Version. :type api_version: str