Class: Azure::Redis::Mgmt::V2017_02_01::PatchSchedules

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-02-01/generated/azure_mgmt_redis/patch_schedules.rb

Overview

REST API for Azure Redis Cache Service.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ PatchSchedules

Creates and initializes a new instance of the PatchSchedules class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2017-02-01/generated/azure_mgmt_redis/patch_schedules.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ RedisManagementClient (readonly)

Returns reference to the RedisManagementClient.

Returns:



22
23
24
 
# File 'lib/2017-02-01/generated/azure_mgmt_redis/patch_schedules.rb', line 22

def client
  @client
end

Instance Method Details

#create_or_update(resource_group_name, name, parameters, custom_headers = nil) ⇒ RedisPatchSchedule

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

schedule for Redis cache. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • name (String) —

    The name of the Redis cache.

  • parameters (RedisPatchSchedule) —

    Parameters to set the patching

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (RedisPatchSchedule) —

    operation results.



37
38
39
40
 
# File 'lib/2017-02-01/generated/azure_mgmt_redis/patch_schedules.rb', line 37

def create_or_update(resource_group_name, name, parameters, custom_headers = nil)
  response = create_or_update_async(resource_group_name, name, parameters, custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

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

schedule for Redis cache. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • name (String) —

    The name of the Redis cache.

  • parameters (RedisPatchSchedule) —

    Parameters to set the patching

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/2017-02-01/generated/azure_mgmt_redis/patch_schedules.rb', line 72

def create_or_update_async(resource_group_name, name, parameters, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'name is nil' if name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Serialize Request
  request_mapper = Azure::Redis::Mgmt::V2017_02_01::Models::RedisPatchSchedule.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/default'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'name' => name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 201
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Redis::Mgmt::V2017_02_01::Models::RedisPatchSchedule.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Redis::Mgmt::V2017_02_01::Models::RedisPatchSchedule.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#create_or_update_with_http_info(resource_group_name, name, parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

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

schedule for Redis cache. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • name (String) —

    The name of the Redis cache.

  • parameters (RedisPatchSchedule) —

    Parameters to set the patching

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



55
56
57
 
# File 'lib/2017-02-01/generated/azure_mgmt_redis/patch_schedules.rb', line 55

def create_or_update_with_http_info(resource_group_name, name, parameters, custom_headers = nil)
  create_or_update_async(resource_group_name, name, parameters, custom_headers).value!
end

#delete(resource_group_name, name, custom_headers = nil) ⇒ Object

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

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • name (String) —

    The name of the redis cache.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that



153
154
155
156
 
# File 'lib/2017-02-01/generated/azure_mgmt_redis/patch_schedules.rb', line 153

def delete(resource_group_name, name, custom_headers = nil)
  response = delete_async(resource_group_name, name, custom_headers).value!
  nil
end

#delete_async(resource_group_name, name, custom_headers = nil) ⇒ Concurrent::Promise

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

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • name (String) —

    The name of the redis cache.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/2017-02-01/generated/azure_mgmt_redis/patch_schedules.rb', line 182

def delete_async(resource_group_name, name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'name is nil' if name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/default'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'name' => name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 204
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?

    result
  end

  promise.execute
end

#delete_with_http_info(resource_group_name, name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

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

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • name (String) —

    The name of the redis cache.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



168
169
170
 
# File 'lib/2017-02-01/generated/azure_mgmt_redis/patch_schedules.rb', line 168

def delete_with_http_info(resource_group_name, name, custom_headers = nil)
  delete_async(resource_group_name, name, custom_headers).value!
end

#get(resource_group_name, name, custom_headers = nil) ⇒ RedisPatchSchedule

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

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • name (String) —

    The name of the redis cache.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (RedisPatchSchedule) —

    operation results.



234
235
236
237
 
# File 'lib/2017-02-01/generated/azure_mgmt_redis/patch_schedules.rb', line 234

def get(resource_group_name, name, custom_headers = nil)
  response = get_async(resource_group_name, name, custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, name, custom_headers = nil) ⇒ Concurrent::Promise

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

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • name (String) —

    The name of the redis cache.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/2017-02-01/generated/azure_mgmt_redis/patch_schedules.rb', line 263

def get_async(resource_group_name, name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'name is nil' if name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/default'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'name' => name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Redis::Mgmt::V2017_02_01::Models::RedisPatchSchedule.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_with_http_info(resource_group_name, name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

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

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • name (String) —

    The name of the redis cache.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



249
250
251
 
# File 'lib/2017-02-01/generated/azure_mgmt_redis/patch_schedules.rb', line 249

def get_with_http_info(resource_group_name, name, custom_headers = nil)
  get_async(resource_group_name, name, custom_headers).value!
end