Class: Azure::StorageCache::Mgmt::V2019_08_01_preview::StorageTargets

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb

Overview

A Storage Cache provides scalable caching service for NAS clients, serving data from either NFSv3 or Blob at-rest storage (referred to as “Storage Targets”). These operations allow you to manage caches.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ StorageTargets

Creates and initializes a new instance of the StorageTargets class.

Parameters:

  • client —

    service class for accessing basic functionality.



19
20
21
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 19

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ StorageCacheManagementClient (readonly)

Returns reference to the StorageCacheManagementClient.

Returns:



24
25
26
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 24

def client
  @client
end

Instance Method Details

#begin_create(resource_group_name, cache_name, storage_target_name, storagetarget: nil, custom_headers: nil) ⇒ StorageTarget

Create/update a storage target. This operation is allowed at any time, but if the cache is down or unhealthy, the actual creation/modification of the storage target may be delayed until the cache is healthy again.

storage target. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Target resource group.

  • cache_name (String) —

    Name of cache.

  • storage_target_name (String) —

    Name of storage target.

  • storagetarget (StorageTarget) (defaults to: nil) —

    Object containing the definition of a

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

    A hash of custom headers that

Returns:

  • (StorageTarget) —

    operation results.



557
558
559
560
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 557

def begin_create(resource_group_name, cache_name, storage_target_name, storagetarget:nil, custom_headers:nil)
  response = begin_create_async(resource_group_name, cache_name, storage_target_name, storagetarget:storagetarget, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_async(resource_group_name, cache_name, storage_target_name, storagetarget: nil, custom_headers: nil) ⇒ Concurrent::Promise

Create/update a storage target. This operation is allowed at any time, but if the cache is down or unhealthy, the actual creation/modification of the storage target may be delayed until the cache is healthy again.

storage target. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Target resource group.

  • cache_name (String) —

    Name of cache.

  • storage_target_name (String) —

    Name of storage target.

  • storagetarget (StorageTarget) (defaults to: nil) —

    Object containing the definition of a

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 596

def begin_create_async(resource_group_name, cache_name, storage_target_name, storagetarget:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'cache_name is nil' if cache_name.nil?
  fail ArgumentError, "'cache_name' should satisfy the constraint - 'Pattern': '^[-0-9a-zA-Z_]{1,31}$'" if !cache_name.nil? && cache_name.match(Regexp.new('^^[-0-9a-zA-Z_]{1,31}$$')).nil?
  fail ArgumentError, 'storage_target_name is nil' if storage_target_name.nil?
  fail ArgumentError, "'storage_target_name' should satisfy the constraint - 'Pattern': '^[-0-9a-zA-Z_]{1,31}$'" if !storage_target_name.nil? && storage_target_name.match(Regexp.new('^^[-0-9a-zA-Z_]{1,31}$$')).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::StorageCache::Mgmt::V2019_08_01_preview::Models::StorageTarget.mapper()
  request_content = @client.serialize(request_mapper,  storagetarget)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'subscriptionId' => @client.subscription_id,'cacheName' => cache_name,'storageTargetName' => storage_target_name},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 201
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::StorageCache::Mgmt::V2019_08_01_preview::Models::StorageTarget.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::StorageCache::Mgmt::V2019_08_01_preview::Models::StorageTarget.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, cache_name, storage_target_name, storagetarget: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Create/update a storage target. This operation is allowed at any time, but if the cache is down or unhealthy, the actual creation/modification of the storage target may be delayed until the cache is healthy again.

storage target. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Target resource group.

  • cache_name (String) —

    Name of cache.

  • storage_target_name (String) —

    Name of storage target.

  • storagetarget (StorageTarget) (defaults to: nil) —

    Object containing the definition of a

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



577
578
579
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 577

def begin_create_with_http_info(resource_group_name, cache_name, storage_target_name, storagetarget:nil, custom_headers:nil)
  begin_create_async(resource_group_name, cache_name, storage_target_name, storagetarget:storagetarget, custom_headers:custom_headers).value!
end

#begin_delete(resource_group_name, cache_name, storage_target_name, custom_headers: nil) ⇒ Object

Removes a storage target from a cache. This operation is allowed at any time, but if the cache is down or unhealthy, the actual removal of the storage target may be delayed until the cache is healthy again.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Target resource group.

  • cache_name (String) —

    Name of cache.

  • storage_target_name (String) —

    Name of storage target.

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

    A hash of custom headers that

Returns:

  • (Object) —

    operation results.



459
460
461
462
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 459

def begin_delete(resource_group_name, cache_name, storage_target_name, custom_headers:nil)
  response = begin_delete_async(resource_group_name, cache_name, storage_target_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_delete_async(resource_group_name, cache_name, storage_target_name, custom_headers: nil) ⇒ Concurrent::Promise

Removes a storage target from a cache. This operation is allowed at any time, but if the cache is down or unhealthy, the actual removal of the storage target may be delayed until the cache is healthy again.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Target resource group.

  • cache_name (String) —

    Name of cache.

  • storage_target_name (String) —

    Name of storage target.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 494

def begin_delete_async(resource_group_name, cache_name, storage_target_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'cache_name is nil' if cache_name.nil?
  fail ArgumentError, "'cache_name' should satisfy the constraint - 'Pattern': '^[-0-9a-zA-Z_]{1,31}$'" if !cache_name.nil? && cache_name.match(Regexp.new('^^[-0-9a-zA-Z_]{1,31}$$')).nil?
  fail ArgumentError, 'storage_target_name is nil' if storage_target_name.nil?
  fail ArgumentError, "'storage_target_name' should satisfy the constraint - 'Pattern': '^[-0-9a-zA-Z_]{1,31}$'" if !storage_target_name.nil? && storage_target_name.match(Regexp.new('^^[-0-9a-zA-Z_]{1,31}$$')).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.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'subscriptionId' => @client.subscription_id,'cacheName' => cache_name,'storageTargetName' => storage_target_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202 || status_code == 204
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#begin_delete_with_http_info(resource_group_name, cache_name, storage_target_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Removes a storage target from a cache. This operation is allowed at any time, but if the cache is down or unhealthy, the actual removal of the storage target may be delayed until the cache is healthy again.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Target resource group.

  • cache_name (String) —

    Name of cache.

  • storage_target_name (String) —

    Name of storage target.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



477
478
479
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 477

def begin_delete_with_http_info(resource_group_name, cache_name, storage_target_name, custom_headers:nil)
  begin_delete_async(resource_group_name, cache_name, storage_target_name, custom_headers:custom_headers).value!
end

#create(resource_group_name, cache_name, storage_target_name, storagetarget: nil, custom_headers: nil) ⇒ StorageTarget

Create/update a storage target. This operation is allowed at any time, but if the cache is down or unhealthy, the actual creation/modification of the storage target may be delayed until the cache is healthy again.

storage target. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Target resource group.

  • cache_name (String) —

    Name of cache.

  • storage_target_name (String) —

    Name of storage target.

  • storagetarget (StorageTarget) (defaults to: nil) —

    Object containing the definition of a

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

    A hash of custom headers that

Returns:

  • (StorageTarget) —

    operation results.



292
293
294
295
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 292

def create(resource_group_name, cache_name, storage_target_name, storagetarget:nil, custom_headers:nil)
  response = create_async(resource_group_name, cache_name, storage_target_name, storagetarget:storagetarget, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_async(resource_group_name, cache_name, storage_target_name, storagetarget: nil, custom_headers: nil) ⇒ Concurrent::Promise

storage target. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    Target resource group.

  • cache_name (String) —

    Name of cache.

  • storage_target_name (String) —

    Name of storage target.

  • storagetarget (StorageTarget) (defaults to: nil) —

    Object containing the definition of a

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 309

def create_async(resource_group_name, cache_name, storage_target_name, storagetarget:nil, custom_headers:nil)
  # Send request
  promise = begin_create_async(resource_group_name, cache_name, storage_target_name, storagetarget:storagetarget, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::StorageCache::Mgmt::V2019_08_01_preview::Models::StorageTarget.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, cache_name, storage_target_name, custom_headers: nil) ⇒ Object

Removes a storage target from a cache. This operation is allowed at any time, but if the cache is down or unhealthy, the actual removal of the storage target may be delayed until the cache is healthy again.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Target resource group.

  • cache_name (String) —

    Name of cache.

  • storage_target_name (String) —

    Name of storage target.

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

    A hash of custom headers that

Returns:

  • (Object) —

    operation results.



137
138
139
140
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 137

def delete(resource_group_name, cache_name, storage_target_name, custom_headers:nil)
  response = delete_async(resource_group_name, cache_name, storage_target_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#delete_async(resource_group_name, cache_name, storage_target_name, custom_headers: nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    Target resource group.

  • cache_name (String) —

    Name of cache.

  • storage_target_name (String) —

    Name of storage target.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 152

def delete_async(resource_group_name, cache_name, storage_target_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, cache_name, storage_target_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = {
        client_side_validation: true,
        required: false,
        serialized_name: 'parsed_response',
        type: {
          name: 'Object'
        }
      }
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

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

  promise
end

#get(resource_group_name, cache_name, storage_target_name, custom_headers: nil) ⇒ StorageTarget

Returns a storage target from a cache.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Target resource group.

  • cache_name (String) —

    Name of cache.

  • storage_target_name (String) —

    Name of storage target.

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

    A hash of custom headers that

Returns:

  • (StorageTarget) —

    operation results.



188
189
190
191
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 188

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

#get_async(resource_group_name, cache_name, storage_target_name, custom_headers: nil) ⇒ Concurrent::Promise

Returns a storage target from a cache.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Target resource group.

  • cache_name (String) —

    Name of cache.

  • storage_target_name (String) —

    Name of storage target.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 219

def get_async(resource_group_name, cache_name, storage_target_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'cache_name is nil' if cache_name.nil?
  fail ArgumentError, "'cache_name' should satisfy the constraint - 'Pattern': '^[-0-9a-zA-Z_]{1,31}$'" if !cache_name.nil? && cache_name.match(Regexp.new('^^[-0-9a-zA-Z_]{1,31}$$')).nil?
  fail ArgumentError, 'storage_target_name is nil' if storage_target_name.nil?
  fail ArgumentError, "'storage_target_name' should satisfy the constraint - 'Pattern': '^[-0-9a-zA-Z_]{1,31}$'" if !storage_target_name.nil? && storage_target_name.match(Regexp.new('^^[-0-9a-zA-Z_]{1,31}$$')).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.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'subscriptionId' => @client.subscription_id,'cacheName' => cache_name,'storageTargetName' => storage_target_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::StorageCache::Mgmt::V2019_08_01_preview::Models::StorageTarget.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, cache_name, storage_target_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Returns a storage target from a cache.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Target resource group.

  • cache_name (String) —

    Name of cache.

  • storage_target_name (String) —

    Name of storage target.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



204
205
206
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 204

def get_with_http_info(resource_group_name, cache_name, storage_target_name, custom_headers:nil)
  get_async(resource_group_name, cache_name, storage_target_name, custom_headers:custom_headers).value!
end

#list_by_cache(resource_group_name, cache_name, custom_headers: nil) ⇒ Array<StorageTarget>

Returns the StorageTargets for this cache in the subscription and resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Target resource group.

  • cache_name (String) —

    Name of cache.

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

    A hash of custom headers that

Returns:

  • (Array<StorageTarget>) —

    operation results.



37
38
39
40
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 37

def list_by_cache(resource_group_name, cache_name, custom_headers:nil)
  first_page = list_by_cache_as_lazy(resource_group_name, cache_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_cache_as_lazy(resource_group_name, cache_name, custom_headers: nil) ⇒ StorageTargetsResult

Returns the StorageTargets for this cache in the subscription and resource group.

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    Target resource group.

  • cache_name (String) —

    Name of cache.

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

    A hash of custom headers that

Returns:

  • (StorageTargetsResult) —

    which provide lazy access to pages of the



776
777
778
779
780
781
782
783
784
785
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 776

def list_by_cache_as_lazy(resource_group_name, cache_name, custom_headers:nil)
  response = list_by_cache_async(resource_group_name, cache_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_cache_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_cache_async(resource_group_name, cache_name, custom_headers: nil) ⇒ Concurrent::Promise

Returns the StorageTargets for this cache in the subscription and resource group.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Target resource group.

  • cache_name (String) —

    Name of cache.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



68
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
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 68

def list_by_cache_async(resource_group_name, cache_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'cache_name is nil' if cache_name.nil?
  fail ArgumentError, "'cache_name' should satisfy the constraint - 'Pattern': '^[-0-9a-zA-Z_]{1,31}$'" if !cache_name.nil? && cache_name.match(Regexp.new('^^[-0-9a-zA-Z_]{1,31}$$')).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.StorageCache/caches/{cacheName}/storageTargets'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'subscriptionId' => @client.subscription_id,'cacheName' => cache_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::StorageCache::Mgmt::V2019_08_01_preview::Models::StorageTargetsResult.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_cache_next(next_page_link, custom_headers: nil) ⇒ StorageTargetsResult

Returns the StorageTargets for this cache in the subscription and resource group.

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (StorageTargetsResult) —

    operation results.



682
683
684
685
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 682

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

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

Returns the StorageTargets for this cache in the subscription and resource group.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 713

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


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

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

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::StorageCache::Mgmt::V2019_08_01_preview::Models::StorageTargetsResult.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_cache_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Returns the StorageTargets for this cache in the subscription and resource group.

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



698
699
700
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 698

def list_by_cache_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_cache_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_cache_with_http_info(resource_group_name, cache_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Returns the StorageTargets for this cache in the subscription and resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Target resource group.

  • cache_name (String) —

    Name of cache.

  • 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-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 53

def list_by_cache_with_http_info(resource_group_name, cache_name, custom_headers:nil)
  list_by_cache_async(resource_group_name, cache_name, custom_headers:custom_headers).value!
end

#update(resource_group_name, cache_name, storage_target_name, storagetarget: nil, custom_headers: nil) ⇒ StorageTarget

Update a storage target. This operation is allowed at any time, but if the cache is down or unhealthy, the actual creation/modification of the storage target may be delayed until the cache is healthy again.

storage target. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Target resource group.

  • cache_name (String) —

    Name of cache.

  • storage_target_name (String) —

    Name of storage target.

  • storagetarget (StorageTarget) (defaults to: nil) —

    Object containing the definition of a

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

    A hash of custom headers that

Returns:

  • (StorageTarget) —

    operation results.



342
343
344
345
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 342

def update(resource_group_name, cache_name, storage_target_name, storagetarget:nil, custom_headers:nil)
  response = update_async(resource_group_name, cache_name, storage_target_name, storagetarget:storagetarget, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_async(resource_group_name, cache_name, storage_target_name, storagetarget: nil, custom_headers: nil) ⇒ Concurrent::Promise

Update a storage target. This operation is allowed at any time, but if the cache is down or unhealthy, the actual creation/modification of the storage target may be delayed until the cache is healthy again.

storage target. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Target resource group.

  • cache_name (String) —

    Name of cache.

  • storage_target_name (String) —

    Name of storage target.

  • storagetarget (StorageTarget) (defaults to: nil) —

    Object containing the definition of a

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 381

def update_async(resource_group_name, cache_name, storage_target_name, storagetarget:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'cache_name is nil' if cache_name.nil?
  fail ArgumentError, "'cache_name' should satisfy the constraint - 'Pattern': '^[-0-9a-zA-Z_]{1,31}$'" if !cache_name.nil? && cache_name.match(Regexp.new('^^[-0-9a-zA-Z_]{1,31}$$')).nil?
  fail ArgumentError, 'storage_target_name is nil' if storage_target_name.nil?
  fail ArgumentError, "'storage_target_name' should satisfy the constraint - 'Pattern': '^[-0-9a-zA-Z_]{1,31}$'" if !storage_target_name.nil? && storage_target_name.match(Regexp.new('^^[-0-9a-zA-Z_]{1,31}$$')).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::StorageCache::Mgmt::V2019_08_01_preview::Models::StorageTarget.mapper()
  request_content = @client.serialize(request_mapper,  storagetarget)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'subscriptionId' => @client.subscription_id,'cacheName' => cache_name,'storageTargetName' => storage_target_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(:patch, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::StorageCache::Mgmt::V2019_08_01_preview::Models::StorageTarget.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

#update_with_http_info(resource_group_name, cache_name, storage_target_name, storagetarget: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Update a storage target. This operation is allowed at any time, but if the cache is down or unhealthy, the actual creation/modification of the storage target may be delayed until the cache is healthy again.

storage target. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Target resource group.

  • cache_name (String) —

    Name of cache.

  • storage_target_name (String) —

    Name of storage target.

  • storagetarget (StorageTarget) (defaults to: nil) —

    Object containing the definition of a

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



362
363
364
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_storagecache/storage_targets.rb', line 362

def update_with_http_info(resource_group_name, cache_name, storage_target_name, storagetarget:nil, custom_headers:nil)
  update_async(resource_group_name, cache_name, storage_target_name, storagetarget:storagetarget, custom_headers:custom_headers).value!
end