Class: Azure::RecoveryServicesBackup::Mgmt::V2020_02_02::PrivateEndpointConnectionOperations

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-02-02/generated/azure_mgmt_recovery_services_backup/private_endpoint_connection_operations.rb

Overview

PrivateEndpointConnectionOperations

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ PrivateEndpointConnectionOperations

Creates and initializes a new instance of the PrivateEndpointConnectionOperations class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2020-02-02/generated/azure_mgmt_recovery_services_backup/private_endpoint_connection_operations.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ RecoveryServicesBackupClient (readonly)

Returns reference to the RecoveryServicesBackupClient.

Returns:



22
23
24
 
# File 'lib/2020-02-02/generated/azure_mgmt_recovery_services_backup/private_endpoint_connection_operations.rb', line 22

def client
  @client
end

Instance Method Details

#begin_delete(vault_name, resource_group_name, private_endpoint_connection_name, custom_headers: nil) ⇒ Object

Delete Private Endpoint requests. This call is made by Backup Admin.

recovery services vault is present. endpoint connection. will be added to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the recovery services vault.

  • resource_group_name (String) —

    The name of the resource group where the

  • private_endpoint_connection_name (String) —

    The name of the private

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

    A hash of custom headers that



368
369
370
371
 
# File 'lib/2020-02-02/generated/azure_mgmt_recovery_services_backup/private_endpoint_connection_operations.rb', line 368

def begin_delete(vault_name, resource_group_name, private_endpoint_connection_name, custom_headers:nil)
  response = begin_delete_async(vault_name, resource_group_name, private_endpoint_connection_name, custom_headers:custom_headers).value!
  nil
end

#begin_delete_async(vault_name, resource_group_name, private_endpoint_connection_name, custom_headers: nil) ⇒ Concurrent::Promise

Delete Private Endpoint requests. This call is made by Backup Admin.

recovery services vault is present. endpoint connection. to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the recovery services vault.

  • resource_group_name (String) —

    The name of the resource group where the

  • private_endpoint_connection_name (String) —

    The name of the private

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/2020-02-02/generated/azure_mgmt_recovery_services_backup/private_endpoint_connection_operations.rb', line 403

def begin_delete_async(vault_name, resource_group_name, private_endpoint_connection_name, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'vault_name is nil' if vault_name.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'private_endpoint_connection_name is nil' if private_endpoint_connection_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.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'vaultName' => vault_name,'resourceGroupName' => resource_group_name,'subscriptionId' => @client.subscription_id,'privateEndpointConnectionName' => private_endpoint_connection_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 MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

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

    result
  end

  promise.execute
end

#begin_delete_with_http_info(vault_name, resource_group_name, private_endpoint_connection_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Delete Private Endpoint requests. This call is made by Backup Admin.

recovery services vault is present. endpoint connection. will be added to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the recovery services vault.

  • resource_group_name (String) —

    The name of the resource group where the

  • private_endpoint_connection_name (String) —

    The name of the private

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



386
387
388
 
# File 'lib/2020-02-02/generated/azure_mgmt_recovery_services_backup/private_endpoint_connection_operations.rb', line 386

def begin_delete_with_http_info(vault_name, resource_group_name, private_endpoint_connection_name, custom_headers:nil)
  begin_delete_async(vault_name, resource_group_name, private_endpoint_connection_name, custom_headers:custom_headers).value!
end

#begin_put(vault_name, resource_group_name, private_endpoint_connection_name, parameters, custom_headers: nil) ⇒ PrivateEndpointConnectionResource

Approve or Reject Private Endpoint requests. This call is made by Backup Admin.

recovery services vault is present. endpoint connection. operation will be added to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the recovery services vault.

  • resource_group_name (String) —

    The name of the resource group where the

  • private_endpoint_connection_name (String) —

    The name of the private

  • parameters (PrivateEndpointConnectionResource) —

    Request body for

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

    A hash of custom headers that

Returns:

  • (PrivateEndpointConnectionResource) —

    operation results.



241
242
243
244
 
# File 'lib/2020-02-02/generated/azure_mgmt_recovery_services_backup/private_endpoint_connection_operations.rb', line 241

def begin_put(vault_name, resource_group_name, private_endpoint_connection_name, parameters, custom_headers:nil)
  response = begin_put_async(vault_name, resource_group_name, private_endpoint_connection_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_put_async(vault_name, resource_group_name, private_endpoint_connection_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Approve or Reject Private Endpoint requests. This call is made by Backup Admin.

recovery services vault is present. endpoint connection. operation to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the recovery services vault.

  • resource_group_name (String) —

    The name of the resource group where the

  • private_endpoint_connection_name (String) —

    The name of the private

  • parameters (PrivateEndpointConnectionResource) —

    Request body for

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
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
 
# File 'lib/2020-02-02/generated/azure_mgmt_recovery_services_backup/private_endpoint_connection_operations.rb', line 282

def begin_put_async(vault_name, resource_group_name, private_endpoint_connection_name, parameters, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'vault_name is nil' if vault_name.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'private_endpoint_connection_name is nil' if private_endpoint_connection_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::RecoveryServicesBackup::Mgmt::V2020_02_02::Models::PrivateEndpointConnectionResource.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.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'vaultName' => vault_name,'resourceGroupName' => resource_group_name,'subscriptionId' => @client.subscription_id,'privateEndpointConnectionName' => private_endpoint_connection_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::RecoveryServicesBackup::Mgmt::V2020_02_02::Models::PrivateEndpointConnectionResource.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::RecoveryServicesBackup::Mgmt::V2020_02_02::Models::PrivateEndpointConnectionResource.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_put_with_http_info(vault_name, resource_group_name, private_endpoint_connection_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Approve or Reject Private Endpoint requests. This call is made by Backup Admin.

recovery services vault is present. endpoint connection. operation will be added to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the recovery services vault.

  • resource_group_name (String) —

    The name of the resource group where the

  • private_endpoint_connection_name (String) —

    The name of the private

  • parameters (PrivateEndpointConnectionResource) —

    Request body for

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



262
263
264
 
# File 'lib/2020-02-02/generated/azure_mgmt_recovery_services_backup/private_endpoint_connection_operations.rb', line 262

def begin_put_with_http_info(vault_name, resource_group_name, private_endpoint_connection_name, parameters, custom_headers:nil)
  begin_put_async(vault_name, resource_group_name, private_endpoint_connection_name, parameters, custom_headers:custom_headers).value!
end

#delete(vault_name, resource_group_name, private_endpoint_connection_name, custom_headers: nil) ⇒ Object

Delete Private Endpoint requests. This call is made by Backup Admin.

recovery services vault is present. endpoint connection. will be added to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the recovery services vault.

  • resource_group_name (String) —

    The name of the resource group where the

  • private_endpoint_connection_name (String) —

    The name of the private

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

    A hash of custom headers that



192
193
194
195
 
# File 'lib/2020-02-02/generated/azure_mgmt_recovery_services_backup/private_endpoint_connection_operations.rb', line 192

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

#delete_async(vault_name, resource_group_name, private_endpoint_connection_name, custom_headers: nil) ⇒ Concurrent::Promise

recovery services vault is present. endpoint connection. will be added to the HTTP request.

response.

Parameters:

  • vault_name (String) —

    The name of the recovery services vault.

  • resource_group_name (String) —

    The name of the resource group where the

  • private_endpoint_connection_name (String) —

    The name of the private

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/2020-02-02/generated/azure_mgmt_recovery_services_backup/private_endpoint_connection_operations.rb', line 209

def delete_async(vault_name, resource_group_name, private_endpoint_connection_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(vault_name, resource_group_name, private_endpoint_connection_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

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

  promise
end

#get(vault_name, resource_group_name, private_endpoint_connection_name, custom_headers: nil) ⇒ PrivateEndpointConnectionResource

Get Private Endpoint Connection. This call is made by Backup Admin.

recovery services vault is present. endpoint connection. will be added to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the recovery services vault.

  • resource_group_name (String) —

    The name of the resource group where the

  • private_endpoint_connection_name (String) —

    The name of the private

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

    A hash of custom headers that

Returns:

  • (PrivateEndpointConnectionResource) —

    operation results.



37
38
39
40
 
# File 'lib/2020-02-02/generated/azure_mgmt_recovery_services_backup/private_endpoint_connection_operations.rb', line 37

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

#get_async(vault_name, resource_group_name, private_endpoint_connection_name, custom_headers: nil) ⇒ Concurrent::Promise

Get Private Endpoint Connection. This call is made by Backup Admin.

recovery services vault is present. endpoint connection. to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the recovery services vault.

  • resource_group_name (String) —

    The name of the resource group where the

  • private_endpoint_connection_name (String) —

    The name of the private

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2020-02-02/generated/azure_mgmt_recovery_services_backup/private_endpoint_connection_operations.rb', line 72

def get_async(vault_name, resource_group_name, private_endpoint_connection_name, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'vault_name is nil' if vault_name.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'private_endpoint_connection_name is nil' if private_endpoint_connection_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.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'vaultName' => vault_name,'resourceGroupName' => resource_group_name,'subscriptionId' => @client.subscription_id,'privateEndpointConnectionName' => private_endpoint_connection_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::RecoveryServicesBackup::Mgmt::V2020_02_02::Models::PrivateEndpointConnectionResource.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(vault_name, resource_group_name, private_endpoint_connection_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get Private Endpoint Connection. This call is made by Backup Admin.

recovery services vault is present. endpoint connection. will be added to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the recovery services vault.

  • resource_group_name (String) —

    The name of the resource group where the

  • private_endpoint_connection_name (String) —

    The name of the private

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



55
56
57
 
# File 'lib/2020-02-02/generated/azure_mgmt_recovery_services_backup/private_endpoint_connection_operations.rb', line 55

def get_with_http_info(vault_name, resource_group_name, private_endpoint_connection_name, custom_headers:nil)
  get_async(vault_name, resource_group_name, private_endpoint_connection_name, custom_headers:custom_headers).value!
end

#put(vault_name, resource_group_name, private_endpoint_connection_name, parameters, custom_headers: nil) ⇒ PrivateEndpointConnectionResource

Approve or Reject Private Endpoint requests. This call is made by Backup Admin.

recovery services vault is present. endpoint connection. operation will be added to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the recovery services vault.

  • resource_group_name (String) —

    The name of the resource group where the

  • private_endpoint_connection_name (String) —

    The name of the private

  • parameters (PrivateEndpointConnectionResource) —

    Request body for

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

    A hash of custom headers that

Returns:

  • (PrivateEndpointConnectionResource) —

    operation results.



144
145
146
147
 
# File 'lib/2020-02-02/generated/azure_mgmt_recovery_services_backup/private_endpoint_connection_operations.rb', line 144

def put(vault_name, resource_group_name, private_endpoint_connection_name, parameters, custom_headers:nil)
  response = put_async(vault_name, resource_group_name, private_endpoint_connection_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#put_async(vault_name, resource_group_name, private_endpoint_connection_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

recovery services vault is present. endpoint connection. operation will be added to the HTTP request.

response.

Parameters:

  • vault_name (String) —

    The name of the recovery services vault.

  • resource_group_name (String) —

    The name of the resource group where the

  • private_endpoint_connection_name (String) —

    The name of the private

  • parameters (PrivateEndpointConnectionResource) —

    Request body for

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/2020-02-02/generated/azure_mgmt_recovery_services_backup/private_endpoint_connection_operations.rb', line 163

def put_async(vault_name, resource_group_name, private_endpoint_connection_name, parameters, custom_headers:nil)
  # Send request
  promise = begin_put_async(vault_name, resource_group_name, private_endpoint_connection_name, parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::RecoveryServicesBackup::Mgmt::V2020_02_02::Models::PrivateEndpointConnectionResource.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