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

#client ⇒ KeyVaultClient (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_upload(vault_base_url, security_domain, custom_headers: nil) ⇒ SecurityDomainOperationStatus

Request Security domain upload operation

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

Parameters:

  • vault_base_url (String) —

    The vault name, for example

  • security_domain (SecurityDomainUploadObject) —

    security domain

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

    A hash of custom headers that

Returns:

  • (SecurityDomainOperationStatus) —

    operation results.



371
372
373
374
 
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 371

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

Request Security domain upload operation

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

Parameters:

  • vault_base_url (String) —

    The vault name, for example

  • security_domain (SecurityDomainUploadObject) —

    security domain

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



402
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
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 402

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::SecurityDomainUploadObject.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
      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

Request Security domain upload operation

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

Parameters:

  • vault_base_url (String) —

    The vault name, for example

  • security_domain (SecurityDomainUploadObject) —

    security domain

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



387
388
389
 
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 387

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 Security domain from HSM enclave

myvault.vault.azure.net. download operation requires customer to provide N certificates (minimum 3 and maximum 10) containing 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) —

    Security domain

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

    A hash of custom headers that

Returns:

  • (SecurityDomainObject) —

    operation results.



38
39
40
41
 
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 38

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

Retrieves Security domain from HSM enclave

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

Parameters:

  • vault_base_url (String) —

    The vault name, for example

  • certificate_info_object (CertificateInfoObject) —

    Security domain

  • 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
129
130
131
132
 
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 73

def 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 == 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::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

#download_with_http_info(vault_base_url, certificate_info_object, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves Security domain from HSM enclave

myvault.vault.azure.net. download operation requires customer to provide N certificates (minimum 3 and maximum 10) containing 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) —

    Security domain

  • 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/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 56

def download_with_http_info(vault_base_url, certificate_info_object, custom_headers:nil)
  download_async(vault_base_url, certificate_info_object, 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.



144
145
146
147
 
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 144

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.



173
174
175
176
177
178
179
180
181
182
183
184
185
186
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
 
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 173

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/transferkey'

  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.



159
160
161
 
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 159

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

Request Security domain upload operation

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

Parameters:

  • vault_base_url (String) —

    The vault name, for example

  • security_domain (SecurityDomainUploadObject) —

    security domain

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

    A hash of custom headers that

Returns:

  • (SecurityDomainOperationStatus) —

    operation results.



237
238
239
240
 
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 237

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. will be added to the HTTP request.

response.

Parameters:

  • vault_base_url (String) —

    The vault name, for example

  • security_domain (SecurityDomainUploadObject) —

    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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 252

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.



280
281
282
283
 
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 280

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.



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
355
356
357
358
 
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 309

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.



295
296
297
 
# File 'lib/7.2-preview/generated/azure_key_vault/hsmsecurity_domain.rb', line 295

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