Class: Azure::StorageSync::Mgmt::V2018_04_02::RegisteredServers

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-04-02/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/2018-04-02/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/2018-04-02/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.



349
350
351
352
 
# File 'lib/2018-04-02/generated/azure_mgmt_storagesync/registered_servers.rb', line 349

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.



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/2018-04-02/generated/azure_mgmt_storagesync/registered_servers.rb', line 388

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::V2018_04_02::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::V2018_04_02::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.



369
370
371
 
# File 'lib/2018-04-02/generated/azure_mgmt_storagesync/registered_servers.rb', line 369

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



469
470
471
472
 
# File 'lib/2018-04-02/generated/azure_mgmt_storagesync/registered_servers.rb', line 469

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.



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
551
552
553
 
# File 'lib/2018-04-02/generated/azure_mgmt_storagesync/registered_servers.rb', line 504

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.



487
488
489
 
# File 'lib/2018-04-02/generated/azure_mgmt_storagesync/registered_servers.rb', line 487

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

#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/2018-04-02/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/2018-04-02/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::V2018_04_02::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/2018-04-02/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/2018-04-02/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/2018-04-02/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/2018-04-02/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::V2018_04_02::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/2018-04-02/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/2018-04-02/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/2018-04-02/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::V2018_04_02::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/2018-04-02/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