Class: Azure::StorageSync::Mgmt::V2019_03_01::SyncGroups

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

Overview

Microsoft Storage Sync Service API

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ SyncGroups

Creates and initializes a new instance of the SyncGroups class.



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

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ StorageSyncManagementClient (readonly) 



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

def client
  @client
end

Instance Method Details

#create(resource_group_name, storage_sync_service_name, sync_group_name, parameters, custom_headers: nil) ⇒ SyncGroup

Create a new SyncGroup.

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



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

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

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

Create a new SyncGroup.

is case insensitive. resource. to the HTTP request.



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
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/sync_groups.rb', line 180

def create_async(resource_group_name, storage_sync_service_name, sync_group_name, 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, 'sync_group_name is nil' if sync_group_name.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::SyncGroupCreateParameters.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}/syncGroups/{syncGroupName}'

  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,'syncGroupName' => sync_group_name},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      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::SyncGroup.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#create_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Create a new SyncGroup.

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



162
163
164
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/sync_groups.rb', line 162

def create_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, parameters, custom_headers:nil)
  create_async(resource_group_name, storage_sync_service_name, sync_group_name, parameters, custom_headers:custom_headers).value!
end

#delete(resource_group_name, storage_sync_service_name, sync_group_name, custom_headers: nil) ⇒ Object

Delete a given SyncGroup.

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



370
371
372
373
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/sync_groups.rb', line 370

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

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

Delete a given SyncGroup.

is case insensitive. resource. to the HTTP request.



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
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/sync_groups.rb', line 405

def delete_async(resource_group_name, storage_sync_service_name, sync_group_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?
  fail ArgumentError, 'sync_group_name is nil' if sync_group_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}/syncGroups/{syncGroupName}'

  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,'syncGroupName' => sync_group_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 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

#delete_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Delete a given SyncGroup.

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



388
389
390
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/sync_groups.rb', line 388

def delete_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, custom_headers:nil)
  delete_async(resource_group_name, storage_sync_service_name, sync_group_name, custom_headers:custom_headers).value!
end

#get(resource_group_name, storage_sync_service_name, sync_group_name, custom_headers: nil) ⇒ SyncGroup

Get a given SyncGroup.

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



262
263
264
265
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/sync_groups.rb', line 262

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

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

Get a given SyncGroup.

is case insensitive. resource. to the HTTP request.



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/sync_groups.rb', line 297

def get_async(resource_group_name, storage_sync_service_name, sync_group_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?
  fail ArgumentError, 'sync_group_name is nil' if sync_group_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}/syncGroups/{syncGroupName}'

  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,'syncGroupName' => sync_group_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::SyncGroup.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, sync_group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get a given SyncGroup.

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



280
281
282
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/sync_groups.rb', line 280

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

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

Get a SyncGroup List.

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



36
37
38
39
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/sync_groups.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 SyncGroup List.

is case insensitive. resource. to the HTTP request.



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/sync_groups.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}/syncGroups'

  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::SyncGroupArray.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 SyncGroup List.

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



53
54
55
 
# File 'lib/2019-03-01/generated/azure_mgmt_storagesync/sync_groups.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