Class: Azure::StorageSync::Mgmt::V2019_03_01::RegisteredServers

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb

Overview

Microsoft Storage Sync Service API

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ RegisteredServers

Creates and initializes a new instance of the RegisteredServers class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ StorageSyncManagementClient (readonly)

Returns reference to the StorageSyncManagementClient.

Returns:



22
23
24
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers: nil) ⇒ RegisteredServer

Add a new registered server.

is case insensitive. resource. Server object. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • storage_sync_service_name (String) —

    Name of Storage Sync Service

  • server_id (String) —

    GUID identifying the on-premises server.

  • parameters (RegisteredServerCreateParameters) —

    Body of Registered

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

    A hash of custom headers that

Returns:

  • (RegisteredServer) —

    operation results.



395
396
397
398
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 395

def begin_create(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers:nil)
  response = begin_create_async(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_async(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Add a new registered server.

is case insensitive. resource. Server object. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • storage_sync_service_name (String) —

    Name of Storage Sync Service

  • server_id (String) —

    GUID identifying the on-premises server.

  • parameters (RegisteredServerCreateParameters) —

    Body of Registered

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 434

def begin_create_async(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers:nil)
  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, '@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, 'storage_sync_service_name is nil' if storage_sync_service_name.nil?
  fail ArgumentError, 'server_id is nil' if server_id.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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::StorageSync::Mgmt::V2019_03_01::Models::RegisteredServerCreateParameters.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.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}'

  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,'storageSyncServiceName' => storage_sync_service_name,'serverId' => server_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
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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::StorageSync::Mgmt::V2019_03_01::Models::RegisteredServer.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_with_http_info(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Add a new registered server.

is case insensitive. resource. Server object. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • storage_sync_service_name (String) —

    Name of Storage Sync Service

  • server_id (String) —

    GUID identifying the on-premises server.

  • parameters (RegisteredServerCreateParameters) —

    Body of Registered

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



415
416
417
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 415

def begin_create_with_http_info(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers:nil)
  begin_create_async(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers:custom_headers).value!
end

#begin_delete(resource_group_name, storage_sync_service_name, server_id, custom_headers: nil) ⇒ Object

Delete the given registered server.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • storage_sync_service_name (String) —

    Name of Storage Sync Service

  • server_id (String) —

    GUID identifying the on-premises server.

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

    A hash of custom headers that



515
516
517
518
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 515

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

#begin_delete_async(resource_group_name, storage_sync_service_name, server_id, custom_headers: nil) ⇒ Concurrent::Promise

Delete the given registered server.

is case insensitive. resource. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • storage_sync_service_name (String) —

    Name of Storage Sync Service

  • server_id (String) —

    GUID identifying the on-premises server.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 550

def begin_delete_async(resource_group_name, storage_sync_service_name, server_id, custom_headers:nil)
  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, '@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, 'storage_sync_service_name is nil' if storage_sync_service_name.nil?
  fail ArgumentError, 'server_id is nil' if server_id.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.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}'

  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,'storageSyncServiceName' => storage_sync_service_name,'serverId' => server_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 MsRest::HttpOperationError.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, storage_sync_service_name, server_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Delete the given registered server.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • storage_sync_service_name (String) —

    Name of Storage Sync Service

  • server_id (String) —

    GUID identifying the on-premises server.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



533
534
535
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 533

def begin_delete_with_http_info(resource_group_name, storage_sync_service_name, server_id, custom_headers:nil)
  begin_delete_async(resource_group_name, storage_sync_service_name, server_id, custom_headers:custom_headers).value!
end

#begin_trigger_rollover(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers: nil) ⇒ Object

Triggers Server certificate rollover.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • storage_sync_service_name (String) —

    Name of Storage Sync Service

  • server_id (String) —

    Server Id

  • parameters (TriggerRolloverRequest) —

    Body of Trigger Rollover request.

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

    A hash of custom headers that



614
615
616
617
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 614

def begin_trigger_rollover(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers:nil)
  response = begin_trigger_rollover_async(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers:custom_headers).value!
  nil
end

#begin_trigger_rollover_async(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Triggers Server certificate rollover.

is case insensitive. resource. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • storage_sync_service_name (String) —

    Name of Storage Sync Service

  • server_id (String) —

    Server Id

  • parameters (TriggerRolloverRequest) —

    Body of Trigger Rollover request.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 651

def begin_trigger_rollover_async(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers:nil)
  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, '@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, 'storage_sync_service_name is nil' if storage_sync_service_name.nil?
  fail ArgumentError, 'server_id is nil' if server_id.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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::StorageSync::Mgmt::V2019_03_01::Models::TriggerRolloverRequest.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.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}/triggerRollover'

  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,'storageSyncServiceName' => storage_sync_service_name,'serverId' => server_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(:post, 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 MsRest::HttpOperationError.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_trigger_rollover_with_http_info(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Triggers Server certificate rollover.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • storage_sync_service_name (String) —

    Name of Storage Sync Service

  • server_id (String) —

    Server Id

  • parameters (TriggerRolloverRequest) —

    Body of Trigger Rollover request.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



633
634
635
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 633

def begin_trigger_rollover_with_http_info(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers:nil)
  begin_trigger_rollover_async(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers:custom_headers).value!
end

#create(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers: nil) ⇒ RegisteredServer

Add a new registered server.

is case insensitive. resource. Server object. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • storage_sync_service_name (String) —

    Name of Storage Sync Service

  • server_id (String) —

    GUID identifying the on-premises server.

  • parameters (RegisteredServerCreateParameters) —

    Body of Registered

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

    A hash of custom headers that

Returns:

  • (RegisteredServer) —

    operation results.



253
254
255
256
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 253

def create(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers:nil)
  response = create_async(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_async(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers: nil) ⇒ Concurrent::Promise

is case insensitive. resource. Server object. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • storage_sync_service_name (String) —

    Name of Storage Sync Service

  • server_id (String) —

    GUID identifying the on-premises server.

  • parameters (RegisteredServerCreateParameters) —

    Body of Registered

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 272

def create_async(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers:nil)
  # Send request
  promise = begin_create_async(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::StorageSync::Mgmt::V2019_03_01::Models::RegisteredServer.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, storage_sync_service_name, server_id, custom_headers: nil) ⇒ Object

Delete the given registered server.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • storage_sync_service_name (String) —

    Name of Storage Sync Service

  • server_id (String) —

    GUID identifying the on-premises server.

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

    A hash of custom headers that



301
302
303
304
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 301

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

#delete_async(resource_group_name, storage_sync_service_name, server_id, custom_headers: nil) ⇒ Concurrent::Promise

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

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • storage_sync_service_name (String) —

    Name of Storage Sync Service

  • server_id (String) —

    GUID identifying the on-premises server.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 318

def delete_async(resource_group_name, storage_sync_service_name, server_id, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, storage_sync_service_name, server_id, 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, storage_sync_service_name, server_id, custom_headers: nil) ⇒ RegisteredServer

Get a given registered server.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • storage_sync_service_name (String) —

    Name of Storage Sync Service

  • server_id (String) —

    GUID identifying the on-premises server.

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

    A hash of custom headers that

Returns:

  • (RegisteredServer) —

    operation results.



142
143
144
145
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 142

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

#get_async(resource_group_name, storage_sync_service_name, server_id, custom_headers: nil) ⇒ Concurrent::Promise

Get a given registered server.

is case insensitive. resource. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • storage_sync_service_name (String) —

    Name of Storage Sync Service

  • server_id (String) —

    GUID identifying the on-premises server.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
234
235
236
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 177

def get_async(resource_group_name, storage_sync_service_name, server_id, custom_headers:nil)
  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, '@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, 'storage_sync_service_name is nil' if storage_sync_service_name.nil?
  fail ArgumentError, 'server_id is nil' if server_id.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.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}'

  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,'storageSyncServiceName' => storage_sync_service_name,'serverId' => server_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 MsRest::HttpOperationError.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::StorageSync::Mgmt::V2019_03_01::Models::RegisteredServer.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, storage_sync_service_name, server_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get a given registered server.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • storage_sync_service_name (String) —

    Name of Storage Sync Service

  • server_id (String) —

    GUID identifying the on-premises server.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



160
161
162
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 160

def get_with_http_info(resource_group_name, storage_sync_service_name, server_id, custom_headers:nil)
  get_async(resource_group_name, storage_sync_service_name, server_id, custom_headers:custom_headers).value!
end

#list_by_storage_sync_service(resource_group_name, storage_sync_service_name, custom_headers: nil) ⇒ RegisteredServerArray

Get a given registered server list.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • storage_sync_service_name (String) —

    Name of Storage Sync Service

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

    A hash of custom headers that

Returns:

  • (RegisteredServerArray) —

    operation results.



36
37
38
39
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 36

def list_by_storage_sync_service(resource_group_name, storage_sync_service_name, custom_headers:nil)
  response = list_by_storage_sync_service_async(resource_group_name, storage_sync_service_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_storage_sync_service_async(resource_group_name, storage_sync_service_name, custom_headers: nil) ⇒ Concurrent::Promise

Get a given registered server list.

is case insensitive. resource. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • storage_sync_service_name (String) —

    Name of Storage Sync Service

  • 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/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 69

def list_by_storage_sync_service_async(resource_group_name, storage_sync_service_name, custom_headers:nil)
  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, '@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, 'storage_sync_service_name is nil' if storage_sync_service_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.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers'

  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,'storageSyncServiceName' => storage_sync_service_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 MsRest::HttpOperationError.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::StorageSync::Mgmt::V2019_03_01::Models::RegisteredServerArray.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_storage_sync_service_with_http_info(resource_group_name, storage_sync_service_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get a given registered server list.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • storage_sync_service_name (String) —

    Name of Storage Sync Service

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



53
54
55
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 53

def list_by_storage_sync_service_with_http_info(resource_group_name, storage_sync_service_name, custom_headers:nil)
  list_by_storage_sync_service_async(resource_group_name, storage_sync_service_name, custom_headers:custom_headers).value!
end

#trigger_rollover(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers: nil) ⇒ Object

Triggers Server certificate rollover.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • storage_sync_service_name (String) —

    Name of Storage Sync Service

  • server_id (String) —

    Server Id

  • parameters (TriggerRolloverRequest) —

    Body of Trigger Rollover request.

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

    A hash of custom headers that



346
347
348
349
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 346

def trigger_rollover(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers:nil)
  response = trigger_rollover_async(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers:custom_headers).value!
  nil
end

#trigger_rollover_async(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers: nil) ⇒ Concurrent::Promise

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

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • storage_sync_service_name (String) —

    Name of Storage Sync Service

  • server_id (String) —

    Server Id

  • parameters (TriggerRolloverRequest) —

    Body of Trigger Rollover request.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/registered_servers.rb', line 364

def trigger_rollover_async(resource_group_name, storage_sync_service_name, server_id, parameters, custom_headers:nil)
  # Send request
  promise = begin_trigger_rollover_async(resource_group_name, storage_sync_service_name, server_id, parameters, 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