Class: Azure::Mysql::Mgmt::V2020_01_01::ServerKeys

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb

Overview

The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files, encryption keys, active directory administrator and configurations.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ServerKeys

Creates and initializes a new instance of the ServerKeys class.

Parameters:

  • client —

    service class for accessing basic functionality.



20
21
22
 
# File 'lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb', line 20

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ MySQLManagementClient (readonly)

Returns reference to the MySQLManagementClient.

Returns:



25
26
27
 
# File 'lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb', line 25

def client
  @client
end

Instance Method Details

#begin_create_or_update(server_name, key_name, parameters, resource_group_name, custom_headers: nil) ⇒ ServerKey

Creates or updates a MySQL Server key.

(updated or created). is case insensitive. will be added to the HTTP request.

Parameters:

  • server_name (String) —

    The name of the server.

  • key_name (String) —

    The name of the MySQL Server key to be operated on

  • parameters (ServerKey) —

    The requested MySQL Server key resource state.

  • resource_group_name (String) —

    The name of the resource group. The name

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

    A hash of custom headers that

Returns:

  • (ServerKey) —

    operation results.



341
342
343
344
 
# File 'lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb', line 341

def begin_create_or_update(server_name, key_name, parameters, resource_group_name, custom_headers:nil)
  response = begin_create_or_update_async(server_name, key_name, parameters, resource_group_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_or_update_async(server_name, key_name, parameters, resource_group_name, custom_headers: nil) ⇒ Concurrent::Promise

Creates or updates a MySQL Server key.

(updated or created). is case insensitive. to the HTTP request.

Parameters:

  • server_name (String) —

    The name of the server.

  • key_name (String) —

    The name of the MySQL Server key to be operated on

  • parameters (ServerKey) —

    The requested MySQL Server key resource state.

  • resource_group_name (String) —

    The name of the resource group. The name

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb', line 378

def begin_create_or_update_async(server_name, key_name, parameters, resource_group_name, custom_headers:nil)
  fail ArgumentError, 'server_name is nil' if server_name.nil?
  fail ArgumentError, 'key_name is nil' if key_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.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?


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

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

  # Serialize Request
  request_mapper = Azure::Mysql::Mgmt::V2020_01_01::Models::ServerKey.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.DBforMySQL/servers/{serverName}/keys/{keyName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'serverName' => server_name,'keyName' => key_name,'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name},
      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 == 202
      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.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Mysql::Mgmt::V2020_01_01::Models::ServerKey.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 == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Mysql::Mgmt::V2020_01_01::Models::ServerKey.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

#begin_create_or_update_with_http_info(server_name, key_name, parameters, resource_group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates a MySQL Server key.

(updated or created). is case insensitive. will be added to the HTTP request.

Parameters:

  • server_name (String) —

    The name of the server.

  • key_name (String) —

    The name of the MySQL Server key to be operated on

  • parameters (ServerKey) —

    The requested MySQL Server key resource state.

  • resource_group_name (String) —

    The name of the resource group. The name

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



360
361
362
 
# File 'lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb', line 360

def begin_create_or_update_with_http_info(server_name, key_name, parameters, resource_group_name, custom_headers:nil)
  begin_create_or_update_async(server_name, key_name, parameters, resource_group_name, custom_headers:custom_headers).value!
end

#begin_delete(server_name, key_name, resource_group_name, custom_headers: nil) ⇒ Object

Deletes the MySQL Server key with the given name.

is case insensitive. will be added to the HTTP request.

Parameters:

  • server_name (String) —

    The name of the server.

  • key_name (String) —

    The name of the MySQL Server key to be deleted.

  • resource_group_name (String) —

    The name of the resource group. The name

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

    A hash of custom headers that



468
469
470
471
 
# File 'lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb', line 468

def begin_delete(server_name, key_name, resource_group_name, custom_headers:nil)
  response = begin_delete_async(server_name, key_name, resource_group_name, custom_headers:custom_headers).value!
  nil
end

#begin_delete_async(server_name, key_name, resource_group_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes the MySQL Server key with the given name.

is case insensitive. to the HTTP request.

Parameters:

  • server_name (String) —

    The name of the server.

  • key_name (String) —

    The name of the MySQL Server key to be deleted.

  • resource_group_name (String) —

    The name of the resource group. The name

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
 
# File 'lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb', line 501

def begin_delete_async(server_name, key_name, resource_group_name, custom_headers:nil)
  fail ArgumentError, 'server_name is nil' if server_name.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?


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

  # 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.DBforMySQL/servers/{serverName}/keys/{keyName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'serverName' => server_name,'keyName' => key_name,'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name},
      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 == 202 || 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.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#begin_delete_with_http_info(server_name, key_name, resource_group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes the MySQL Server key with the given name.

is case insensitive. will be added to the HTTP request.

Parameters:

  • server_name (String) —

    The name of the server.

  • key_name (String) —

    The name of the MySQL Server key to be deleted.

  • resource_group_name (String) —

    The name of the resource group. The name

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



485
486
487
 
# File 'lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb', line 485

def begin_delete_with_http_info(server_name, key_name, resource_group_name, custom_headers:nil)
  begin_delete_async(server_name, key_name, resource_group_name, custom_headers:custom_headers).value!
end

#create_or_update(server_name, key_name, parameters, resource_group_name, custom_headers: nil) ⇒ ServerKey

Creates or updates a MySQL Server key.

(updated or created). is case insensitive. will be added to the HTTP request.

Parameters:

  • server_name (String) —

    The name of the server.

  • key_name (String) —

    The name of the MySQL Server key to be operated on

  • parameters (ServerKey) —

    The requested MySQL Server key resource state.

  • resource_group_name (String) —

    The name of the resource group. The name

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

    A hash of custom headers that

Returns:

  • (ServerKey) —

    operation results.



249
250
251
252
 
# File 'lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb', line 249

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

#create_or_update_async(server_name, key_name, parameters, resource_group_name, custom_headers: nil) ⇒ Concurrent::Promise

(updated or created). is case insensitive. will be added to the HTTP request.

response.

Parameters:

  • server_name (String) —

    The name of the server.

  • key_name (String) —

    The name of the MySQL Server key to be operated on

  • parameters (ServerKey) —

    The requested MySQL Server key resource state.

  • resource_group_name (String) —

    The name of the resource group. The name

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb', line 267

def create_or_update_async(server_name, key_name, parameters, resource_group_name, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(server_name, key_name, parameters, resource_group_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Mysql::Mgmt::V2020_01_01::Models::ServerKey.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#delete(server_name, key_name, resource_group_name, custom_headers: nil) ⇒ Object

Deletes the MySQL Server key with the given name.

is case insensitive. will be added to the HTTP request.

Parameters:

  • server_name (String) —

    The name of the server.

  • key_name (String) —

    The name of the MySQL Server key to be deleted.

  • resource_group_name (String) —

    The name of the resource group. The name

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

    A hash of custom headers that



295
296
297
298
 
# File 'lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb', line 295

def delete(server_name, key_name, resource_group_name, custom_headers:nil)
  response = delete_async(server_name, key_name, resource_group_name, custom_headers:custom_headers).value!
  nil
end

#delete_async(server_name, key_name, resource_group_name, custom_headers: nil) ⇒ Concurrent::Promise

is case insensitive. will be added to the HTTP request.

response.

Parameters:

  • server_name (String) —

    The name of the server.

  • key_name (String) —

    The name of the MySQL Server key to be deleted.

  • resource_group_name (String) —

    The name of the resource group. The name

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb', line 311

def delete_async(server_name, key_name, resource_group_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(server_name, key_name, resource_group_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#get(resource_group_name, server_name, key_name, custom_headers: nil) ⇒ ServerKey

Gets a MySQL Server key.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

  • key_name (String) —

    The name of the MySQL Server key to be retrieved.

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

    A hash of custom headers that

Returns:

  • (ServerKey) —

    operation results.



141
142
143
144
 
# File 'lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb', line 141

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

#get_async(resource_group_name, server_name, key_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets a MySQL Server key.

is case insensitive. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

  • key_name (String) —

    The name of the MySQL Server key to be retrieved.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



174
175
176
177
178
179
180
181
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
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb', line 174

def get_async(resource_group_name, server_name, key_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'server_name is nil' if server_name.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1


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

  # 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.DBforMySQL/servers/{serverName}/keys/{keyName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serverName' => server_name,'keyName' => key_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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Mysql::Mgmt::V2020_01_01::Models::ServerKey.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, server_name, key_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a MySQL Server key.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

  • key_name (String) —

    The name of the MySQL Server key to be retrieved.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



158
159
160
 
# File 'lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb', line 158

def get_with_http_info(resource_group_name, server_name, key_name, custom_headers:nil)
  get_async(resource_group_name, server_name, key_name, custom_headers:custom_headers).value!
end

#list(resource_group_name, server_name, custom_headers: nil) ⇒ Array<ServerKey>

Gets a list of Server keys.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

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

    A hash of custom headers that

Returns:

  • (Array<ServerKey>) —

    operation results.



38
39
40
41
 
# File 'lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb', line 38

def list(resource_group_name, server_name, custom_headers:nil)
  first_page = list_as_lazy(resource_group_name, server_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(resource_group_name, server_name, custom_headers: nil) ⇒ ServerKeyListResult

Gets a list of Server keys.

is case insensitive. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

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

    A hash of custom headers that

Returns:

  • (ServerKeyListResult) —

    which provide lazy access to pages of the



654
655
656
657
658
659
660
661
662
663
 
# File 'lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb', line 654

def list_as_lazy(resource_group_name, server_name, custom_headers:nil)
  response = list_async(resource_group_name, server_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_async(resource_group_name, server_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets a list of Server keys.

is case insensitive. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



69
70
71
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
 
# File 'lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb', line 69

def list_async(resource_group_name, server_name, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'server_name is nil' if server_name.nil?


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

  # 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.DBforMySQL/servers/{serverName}/keys'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'serverName' => server_name},
      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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Mysql::Mgmt::V2020_01_01::Models::ServerKeyListResult.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

#list_next(next_page_link, custom_headers: nil) ⇒ ServerKeyListResult

Gets a list of Server keys.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (ServerKeyListResult) —

    operation results.



562
563
564
565
 
# File 'lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb', line 562

def list_next(next_page_link, custom_headers:nil)
  response = list_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Gets a list of Server keys.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
 
# File 'lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb', line 591

def list_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


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

  # 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 = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Mysql::Mgmt::V2020_01_01::Models::ServerKeyListResult.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

#list_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of Server keys.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



577
578
579
 
# File 'lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb', line 577

def list_next_with_http_info(next_page_link, custom_headers:nil)
  list_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_with_http_info(resource_group_name, server_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of Server keys.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • server_name (String) —

    The name of the server.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



54
55
56
 
# File 'lib/2020-01-01/generated/azure_mgmt_mysql/server_keys.rb', line 54

def list_with_http_info(resource_group_name, server_name, custom_headers:nil)
  list_async(resource_group_name, server_name, custom_headers:custom_headers).value!
end