Class: Azure::KeyVault::V7_2_preview::HSMSecurityDomain

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb

Overview

The key vault client performs cryptographic key operations and vault operations against the Key Vault service.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ HSMSecurityDomain

Creates and initializes a new instance of the HSMSecurityDomain class.

Parameters:

  • client

    service class for accessing basic functionality.



18
19
20
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 18

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientKeyVaultClient (readonly)

Returns reference to the KeyVaultClient.

Returns:



23
24
25
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 23

def client
  @client
end

Instance Method Details

#begin_download(vault_base_url, certificate_info_object, custom_headers: nil) ⇒ SecurityDomainObject

Retrieves the Security Domain from the managed HSM. Calling this endpoint can be used to activate a provisioned managed HSM resource.

myvault.vault.azure.net. download operation requires customer to provide N certificates (minimum 3 and maximum 10) containing a public key in JWK format. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_info_object (CertificateInfoObject)

    The Security Domain

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

    A hash of custom headers that

Returns:

  • (SecurityDomainObject)

    operation results.



406
407
408
409
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 406

def begin_download(vault_base_url, certificate_info_object, custom_headers:nil)
  response = begin_download_async(vault_base_url, certificate_info_object, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_download_async(vault_base_url, certificate_info_object, custom_headers: nil) ⇒ Concurrent::Promise

Retrieves the Security Domain from the managed HSM. Calling this endpoint can be used to activate a provisioned managed HSM resource.

myvault.vault.azure.net. download operation requires customer to provide N certificates (minimum 3 and maximum 10) containing a public key in JWK format. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_info_object (CertificateInfoObject)

    The Security Domain

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 443

def begin_download_async(vault_base_url, certificate_info_object, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'certificate_info_object is nil' if certificate_info_object.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?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::CertificateInfoObject.mapper()
  request_content = @client.serialize(request_mapper,  certificate_info_object)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'securitydomain/download'

  request_url = @base_url || @client.base_url
request_url = request_url.gsub('{vaultBaseUrl}', vault_base_url)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      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 == 202 || 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 == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::KeyVault::V7_2_preview::Models::SecurityDomainObject.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 == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::KeyVault::V7_2_preview::Models::SecurityDomainObject.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_download_with_http_info(vault_base_url, certificate_info_object, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves the Security Domain from the managed HSM. Calling this endpoint can be used to activate a provisioned managed HSM resource.

myvault.vault.azure.net. download operation requires customer to provide N certificates (minimum 3 and maximum 10) containing a public key in JWK format. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_info_object (CertificateInfoObject)

    The Security Domain

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



425
426
427
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 425

def begin_download_with_http_info(vault_base_url, certificate_info_object, custom_headers:nil)
  begin_download_async(vault_base_url, certificate_info_object, custom_headers:custom_headers).value!
end

#begin_upload(vault_base_url, security_domain, custom_headers: nil) ⇒ SecurityDomainOperationStatus

Restore the provided Security Domain.

myvault.vault.azure.net. restored. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • security_domain (SecurityDomainObject)

    The Security Domain to be

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

    A hash of custom headers that

Returns:

  • (SecurityDomainOperationStatus)

    operation results.



526
527
528
529
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 526

def begin_upload(vault_base_url, security_domain, custom_headers:nil)
  response = begin_upload_async(vault_base_url, security_domain, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_upload_async(vault_base_url, security_domain, custom_headers: nil) ⇒ Concurrent::Promise

Restore the provided Security Domain.

myvault.vault.azure.net. restored. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • security_domain (SecurityDomainObject)

    The Security Domain to be

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 559

def begin_upload_async(vault_base_url, security_domain, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'security_domain is nil' if security_domain.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::V7_2_preview::Models::SecurityDomainObject.mapper()
  request_content = @client.serialize(request_mapper,  security_domain)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'securitydomain/upload'

  request_url = @base_url || @client.base_url
request_url = request_url.gsub('{vaultBaseUrl}', vault_base_url)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      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 == 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?
    # Deserialize Response
    if status_code == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::KeyVault::V7_2_preview::Models::SecurityDomainOperationStatus.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_upload_with_http_info(vault_base_url, security_domain, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Restore the provided Security Domain.

myvault.vault.azure.net. restored. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • security_domain (SecurityDomainObject)

    The Security Domain to be

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



543
544
545
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 543

def begin_upload_with_http_info(vault_base_url, security_domain, custom_headers:nil)
  begin_upload_async(vault_base_url, security_domain, custom_headers:custom_headers).value!
end

#download(vault_base_url, certificate_info_object, custom_headers: nil) ⇒ SecurityDomainObject

Retrieves the Security Domain from the managed HSM. Calling this endpoint can be used to activate a provisioned managed HSM resource.

myvault.vault.azure.net. download operation requires customer to provide N certificates (minimum 3 and maximum 10) containing a public key in JWK format. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_info_object (CertificateInfoObject)

    The Security Domain

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

    A hash of custom headers that

Returns:

  • (SecurityDomainObject)

    operation results.



129
130
131
132
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 129

def download(vault_base_url, certificate_info_object, custom_headers:nil)
  response = download_async(vault_base_url, certificate_info_object, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#download_async(vault_base_url, certificate_info_object, custom_headers: nil) ⇒ Concurrent::Promise

myvault.vault.azure.net. download operation requires customer to provide N certificates (minimum 3 and maximum 10) containing a public key in JWK format. will be added to the HTTP request.

response.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_info_object (CertificateInfoObject)

    The Security Domain

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 146

def download_async(vault_base_url, certificate_info_object, custom_headers:nil)
  # Send request
  promise = begin_download_async(vault_base_url, certificate_info_object, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::KeyVault::V7_2_preview::Models::SecurityDomainObject.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

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

  promise
end

#download_pending(vault_base_url, custom_headers: nil) ⇒ SecurityDomainOperationStatus

Retrieves the Security Domain download operation status

myvault.vault.azure.net. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

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

    A hash of custom headers that

Returns:

  • (SecurityDomainOperationStatus)

    operation results.



35
36
37
38
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 35

def download_pending(vault_base_url, custom_headers:nil)
  response = download_pending_async(vault_base_url, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#download_pending_async(vault_base_url, custom_headers: nil) ⇒ Concurrent::Promise

Retrieves the Security Domain download operation status

myvault.vault.azure.net. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



64
65
66
67
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
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 64

def download_pending_async(vault_base_url, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.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 = 'securitydomain/download/pending'

  request_url = @base_url || @client.base_url
request_url = request_url.gsub('{vaultBaseUrl}', vault_base_url)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      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::KeyVault::V7_2_preview::Models::SecurityDomainOperationStatus.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

#download_pending_with_http_info(vault_base_url, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves the Security Domain download operation status

myvault.vault.azure.net. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



50
51
52
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 50

def download_pending_with_http_info(vault_base_url, custom_headers:nil)
  download_pending_async(vault_base_url, custom_headers:custom_headers).value!
end

#transfer_key_method(vault_base_url, custom_headers: nil) ⇒ TransferKey

Retrieve Security Domain transfer key

myvault.vault.azure.net. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

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

    A hash of custom headers that

Returns:

  • (TransferKey)

    operation results.



174
175
176
177
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 174

def transfer_key_method(vault_base_url, custom_headers:nil)
  response = transfer_key_method_async(vault_base_url, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#transfer_key_method_async(vault_base_url, custom_headers: nil) ⇒ Concurrent::Promise

Retrieve Security Domain transfer key

myvault.vault.azure.net. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
251
252
253
254
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 203

def transfer_key_method_async(vault_base_url, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.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 = 'securitydomain/upload'

  request_url = @base_url || @client.base_url
request_url = request_url.gsub('{vaultBaseUrl}', vault_base_url)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      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::KeyVault::V7_2_preview::Models::TransferKey.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

#transfer_key_method_with_http_info(vault_base_url, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieve Security Domain transfer key

myvault.vault.azure.net. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



189
190
191
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 189

def transfer_key_method_with_http_info(vault_base_url, custom_headers:nil)
  transfer_key_method_async(vault_base_url, custom_headers:custom_headers).value!
end

#upload(vault_base_url, security_domain, custom_headers: nil) ⇒ SecurityDomainOperationStatus

Restore the provided Security Domain.

myvault.vault.azure.net. restored. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • security_domain (SecurityDomainObject)

    The Security Domain to be

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

    A hash of custom headers that

Returns:

  • (SecurityDomainOperationStatus)

    operation results.



268
269
270
271
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 268

def upload(vault_base_url, security_domain, custom_headers:nil)
  response = upload_async(vault_base_url, security_domain, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#upload_async(vault_base_url, security_domain, custom_headers: nil) ⇒ Concurrent::Promise

myvault.vault.azure.net. restored. will be added to the HTTP request.

response.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • security_domain (SecurityDomainObject)

    The Security Domain to be

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 284

def upload_async(vault_base_url, security_domain, custom_headers:nil)
  # Send request
  promise = begin_upload_async(vault_base_url, security_domain, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::KeyVault::V7_2_preview::Models::SecurityDomainOperationStatus.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

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

  promise
end

#upload_pending(vault_base_url, custom_headers: nil) ⇒ SecurityDomainOperationStatus

Get Security Domain upload operation status

myvault.vault.azure.net. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

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

    A hash of custom headers that

Returns:

  • (SecurityDomainOperationStatus)

    operation results.



312
313
314
315
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 312

def upload_pending(vault_base_url, custom_headers:nil)
  response = upload_pending_async(vault_base_url, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#upload_pending_async(vault_base_url, custom_headers: nil) ⇒ Concurrent::Promise

Get Security Domain upload operation status

myvault.vault.azure.net. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 341

def upload_pending_async(vault_base_url, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.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 = 'securitydomain/upload/pending'

  request_url = @base_url || @client.base_url
request_url = request_url.gsub('{vaultBaseUrl}', vault_base_url)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      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::KeyVault::V7_2_preview::Models::SecurityDomainOperationStatus.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

#upload_pending_with_http_info(vault_base_url, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get Security Domain upload operation status

myvault.vault.azure.net. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



327
328
329
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 327

def upload_pending_with_http_info(vault_base_url, custom_headers:nil)
  upload_pending_async(vault_base_url, custom_headers:custom_headers).value!
end