Class: Azure::NetApp::Mgmt::V2019_11_01::NetAppResource

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-11-01/generated/azure_mgmt_netapp/net_app_resource.rb

Overview

Microsoft NetApp Azure Resource Provider specification

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ NetAppResource

Creates and initializes a new instance of the NetAppResource class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2019-11-01/generated/azure_mgmt_netapp/net_app_resource.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ AzureNetAppFilesManagementClient (readonly)

Returns reference to the AzureNetAppFilesManagementClient.

Returns:



22
23
24
 
# File 'lib/2019-11-01/generated/azure_mgmt_netapp/net_app_resource.rb', line 22

def client
  @client
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.



175
176
177
178
 
# File 'lib/2019-11-01/generated/azure_mgmt_netapp/net_app_resource.rb', line 175

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.



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
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/2019-11-01/generated/azure_mgmt_netapp/net_app_resource.rb', line 220

def check_file_path_availability_async(location, name, type, resource_group, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'location is nil' if location.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.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'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::NetApp::Mgmt::V2019_11_01::Models::ResourceNameAvailabilityRequest.mapper()
  request_content = @client.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 || @client.base_url

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

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

#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.



198
199
200
 
# File 'lib/2019-11-01/generated/azure_mgmt_netapp/net_app_resource.rb', line 198

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.



42
43
44
45
 
# File 'lib/2019-11-01/generated/azure_mgmt_netapp/net_app_resource.rb', line 42

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.



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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/2019-11-01/generated/azure_mgmt_netapp/net_app_resource.rb', line 87

def check_name_availability_async(location, name, type, resource_group, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'location is nil' if location.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.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'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::NetApp::Mgmt::V2019_11_01::Models::ResourceNameAvailabilityRequest.mapper()
  request_content = @client.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 || @client.base_url

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

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

#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.



65
66
67
 
# File 'lib/2019-11-01/generated/azure_mgmt_netapp/net_app_resource.rb', line 65

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