Class: Azure::KeyVault::Mgmt::V2019_09_01::PrivateEndpointConnections

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-09-01/generated/azure_mgmt_key_vault/private_endpoint_connections.rb

Overview

The Azure management API provides a RESTful set of web services that interact with Azure Key Vault.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ PrivateEndpointConnections

Creates and initializes a new instance of the PrivateEndpointConnections class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/private_endpoint_connections.rb', line 18

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ KeyVaultManagementClient (readonly)

Returns reference to the KeyVaultManagementClient.

Returns:



23
24
25
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/private_endpoint_connections.rb', line 23

def client
  @client
end

Instance Method Details

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

Deletes the specified private endpoint connection associated with the key vault.

the key vault. connection associated with the key vault. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group that contains

  • vault_name (String) —

    The name of the key vault.

  • private_endpoint_connection_name (String) —

    Name of the private endpoint

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

    A hash of custom headers that

Returns:

  • (PrivateEndpointConnection) —

    operation results.



315
316
317
318
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/private_endpoint_connections.rb', line 315

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

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

Deletes the specified private endpoint connection associated with the key vault.

the key vault. connection associated with the key vault. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group that contains

  • vault_name (String) —

    The name of the key vault.

  • private_endpoint_connection_name (String) —

    Name of the private endpoint

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
407
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/private_endpoint_connections.rb', line 352

def begin_delete_async(resource_group_name, vault_name, private_endpoint_connection_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vault_name is nil' if vault_name.nil?
  fail ArgumentError, "'vault_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9-]{3,24}$'" if !vault_name.nil? && vault_name.match(Regexp.new('^^[a-zA-Z0-9-]{3,24}$$')).nil?
  fail ArgumentError, 'private_endpoint_connection_name is nil' if private_endpoint_connection_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.KeyVault/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}'

  request_url = @base_url || @client.base_url

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

Deletes the specified private endpoint connection associated with the key vault.

the key vault. connection associated with the key vault. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group that contains

  • vault_name (String) —

    The name of the key vault.

  • private_endpoint_connection_name (String) —

    Name of the private endpoint

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



334
335
336
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/private_endpoint_connections.rb', line 334

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

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

Deletes the specified private endpoint connection associated with the key vault.

the key vault. connection associated with the key vault. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group that contains

  • vault_name (String) —

    The name of the key vault.

  • private_endpoint_connection_name (String) —

    Name of the private endpoint

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

    A hash of custom headers that

Returns:

  • (PrivateEndpointConnection) —

    operation results.



266
267
268
269
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/private_endpoint_connections.rb', line 266

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

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

the key vault. connection associated with the key vault. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    Name of the resource group that contains

  • vault_name (String) —

    The name of the key vault.

  • private_endpoint_connection_name (String) —

    Name of the private endpoint

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/private_endpoint_connections.rb', line 283

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

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

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

Gets the specified private endpoint connection associated with the key vault.

the key vault. connection associated with the key vault. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group that contains

  • vault_name (String) —

    The name of the key vault.

  • private_endpoint_connection_name (String) —

    Name of the private endpoint

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

    A hash of custom headers that

Returns:

  • (PrivateEndpointConnection) —

    operation results.



38
39
40
41
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/private_endpoint_connections.rb', line 38

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

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

Gets the specified private endpoint connection associated with the key vault.

the key vault. connection associated with the key vault. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group that contains

  • vault_name (String) —

    The name of the key vault.

  • private_endpoint_connection_name (String) —

    Name of the private endpoint

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/private_endpoint_connections.rb', line 73

def get_async(resource_group_name, vault_name, private_endpoint_connection_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vault_name is nil' if vault_name.nil?
  fail ArgumentError, "'vault_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9-]{3,24}$'" if !vault_name.nil? && vault_name.match(Regexp.new('^^[a-zA-Z0-9-]{3,24}$$')).nil?
  fail ArgumentError, 'private_endpoint_connection_name is nil' if private_endpoint_connection_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.KeyVault/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}'

  request_url = @base_url || @client.base_url

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

Gets the specified private endpoint connection associated with the key vault.

the key vault. connection associated with the key vault. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group that contains

  • vault_name (String) —

    The name of the key vault.

  • private_endpoint_connection_name (String) —

    Name of the private endpoint

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



56
57
58
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/private_endpoint_connections.rb', line 56

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

#put(resource_group_name, vault_name, private_endpoint_connection_name, properties, custom_headers: nil) ⇒ PrivateEndpointConnection

Updates the specified private endpoint connection associated with the key vault.

the key vault. connection associated with the key vault. endpoint connection. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group that contains

  • vault_name (String) —

    The name of the key vault.

  • private_endpoint_connection_name (String) —

    Name of the private endpoint

  • properties (PrivateEndpointConnection) —

    The intended state of private

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

    A hash of custom headers that

Returns:

  • (PrivateEndpointConnection) —

    operation results.



146
147
148
149
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/private_endpoint_connections.rb', line 146

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

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

Updates the specified private endpoint connection associated with the key vault.

the key vault. connection associated with the key vault. endpoint connection. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group that contains

  • vault_name (String) —

    The name of the key vault.

  • private_endpoint_connection_name (String) —

    Name of the private endpoint

  • properties (PrivateEndpointConnection) —

    The intended state of private

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/private_endpoint_connections.rb', line 187

def put_async(resource_group_name, vault_name, private_endpoint_connection_name, properties, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vault_name is nil' if vault_name.nil?
  fail ArgumentError, "'vault_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9-]{3,24}$'" if !vault_name.nil? && vault_name.match(Regexp.new('^^[a-zA-Z0-9-]{3,24}$$')).nil?
  fail ArgumentError, 'private_endpoint_connection_name is nil' if private_endpoint_connection_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'properties is nil' if properties.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::KeyVault::Mgmt::V2019_09_01::Models::PrivateEndpointConnection.mapper()
  request_content = @client.serialize(request_mapper,  properties)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'vaultName' => vault_name,'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
      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::KeyVault::Mgmt::V2019_09_01::Models::PrivateEndpointConnection.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

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

Updates the specified private endpoint connection associated with the key vault.

the key vault. connection associated with the key vault. endpoint connection. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the resource group that contains

  • vault_name (String) —

    The name of the key vault.

  • private_endpoint_connection_name (String) —

    Name of the private endpoint

  • properties (PrivateEndpointConnection) —

    The intended state of private

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



167
168
169
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/private_endpoint_connections.rb', line 167

def put_with_http_info(resource_group_name, vault_name, private_endpoint_connection_name, properties, custom_headers:nil)
  put_async(resource_group_name, vault_name, private_endpoint_connection_name, properties, custom_headers:custom_headers).value!
end