Class: Azure::NetApp::Mgmt::V2019_07_01::AzureNetAppFilesManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb

Overview

A service client - single point of access to the REST API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials = nil, base_url = nil, options = nil) ⇒ AzureNetAppFilesManagementClient

Creates initializes a new instance of the AzureNetAppFilesManagementClient class.

Parameters:

  • credentials (MsRest::ServiceClientCredentials) (defaults to: nil) —

    credentials to authorize HTTP requests made by the service client.

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

    the base URI of the service.

  • options (Array) (defaults to: nil) —

    filters to be applied to the HTTP requests.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 64

def initialize(credentials = nil, base_url = nil, options = nil)
  super(credentials, options)
  @base_url = base_url || 'https://management.azure.com'

  fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
  @credentials = credentials

  @operations = Operations.new(self)
  @accounts = Accounts.new(self)
  @pools = Pools.new(self)
  @volumes = Volumes.new(self)
  @mount_targets = MountTargets.new(self)
  @snapshots = Snapshots.new(self)
  @api_version = '2019-07-01'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Instance Attribute Details

#accept_language ⇒ String

Returns The preferred language for the response.

Returns:

  • (String) —

    The preferred language for the response.



29
30
31
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 29

def accept_language
  @accept_language
end

#accounts ⇒ Accounts (readonly)

Returns accounts.

Returns:



44
45
46
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 44

def accounts
  @accounts
end

#api_version ⇒ String (readonly)

Returns Version of the API to be used with the client request.

Returns:

  • (String) —

    Version of the API to be used with the client request.



26
27
28
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 26

def api_version
  @api_version
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 15

def base_url
  @base_url
end

#credentials ⇒ Object (readonly)

Returns Credentials needed for the client to connect to Azure.

Returns:

  • Credentials needed for the client to connect to Azure.



18
19
20
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 18

def credentials
  @credentials
end

#generate_client_request_id ⇒ Boolean

generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    Whether a unique x-ms-client-request-id should be



38
39
40
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 38

def generate_client_request_id
  @generate_client_request_id
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



33
34
35
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 33

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#mount_targets ⇒ MountTargets (readonly)

Returns mount_targets.

Returns:



53
54
55
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 53

def mount_targets
  @mount_targets
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



41
42
43
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 41

def operations
  @operations
end

#pools ⇒ Pools (readonly)

Returns pools.

Returns:



47
48
49
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 47

def pools
  @pools
end

#snapshots ⇒ Snapshots (readonly)

Returns snapshots.

Returns:



56
57
58
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 56

def snapshots
  @snapshots
end

#subscription_id ⇒ String

Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Returns:

  • (String) —

    Subscription credentials which uniquely identify



23
24
25
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 23

def subscription_id
  @subscription_id
end

#volumes ⇒ Volumes (readonly)

Returns volumes.

Returns:



50
51
52
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 50

def volumes
  @volumes
end

Instance Method Details

#check_file_path_availability(location, name, type, resource_group, custom_headers: nil) ⇒ ResourceNameAvailability

Check file path availability

Check if a file path is available.

Possible values include: ‘Microsoft.NetApp/netAppAccounts’, ‘Microsoft.NetApp/netAppAccounts/capacityPools’, ‘Microsoft.NetApp/netAppAccounts/capacityPools/volumes’, ‘Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots’ will be added to the HTTP request.

Parameters:

  • location (String) —

    The location

  • name (String) —

    Resource name to verify.

  • type (CheckNameResourceTypes) —

    Resource type used for verification.

  • resource_group (String) —

    Resource group name.

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

    A hash of custom headers that

Returns:

  • (ResourceNameAvailability) —

    operation results.



293
294
295
296
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 293

def check_file_path_availability(location, name, type, resource_group, custom_headers:nil)
  response = check_file_path_availability_async(location, name, type, resource_group, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#check_file_path_availability_async(location, name, type, resource_group, custom_headers: nil) ⇒ Concurrent::Promise

Check file path availability

Check if a file path is available.

Possible values include: ‘Microsoft.NetApp/netAppAccounts’, ‘Microsoft.NetApp/netAppAccounts/capacityPools’, ‘Microsoft.NetApp/netAppAccounts/capacityPools/volumes’, ‘Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots’ to the HTTP request.

Parameters:

  • location (String) —

    The location

  • name (String) —

    Resource name to verify.

  • type (CheckNameResourceTypes) —

    Resource type used for verification.

  • resource_group (String) —

    Resource group name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
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
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 338

def check_file_path_availability_async(location, name, type, resource_group, custom_headers:nil)
  fail ArgumentError, 'subscription_id is nil' if subscription_id.nil?
  fail ArgumentError, 'location is nil' if location.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'name is nil' if name.nil?
  fail ArgumentError, 'type is nil' if type.nil?
  fail ArgumentError, 'resource_group is nil' if resource_group.nil?

  body = ResourceNameAvailabilityRequest.new
  unless name.nil? && type.nil? && resource_group.nil?
    body.name = name
    body.type = type
    body.resource_group = resource_group
  end

  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'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::NetApp::Mgmt::V2019_07_01::Models::ResourceNameAvailabilityRequest.mapper()
  request_content = self.serialize(request_mapper,  body)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkFilePathAvailability'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => subscription_id,'location' => location},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      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::NetApp::Mgmt::V2019_07_01::Models::ResourceNameAvailability.mapper()
        result.body = self.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

#check_file_path_availability_with_http_info(location, name, type, resource_group, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Check file path availability

Check if a file path is available.

Possible values include: ‘Microsoft.NetApp/netAppAccounts’, ‘Microsoft.NetApp/netAppAccounts/capacityPools’, ‘Microsoft.NetApp/netAppAccounts/capacityPools/volumes’, ‘Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots’ will be added to the HTTP request.

Parameters:

  • location (String) —

    The location

  • name (String) —

    Resource name to verify.

  • type (CheckNameResourceTypes) —

    Resource type used for verification.

  • resource_group (String) —

    Resource group name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



316
317
318
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 316

def check_file_path_availability_with_http_info(location, name, type, resource_group, custom_headers:nil)
  check_file_path_availability_async(location, name, type, resource_group, custom_headers:custom_headers).value!
end

#check_name_availability(location, name, type, resource_group, custom_headers: nil) ⇒ ResourceNameAvailability

Check resource name availability

Check if a resource name is available.

Possible values include: ‘Microsoft.NetApp/netAppAccounts’, ‘Microsoft.NetApp/netAppAccounts/capacityPools’, ‘Microsoft.NetApp/netAppAccounts/capacityPools/volumes’, ‘Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots’ will be added to the HTTP request.

Parameters:

  • location (String) —

    The location

  • name (String) —

    Resource name to verify.

  • type (CheckNameResourceTypes) —

    Resource type used for verification.

  • resource_group (String) —

    Resource group name.

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

    A hash of custom headers that

Returns:

  • (ResourceNameAvailability) —

    operation results.



160
161
162
163
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 160

def check_name_availability(location, name, type, resource_group, custom_headers:nil)
  response = check_name_availability_async(location, name, type, resource_group, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#check_name_availability_async(location, name, type, resource_group, custom_headers: nil) ⇒ Concurrent::Promise

Check resource name availability

Check if a resource name is available.

Possible values include: ‘Microsoft.NetApp/netAppAccounts’, ‘Microsoft.NetApp/netAppAccounts/capacityPools’, ‘Microsoft.NetApp/netAppAccounts/capacityPools/volumes’, ‘Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots’ to the HTTP request.

Parameters:

  • location (String) —

    The location

  • name (String) —

    Resource name to verify.

  • type (CheckNameResourceTypes) —

    Resource type used for verification.

  • resource_group (String) —

    Resource group name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
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
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 205

def check_name_availability_async(location, name, type, resource_group, custom_headers:nil)
  fail ArgumentError, 'subscription_id is nil' if subscription_id.nil?
  fail ArgumentError, 'location is nil' if location.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'name is nil' if name.nil?
  fail ArgumentError, 'type is nil' if type.nil?
  fail ArgumentError, 'resource_group is nil' if resource_group.nil?

  body = ResourceNameAvailabilityRequest.new
  unless name.nil? && type.nil? && resource_group.nil?
    body.name = name
    body.type = type
    body.resource_group = resource_group
  end

  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'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::NetApp::Mgmt::V2019_07_01::Models::ResourceNameAvailabilityRequest.mapper()
  request_content = self.serialize(request_mapper,  body)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkNameAvailability'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => subscription_id,'location' => location},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      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::NetApp::Mgmt::V2019_07_01::Models::ResourceNameAvailability.mapper()
        result.body = self.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

#check_name_availability_with_http_info(location, name, type, resource_group, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Check resource name availability

Check if a resource name is available.

Possible values include: ‘Microsoft.NetApp/netAppAccounts’, ‘Microsoft.NetApp/netAppAccounts/capacityPools’, ‘Microsoft.NetApp/netAppAccounts/capacityPools/volumes’, ‘Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots’ will be added to the HTTP request.

Parameters:

  • location (String) —

    The location

  • name (String) —

    Resource name to verify.

  • type (CheckNameResourceTypes) —

    Resource type used for verification.

  • resource_group (String) —

    Resource group name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



183
184
185
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 183

def check_name_availability_with_http_info(location, name, type, resource_group, custom_headers:nil)
  check_name_availability_async(location, name, type, resource_group, custom_headers:custom_headers).value!
end

#make_request(method, path, options = {}) ⇒ Hash{String=>String}

Makes a request and returns the body of the response. Example:

request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
path = "/path"
options = {
  body: request_content,
  query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, options)

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Hash{String=>String}) —

    containing the body of the response.



100
101
102
103
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 100

def make_request(method, path, options = {})
  result = make_request_with_http_info(method, path, options)
  result.body unless result.nil?
end

#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise

Makes a request asynchronously.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 125

def make_request_async(method, path, options = {})
  fail ArgumentError, 'method is nil' if method.nil?
  fail ArgumentError, 'path is nil' if path.nil?

  request_url = options[:base_url] || @base_url
  if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
    @request_headers['Content-Type'] = options[:headers]['Content-Type']
  end

  request_headers = @request_headers
  request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
  options.merge!({headers: request_headers.merge(options[:headers] || {})})
  options.merge!({credentials: @credentials}) unless @credentials.nil?

  super(request_url, method, path, options)
end

#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse

Makes a request and returns the operation response.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    Operation response containing the request, response and status.



112
113
114
115
116
 
# File 'lib/2019-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 112

def make_request_with_http_info(method, path, options = {})
  result = make_request_async(method, path, options).value!
  result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
  result
end