Class: Azure::SQL::Mgmt::V2017_10_01_preview::ManagedInstanceKeys

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb

Overview

The Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ManagedInstanceKeys

Creates and initializes a new instance of the ManagedInstanceKeys class.

Parameters:

  • client —

    service class for accessing basic functionality.



20
21
22
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb', line 20

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ SqlManagementClient (readonly)

Returns reference to the SqlManagementClient.

Returns:



25
26
27
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb', line 25

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, managed_instance_name, key_name, parameters, custom_headers: nil) ⇒ ManagedInstanceKey

Creates or updates a managed instance key.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. on (updated or created). resource state. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • managed_instance_name (String) —

    The name of the managed instance.

  • key_name (String) —

    The name of the managed instance key to be operated

  • parameters (ManagedInstanceKey) —

    The requested managed instance key

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

    A hash of custom headers that

Returns:

  • (ManagedInstanceKey) —

    operation results.



354
355
356
357
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb', line 354

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

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

Creates or updates a managed instance key.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. on (updated or created). resource state. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • managed_instance_name (String) —

    The name of the managed instance.

  • key_name (String) —

    The name of the managed instance key to be operated

  • parameters (ManagedInstanceKey) —

    The requested managed instance key

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb', line 395

def begin_create_or_update_async(resource_group_name, managed_instance_name, key_name, parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'managed_instance_name is nil' if managed_instance_name.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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::SQL::Mgmt::V2017_10_01_preview::Models::ManagedInstanceKey.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.Sql/managedInstances/{managedInstanceName}/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,'managedInstanceName' => managed_instance_name,'keyName' => key_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 == 202 || 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?
    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::SQL::Mgmt::V2017_10_01_preview::Models::ManagedInstanceKey.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::SQL::Mgmt::V2017_10_01_preview::Models::ManagedInstanceKey.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(resource_group_name, managed_instance_name, key_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates a managed instance key.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. on (updated or created). resource state. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • managed_instance_name (String) —

    The name of the managed instance.

  • key_name (String) —

    The name of the managed instance key to be operated

  • parameters (ManagedInstanceKey) —

    The requested managed instance key

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



375
376
377
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb', line 375

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

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

Deletes the managed instance key with the given name.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • managed_instance_name (String) —

    The name of the managed instance.

  • key_name (String) —

    The name of the managed instance key to be deleted.

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

    A hash of custom headers that



481
482
483
484
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb', line 481

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

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

Deletes the managed instance key with the given name.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • managed_instance_name (String) —

    The name of the managed instance.

  • key_name (String) —

    The name of the managed instance key to be deleted.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb', line 516

def begin_delete_async(resource_group_name, managed_instance_name, key_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'managed_instance_name is nil' if managed_instance_name.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.Sql/managedInstances/{managedInstanceName}/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,'managedInstanceName' => managed_instance_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(: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(resource_group_name, managed_instance_name, key_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes the managed instance key with the given name.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • managed_instance_name (String) —

    The name of the managed instance.

  • key_name (String) —

    The name of the managed instance key to be deleted.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



499
500
501
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb', line 499

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

#create_or_update(resource_group_name, managed_instance_name, key_name, parameters, custom_headers: nil) ⇒ ManagedInstanceKey

Creates or updates a managed instance key.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. on (updated or created). resource state. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • managed_instance_name (String) —

    The name of the managed instance.

  • key_name (String) —

    The name of the managed instance key to be operated

  • parameters (ManagedInstanceKey) —

    The requested managed instance key

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

    A hash of custom headers that

Returns:

  • (ManagedInstanceKey) —

    operation results.



256
257
258
259
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb', line 256

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

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

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. on (updated or created). resource state. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • managed_instance_name (String) —

    The name of the managed instance.

  • key_name (String) —

    The name of the managed instance key to be operated

  • parameters (ManagedInstanceKey) —

    The requested managed instance key

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb', line 276

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

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::SQL::Mgmt::V2017_10_01_preview::Models::ManagedInstanceKey.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(resource_group_name, managed_instance_name, key_name, custom_headers: nil) ⇒ Object

Deletes the managed instance key with the given name.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • managed_instance_name (String) —

    The name of the managed instance.

  • key_name (String) —

    The name of the managed instance key to be deleted.

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

    A hash of custom headers that



305
306
307
308
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb', line 305

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

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

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • managed_instance_name (String) —

    The name of the managed instance.

  • key_name (String) —

    The name of the managed instance key to be deleted.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb', line 322

def delete_async(resource_group_name, managed_instance_name, key_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, managed_instance_name, key_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, managed_instance_name, key_name, custom_headers: nil) ⇒ ManagedInstanceKey

Gets a managed instance key.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. retrieved. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • managed_instance_name (String) —

    The name of the managed instance.

  • key_name (String) —

    The name of the managed instance key to be

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

    A hash of custom headers that

Returns:

  • (ManagedInstanceKey) —

    operation results.



147
148
149
150
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb', line 147

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

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

Gets a managed instance key.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. retrieved. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • managed_instance_name (String) —

    The name of the managed instance.

  • key_name (String) —

    The name of the managed instance key to be

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
234
235
236
237
238
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb', line 184

def get_async(resource_group_name, managed_instance_name, key_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'managed_instance_name is nil' if managed_instance_name.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.Sql/managedInstances/{managedInstanceName}/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,'managedInstanceName' => managed_instance_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::SQL::Mgmt::V2017_10_01_preview::Models::ManagedInstanceKey.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, managed_instance_name, key_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a managed instance key.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. retrieved. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • managed_instance_name (String) —

    The name of the managed instance.

  • key_name (String) —

    The name of the managed instance key to be

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



166
167
168
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb', line 166

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

#list_by_instance(resource_group_name, managed_instance_name, filter: nil, custom_headers: nil) ⇒ Array<ManagedInstanceKey>

Gets a list of managed instance keys.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. the collection. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • managed_instance_name (String) —

    The name of the managed instance.

  • filter (String) (defaults to: nil) —

    An OData filter expression that filters elements in

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

    A hash of custom headers that

Returns:

  • (Array<ManagedInstanceKey>) —

    operation results.



41
42
43
44
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb', line 41

def list_by_instance(resource_group_name, managed_instance_name, filter:nil, custom_headers:nil)
  first_page = list_by_instance_as_lazy(resource_group_name, managed_instance_name, filter:filter, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_instance_as_lazy(resource_group_name, managed_instance_name, filter: nil, custom_headers: nil) ⇒ ManagedInstanceKeyListResult

Gets a list of managed instance keys.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. the collection. will be added to the HTTP request.

the response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • managed_instance_name (String) —

    The name of the managed instance.

  • filter (String) (defaults to: nil) —

    An OData filter expression that filters elements in

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

    A hash of custom headers that

Returns:

  • (ManagedInstanceKeyListResult) —

    which provide lazy access to pages of



667
668
669
670
671
672
673
674
675
676
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb', line 667

def list_by_instance_as_lazy(resource_group_name, managed_instance_name, filter:nil, custom_headers:nil)
  response = list_by_instance_async(resource_group_name, managed_instance_name, filter:filter, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_instance_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_instance_async(resource_group_name, managed_instance_name, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets a list of managed instance keys.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. the collection. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • managed_instance_name (String) —

    The name of the managed instance.

  • filter (String) (defaults to: nil) —

    An OData filter expression that filters elements in

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb', line 78

def list_by_instance_async(resource_group_name, managed_instance_name, filter:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'managed_instance_name is nil' if managed_instance_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.Sql/managedInstances/{managedInstanceName}/keys'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'managedInstanceName' => managed_instance_name,'subscriptionId' => @client.subscription_id},
      query_params: {'$filter' => filter,'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::SQL::Mgmt::V2017_10_01_preview::Models::ManagedInstanceKeyListResult.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_by_instance_next(next_page_link, custom_headers: nil) ⇒ ManagedInstanceKeyListResult

Gets a list of managed instance 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:

  • (ManagedInstanceKeyListResult) —

    operation results.



572
573
574
575
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb', line 572

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

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

Gets a list of managed instance 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.



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
641
642
643
644
645
646
647
648
649
650
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb', line 601

def list_by_instance_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::SQL::Mgmt::V2017_10_01_preview::Models::ManagedInstanceKeyListResult.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_by_instance_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of managed instance 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.



587
588
589
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb', line 587

def list_by_instance_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_instance_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_instance_with_http_info(resource_group_name, managed_instance_name, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of managed instance keys.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. the collection. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • managed_instance_name (String) —

    The name of the managed instance.

  • filter (String) (defaults to: nil) —

    An OData filter expression that filters elements in

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



60
61
62
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/managed_instance_keys.rb', line 60

def list_by_instance_with_http_info(resource_group_name, managed_instance_name, filter:nil, custom_headers:nil)
  list_by_instance_async(resource_group_name, managed_instance_name, filter:filter, custom_headers:custom_headers).value!
end