Class: Azure::KeyVault::V7_2_preview::KeyVaultClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb

Overview

A service client - single point of access to the REST API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials = nil, options = nil) ⇒ KeyVaultClient

Creates initializes a new instance of the KeyVaultClient class.

Parameters:

  • credentials (MsRest::ServiceClientCredentials) (defaults to: nil)

    credentials to authorize HTTP requests made by the service client.

  • options (Array) (defaults to: nil)

    filters to be applied to the HTTP requests.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 49

def initialize(credentials = nil, options = nil)
  super(credentials, options)
  @base_url = '{vaultBaseUrl}'

  fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
  @credentials = credentials

  @role_definitions = RoleDefinitions.new(self)
  @role_assignments = RoleAssignments.new(self)
  @hsmsecurity_domain = HSMSecurityDomain.new(self)
  @api_version = '7.2-preview'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Instance Attribute Details

#accept_languageString

Returns The preferred language for the response.

Returns:

  • (String)

    The preferred language for the response.



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

def accept_language
  @accept_language
end

#api_versionString (readonly)

Returns Client API version.

Returns:

  • (String)

    Client API version.



21
22
23
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 21

def api_version
  @api_version
end

#base_urlString (readonly)

Returns the base URI of the service.

Returns:

  • (String)

    the base URI of the service.



15
16
17
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 15

def base_url
  @base_url
end

#credentialsObject (readonly)

Returns Credentials needed for the client to connect to Azure.

Returns:

  • Credentials needed for the client to connect to Azure.



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

def credentials
  @credentials
end

#generate_client_request_idBoolean

generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Returns:

  • (Boolean)

    Whether a unique x-ms-client-request-id should be



33
34
35
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 33

def generate_client_request_id
  @generate_client_request_id
end

#hsmsecurity_domainHSMSecurityDomain (readonly)

Returns hsmsecurity_domain.

Returns:



42
43
44
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 42

def hsmsecurity_domain
  @hsmsecurity_domain
end

#long_running_operation_retry_timeoutInteger

Operations. Default value is 30.

Returns:

  • (Integer)

    The retry timeout in seconds for Long Running



28
29
30
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 28

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#role_assignmentsRoleAssignments (readonly)

Returns role_assignments.

Returns:



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

def role_assignments
  @role_assignments
end

#role_definitionsRoleDefinitions (readonly)

Returns role_definitions.

Returns:



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

def role_definitions
  @role_definitions
end

Instance Method Details

#backup_certificate(vault_base_url, certificate_name, custom_headers: nil) ⇒ BackupCertificateResult

Backs up the specified certificate.

Requests that a backup of the specified certificate be downloaded to the client. All versions of the certificate will be downloaded. This operation requires the certificates/backup permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

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

    A hash of custom headers that

Returns:

  • (BackupCertificateResult)

    operation results.



2697
2698
2699
2700
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2697

def backup_certificate(vault_base_url, certificate_name, custom_headers:nil)
  response = backup_certificate_async(vault_base_url, certificate_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#backup_certificate_async(vault_base_url, certificate_name, custom_headers: nil) ⇒ Concurrent::Promise

Backs up the specified certificate.

Requests that a backup of the specified certificate be downloaded to the client. All versions of the certificate will be downloaded. This operation requires the certificates/backup permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2736

def backup_certificate_async(vault_base_url, certificate_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'certificate_name is nil' if certificate_name.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'certificates/{certificate-name}/backup'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'certificate-name' => certificate_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::BackupCertificateResult.mapper()
        result.body = self.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

#backup_certificate_with_http_info(vault_base_url, certificate_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Backs up the specified certificate.

Requests that a backup of the specified certificate be downloaded to the client. All versions of the certificate will be downloaded. This operation requires the certificates/backup permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



2717
2718
2719
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2717

def backup_certificate_with_http_info(vault_base_url, certificate_name, custom_headers:nil)
  backup_certificate_async(vault_base_url, certificate_name, custom_headers:custom_headers).value!
end

#backup_key(vault_base_url, key_name, custom_headers: nil) ⇒ BackupKeyResult

Requests that a backup of the specified key be downloaded to the client.

The Key Backup operation exports a key from Azure Key Vault in a protected form. Note that this operation does NOT return key material in a form that can be used outside the Azure Key Vault system, the returned key material is either protected to a Azure Key Vault HSM or to Azure Key Vault itself. The intent of this operation is to allow a client to GENERATE a key in one Azure Key Vault instance, BACKUP the key, and then RESTORE it into another Azure Key Vault instance. The BACKUP operation may be used to export, in protected form, any key type from Azure Key Vault. Individual versions of a key cannot be backed up. BACKUP / RESTORE can be performed within geographical boundaries only; meaning that a BACKUP from one geographical area cannot be restored to another geographical area. For example, a backup from the US geographical area cannot be restored in an EU geographical area. This operation requires the key/backup permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

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

    A hash of custom headers that

Returns:

  • (BackupKeyResult)

    operation results.



4344
4345
4346
4347
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 4344

def backup_key(vault_base_url, key_name, custom_headers:nil)
  response = backup_key_async(vault_base_url, key_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#backup_key_async(vault_base_url, key_name, custom_headers: nil) ⇒ Concurrent::Promise

Requests that a backup of the specified key be downloaded to the client.

The Key Backup operation exports a key from Azure Key Vault in a protected form. Note that this operation does NOT return key material in a form that can be used outside the Azure Key Vault system, the returned key material is either protected to a Azure Key Vault HSM or to Azure Key Vault itself. The intent of this operation is to allow a client to GENERATE a key in one Azure Key Vault instance, BACKUP the key, and then RESTORE it into another Azure Key Vault instance. The BACKUP operation may be used to export, in protected form, any key type from Azure Key Vault. Individual versions of a key cannot be backed up. BACKUP / RESTORE can be performed within geographical boundaries only; meaning that a BACKUP from one geographical area cannot be restored to another geographical area. For example, a backup from the US geographical area cannot be restored in an EU geographical area. This operation requires the key/backup permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 4403

def backup_key_async(vault_base_url, key_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'keys/{key-name}/backup'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'key-name' => key_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::BackupKeyResult.mapper()
        result.body = self.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

#backup_key_with_http_info(vault_base_url, key_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Requests that a backup of the specified key be downloaded to the client.

The Key Backup operation exports a key from Azure Key Vault in a protected form. Note that this operation does NOT return key material in a form that can be used outside the Azure Key Vault system, the returned key material is either protected to a Azure Key Vault HSM or to Azure Key Vault itself. The intent of this operation is to allow a client to GENERATE a key in one Azure Key Vault instance, BACKUP the key, and then RESTORE it into another Azure Key Vault instance. The BACKUP operation may be used to export, in protected form, any key type from Azure Key Vault. Individual versions of a key cannot be backed up. BACKUP / RESTORE can be performed within geographical boundaries only; meaning that a BACKUP from one geographical area cannot be restored to another geographical area. For example, a backup from the US geographical area cannot be restored in an EU geographical area. This operation requires the key/backup permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



4374
4375
4376
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 4374

def backup_key_with_http_info(vault_base_url, key_name, custom_headers:nil)
  backup_key_async(vault_base_url, key_name, custom_headers:custom_headers).value!
end

#backup_secret(vault_base_url, secret_name, custom_headers: nil) ⇒ BackupSecretResult

Backs up the specified secret.

Requests that a backup of the specified secret be downloaded to the client. All versions of the secret will be downloaded. This operation requires the secrets/backup permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

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

    A hash of custom headers that

Returns:

  • (BackupSecretResult)

    operation results.



7373
7374
7375
7376
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7373

def backup_secret(vault_base_url, secret_name, custom_headers:nil)
  response = backup_secret_async(vault_base_url, secret_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#backup_secret_async(vault_base_url, secret_name, custom_headers: nil) ⇒ Concurrent::Promise

Backs up the specified secret.

Requests that a backup of the specified secret be downloaded to the client. All versions of the secret will be downloaded. This operation requires the secrets/backup permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7412

def backup_secret_async(vault_base_url, secret_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'secret_name is nil' if secret_name.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'secrets/{secret-name}/backup'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'secret-name' => secret_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::BackupSecretResult.mapper()
        result.body = self.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

#backup_secret_with_http_info(vault_base_url, secret_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Backs up the specified secret.

Requests that a backup of the specified secret be downloaded to the client. All versions of the secret will be downloaded. This operation requires the secrets/backup permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



7393
7394
7395
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7393

def backup_secret_with_http_info(vault_base_url, secret_name, custom_headers:nil)
  backup_secret_async(vault_base_url, secret_name, custom_headers:custom_headers).value!
end

#backup_storage_account(vault_base_url, storage_account_name, custom_headers: nil) ⇒ BackupStorageResult

Backs up the specified storage account.

Requests that a backup of the specified storage account be downloaded to the client. This operation requires the storage/backup permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

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

    A hash of custom headers that

Returns:

  • (BackupStorageResult)

    operation results.



8134
8135
8136
8137
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8134

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

#backup_storage_account_async(vault_base_url, storage_account_name, custom_headers: nil) ⇒ Concurrent::Promise

Backs up the specified storage account.

Requests that a backup of the specified storage account be downloaded to the client. This operation requires the storage/backup permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8171

def (vault_base_url, , custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'storage_account_name is nil' if .nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'storage/{storage-account-name}/backup'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'storage-account-name' => },
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::BackupStorageResult.mapper()
        result.body = self.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

#backup_storage_account_with_http_info(vault_base_url, storage_account_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Backs up the specified storage account.

Requests that a backup of the specified storage account be downloaded to the client. This operation requires the storage/backup permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



8153
8154
8155
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8153

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

#begin_full_backup(vault_base_url, azure_storage_blob_container_uri: nil, custom_headers: nil) ⇒ FullBackupOperation

Creates a full backup using a user-provided SAS token to an Azure blob storage container.

myvault.vault.azure.net. access signature token pointing to a valid Azure blob container where full backup needs to be stored. This token needs to be valid for at least next 24 hours from the time of making this call will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • azure_storage_blob_container_uri (SASTokenParameter) (defaults to: nil)

    Azure blob shared

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

    A hash of custom headers that

Returns:

  • (FullBackupOperation)

    operation results.



10489
10490
10491
10492
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10489

def begin_full_backup(vault_base_url, azure_storage_blob_container_uri:nil, custom_headers:nil)
  response = begin_full_backup_async(vault_base_url, azure_storage_blob_container_uri:azure_storage_blob_container_uri, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_full_backup_async(vault_base_url, azure_storage_blob_container_uri: nil, custom_headers: nil) ⇒ Concurrent::Promise

Creates a full backup using a user-provided SAS token to an Azure blob storage container.

myvault.vault.azure.net. access signature token pointing to a valid Azure blob container where full backup needs to be stored. This token needs to be valid for at least next 24 hours from the time of making this call to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • azure_storage_blob_container_uri (SASTokenParameter) (defaults to: nil)

    Azure blob shared

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10528

def begin_full_backup_async(vault_base_url, azure_storage_blob_container_uri:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::SASTokenParameter.mapper()
  request_content = self.serialize(request_mapper,  azure_storage_blob_container_uri)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'backup'

  request_url = @base_url || self.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' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::FullBackupOperation.mapper()
        result.body = self.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_full_backup_with_http_info(vault_base_url, azure_storage_blob_container_uri: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a full backup using a user-provided SAS token to an Azure blob storage container.

myvault.vault.azure.net. access signature token pointing to a valid Azure blob container where full backup needs to be stored. This token needs to be valid for at least next 24 hours from the time of making this call will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • azure_storage_blob_container_uri (SASTokenParameter) (defaults to: nil)

    Azure blob shared

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



10509
10510
10511
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10509

def begin_full_backup_with_http_info(vault_base_url, azure_storage_blob_container_uri:nil, custom_headers:nil)
  begin_full_backup_async(vault_base_url, azure_storage_blob_container_uri:azure_storage_blob_container_uri, custom_headers:custom_headers).value!
end

#begin_full_restore_operation(vault_base_url, restore_blob_details: nil, custom_headers: nil) ⇒ RestoreOperation

Restores all key materials using the SAS token pointing to a previously stored Azure Blob storage backup folder

myvault.vault.azure.net. token pointing to a folder where the previous successful full backup was stored will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • restore_blob_details (RestoreOperationParameters) (defaults to: nil)

    The Azure blob SAS

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

    A hash of custom headers that

Returns:

  • (RestoreOperation)

    operation results.



10602
10603
10604
10605
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10602

def begin_full_restore_operation(vault_base_url, restore_blob_details:nil, custom_headers:nil)
  response = begin_full_restore_operation_async(vault_base_url, restore_blob_details:restore_blob_details, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_full_restore_operation_async(vault_base_url, restore_blob_details: nil, custom_headers: nil) ⇒ Concurrent::Promise

Restores all key materials using the SAS token pointing to a previously stored Azure Blob storage backup folder

myvault.vault.azure.net. token pointing to a folder where the previous successful full backup was stored to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • restore_blob_details (RestoreOperationParameters) (defaults to: nil)

    The Azure blob SAS

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10639

def begin_full_restore_operation_async(vault_base_url, restore_blob_details:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::RestoreOperationParameters.mapper()
  request_content = self.serialize(request_mapper,  restore_blob_details)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'restore'

  request_url = @base_url || self.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' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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 == 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::RestoreOperation.mapper()
        result.body = self.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_full_restore_operation_with_http_info(vault_base_url, restore_blob_details: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Restores all key materials using the SAS token pointing to a previously stored Azure Blob storage backup folder

myvault.vault.azure.net. token pointing to a folder where the previous successful full backup was stored will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • restore_blob_details (RestoreOperationParameters) (defaults to: nil)

    The Azure blob SAS

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



10621
10622
10623
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10621

def begin_full_restore_operation_with_http_info(vault_base_url, restore_blob_details:nil, custom_headers:nil)
  begin_full_restore_operation_async(vault_base_url, restore_blob_details:restore_blob_details, custom_headers:custom_headers).value!
end

#begin_selective_key_restore_operation_method(vault_base_url, key_name, restore_blob_details: nil, custom_headers: nil) ⇒ SelectiveKeyRestoreOperation

Restores all key versions of a given key using user supplied SAS token pointing to a previously stored Azure Blob storage backup folder

myvault.vault.azure.net. supplied backup Azure blob SAS token pointing to a folder where the previous successful full backup was stored will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key to be restored from the user

  • restore_blob_details (SelectiveKeyRestoreOperationParameters) (defaults to: nil)

    The

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

    A hash of custom headers that

Returns:

  • (SelectiveKeyRestoreOperation)

    operation results.



10715
10716
10717
10718
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10715

def begin_selective_key_restore_operation_method(vault_base_url, key_name, restore_blob_details:nil, custom_headers:nil)
  response = begin_selective_key_restore_operation_method_async(vault_base_url, key_name, restore_blob_details:restore_blob_details, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_selective_key_restore_operation_method_async(vault_base_url, key_name, restore_blob_details: nil, custom_headers: nil) ⇒ Concurrent::Promise

Restores all key versions of a given key using user supplied SAS token pointing to a previously stored Azure Blob storage backup folder

myvault.vault.azure.net. supplied backup Azure blob SAS token pointing to a folder where the previous successful full backup was stored to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key to be restored from the user

  • restore_blob_details (SelectiveKeyRestoreOperationParameters) (defaults to: nil)

    The

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10756

def begin_selective_key_restore_operation_method_async(vault_base_url, key_name, restore_blob_details:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::SelectiveKeyRestoreOperationParameters.mapper()
  request_content = self.serialize(request_mapper,  restore_blob_details)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'keys/{keyName}/restore'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'keyName' => key_name},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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 == 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::SelectiveKeyRestoreOperation.mapper()
        result.body = self.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_selective_key_restore_operation_method_with_http_info(vault_base_url, key_name, restore_blob_details: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Restores all key versions of a given key using user supplied SAS token pointing to a previously stored Azure Blob storage backup folder

myvault.vault.azure.net. supplied backup Azure blob SAS token pointing to a folder where the previous successful full backup was stored will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key to be restored from the user

  • restore_blob_details (SelectiveKeyRestoreOperationParameters) (defaults to: nil)

    The

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



10736
10737
10738
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10736

def begin_selective_key_restore_operation_method_with_http_info(vault_base_url, key_name, restore_blob_details:nil, custom_headers:nil)
  begin_selective_key_restore_operation_method_async(vault_base_url, key_name, restore_blob_details:restore_blob_details, custom_headers:custom_headers).value!
end

#create_certificate(vault_base_url, certificate_name, certificate_policy: nil, certificate_attributes: nil, tags: nil, custom_headers: nil) ⇒ CertificateOperation

Creates a new certificate.

If this is the first version, the certificate resource is created. This operation requires the certificates/create permission.

myvault.vault.azure.net. certificate. certificate (optional). form of key-value pairs. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

  • certificate_policy (CertificatePolicy) (defaults to: nil)

    The management policy for the

  • certificate_attributes (CertificateAttributes) (defaults to: nil)

    The attributes of the

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

    Application specific metadata in the

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

    A hash of custom headers that

Returns:

  • (CertificateOperation)

    operation results.



1301
1302
1303
1304
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1301

def create_certificate(vault_base_url, certificate_name, certificate_policy:nil, certificate_attributes:nil, tags:nil, custom_headers:nil)
  response = create_certificate_async(vault_base_url, certificate_name, certificate_policy:certificate_policy, certificate_attributes:certificate_attributes, tags:tags, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_certificate_async(vault_base_url, certificate_name, certificate_policy: nil, certificate_attributes: nil, tags: nil, custom_headers: nil) ⇒ Concurrent::Promise

Creates a new certificate.

If this is the first version, the certificate resource is created. This operation requires the certificates/create permission.

myvault.vault.azure.net. certificate. certificate (optional). form of key-value pairs. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

  • certificate_policy (CertificatePolicy) (defaults to: nil)

    The management policy for the

  • certificate_attributes (CertificateAttributes) (defaults to: nil)

    The attributes of the

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

    Application specific metadata in the

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1350

def create_certificate_async(vault_base_url, certificate_name, certificate_policy:nil, certificate_attributes:nil, tags:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'certificate_name is nil' if certificate_name.nil?
  fail ArgumentError, "'certificate_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z-]+$'" if !certificate_name.nil? && certificate_name.match(Regexp.new('^^[0-9a-zA-Z-]+$$')).nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?

  parameters = CertificateCreateParameters.new
  unless certificate_policy.nil? && certificate_attributes.nil? && tags.nil?
    parameters.CertificatePolicy = certificate_policy
    parameters.CertificateAttributes = certificate_attributes
    parameters.tags = tags
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::CertificateCreateParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'certificates/{certificate-name}/create'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'certificate-name' => certificate_name},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::CertificateOperation.mapper()
        result.body = self.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

#create_certificate_with_http_info(vault_base_url, certificate_name, certificate_policy: nil, certificate_attributes: nil, tags: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a new certificate.

If this is the first version, the certificate resource is created. This operation requires the certificates/create permission.

myvault.vault.azure.net. certificate. certificate (optional). form of key-value pairs. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

  • certificate_policy (CertificatePolicy) (defaults to: nil)

    The management policy for the

  • certificate_attributes (CertificateAttributes) (defaults to: nil)

    The attributes of the

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

    Application specific metadata in the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1326
1327
1328
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1326

def create_certificate_with_http_info(vault_base_url, certificate_name, certificate_policy:nil, certificate_attributes:nil, tags:nil, custom_headers:nil)
  create_certificate_async(vault_base_url, certificate_name, certificate_policy:certificate_policy, certificate_attributes:certificate_attributes, tags:tags, custom_headers:custom_headers).value!
end

#create_key(vault_base_url, key_name, kty, key_size: nil, public_exponent: nil, key_ops: nil, key_attributes: nil, tags: nil, curve: nil, release_policy: nil, custom_headers: nil) ⇒ KeyBundle

Creates a new key, stores it, then returns key parameters and attributes to the client.

The create key operation can be used to create any key type in Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. It requires the keys/create permission.

myvault.vault.azure.net. the version name for the new key. JsonWebKeyType. Possible values include: ‘EC’, ‘EC-HSM’, ‘RSA’, ‘RSA-HSM’, ‘oct’, ‘oct-HSM’ 4096 for RSA. form of key-value pairs. JsonWebKeyCurveName. Possible values include: ‘P-256’, ‘P-384’, ‘P-521’, ‘P-256K’ can be exported. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name for the new key. The system will generate

  • kty (JsonWebKeyType)

    The type of key to create. For valid values, see

  • key_size (Integer) (defaults to: nil)

    The key size in bits. For example: 2048, 3072, or

  • public_exponent (Integer) (defaults to: nil)

    The public exponent for a RSA key.

  • key_ops (Array<JsonWebKeyOperation>) (defaults to: nil)
  • key_attributes (KeyAttributes) (defaults to: nil)
  • tags (Hash{String => String}) (defaults to: nil)

    Application specific metadata in the

  • curve (JsonWebKeyCurveName) (defaults to: nil)

    Elliptic curve name. For valid values, see

  • release_policy (KeyReleasePolicy) (defaults to: nil)

    The policy rules under which the key

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

    A hash of custom headers that

Returns:

  • (KeyBundle)

    operation results.



3400
3401
3402
3403
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 3400

def create_key(vault_base_url, key_name, kty, key_size:nil, public_exponent:nil, key_ops:nil, key_attributes:nil, tags:nil, curve:nil, release_policy:nil, custom_headers:nil)
  response = create_key_async(vault_base_url, key_name, kty, key_size:key_size, public_exponent:public_exponent, key_ops:key_ops, key_attributes:key_attributes, tags:tags, curve:curve, release_policy:release_policy, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_key_async(vault_base_url, key_name, kty, key_size: nil, public_exponent: nil, key_ops: nil, key_attributes: nil, tags: nil, curve: nil, release_policy: nil, custom_headers: nil) ⇒ Concurrent::Promise

Creates a new key, stores it, then returns key parameters and attributes to the client.

The create key operation can be used to create any key type in Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. It requires the keys/create permission.

myvault.vault.azure.net. the version name for the new key. JsonWebKeyType. Possible values include: ‘EC’, ‘EC-HSM’, ‘RSA’, ‘RSA-HSM’, ‘oct’, ‘oct-HSM’ 4096 for RSA. form of key-value pairs. JsonWebKeyCurveName. Possible values include: ‘P-256’, ‘P-384’, ‘P-521’, ‘P-256K’ can be exported. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name for the new key. The system will generate

  • kty (JsonWebKeyType)

    The type of key to create. For valid values, see

  • key_size (Integer) (defaults to: nil)

    The key size in bits. For example: 2048, 3072, or

  • public_exponent (Integer) (defaults to: nil)

    The public exponent for a RSA key.

  • key_ops (Array<JsonWebKeyOperation>) (defaults to: nil)
  • key_attributes (KeyAttributes) (defaults to: nil)
  • tags (Hash{String => String}) (defaults to: nil)

    Application specific metadata in the

  • curve (JsonWebKeyCurveName) (defaults to: nil)

    Elliptic curve name. For valid values, see

  • release_policy (KeyReleasePolicy) (defaults to: nil)

    The policy rules under which the key

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 3473

def create_key_async(vault_base_url, key_name, kty, key_size:nil, public_exponent:nil, key_ops:nil, key_attributes:nil, tags:nil, curve:nil, release_policy:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, "'key_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z-]+$'" if !key_name.nil? && key_name.match(Regexp.new('^^[0-9a-zA-Z-]+$$')).nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'kty is nil' if kty.nil?
  fail ArgumentError, "'kty' should satisfy the constraint - 'MinLength': '1'" if !kty.nil? && kty.length < 1

  parameters = KeyCreateParameters.new
  unless kty.nil? && key_size.nil? && public_exponent.nil? && key_ops.nil? && key_attributes.nil? && tags.nil? && curve.nil? && release_policy.nil?
    parameters.kty = kty
    parameters.key_size = key_size
    parameters.public_exponent = public_exponent
    parameters.key_ops = key_ops
    parameters.keyAttributes = key_attributes
    parameters.tags = tags
    parameters.curve = curve
    parameters.release_policy = release_policy
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::KeyCreateParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'keys/{key-name}/create'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'key-name' => key_name},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::KeyBundle.mapper()
        result.body = self.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

#create_key_with_http_info(vault_base_url, key_name, kty, key_size: nil, public_exponent: nil, key_ops: nil, key_attributes: nil, tags: nil, curve: nil, release_policy: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a new key, stores it, then returns key parameters and attributes to the client.

The create key operation can be used to create any key type in Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. It requires the keys/create permission.

myvault.vault.azure.net. the version name for the new key. JsonWebKeyType. Possible values include: ‘EC’, ‘EC-HSM’, ‘RSA’, ‘RSA-HSM’, ‘oct’, ‘oct-HSM’ 4096 for RSA. form of key-value pairs. JsonWebKeyCurveName. Possible values include: ‘P-256’, ‘P-384’, ‘P-521’, ‘P-256K’ can be exported. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name for the new key. The system will generate

  • kty (JsonWebKeyType)

    The type of key to create. For valid values, see

  • key_size (Integer) (defaults to: nil)

    The key size in bits. For example: 2048, 3072, or

  • public_exponent (Integer) (defaults to: nil)

    The public exponent for a RSA key.

  • key_ops (Array<JsonWebKeyOperation>) (defaults to: nil)
  • key_attributes (KeyAttributes) (defaults to: nil)
  • tags (Hash{String => String}) (defaults to: nil)

    Application specific metadata in the

  • curve (JsonWebKeyCurveName) (defaults to: nil)

    Elliptic curve name. For valid values, see

  • release_policy (KeyReleasePolicy) (defaults to: nil)

    The policy rules under which the key

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



3437
3438
3439
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 3437

def create_key_with_http_info(vault_base_url, key_name, kty, key_size:nil, public_exponent:nil, key_ops:nil, key_attributes:nil, tags:nil, curve:nil, release_policy:nil, custom_headers:nil)
  create_key_async(vault_base_url, key_name, kty, key_size:key_size, public_exponent:public_exponent, key_ops:key_ops, key_attributes:key_attributes, tags:tags, curve:curve, release_policy:release_policy, custom_headers:custom_headers).value!
end

#decrypt(vault_base_url, key_name, key_version, algorithm, value, iv: nil, aad: nil, tag: nil, custom_headers: nil) ⇒ KeyOperationResult

Decrypts a single block of encrypted data.

The DECRYPT operation decrypts a well-formed block of ciphertext using the target encryption key and specified algorithm. This operation is the reverse of the ENCRYPT operation; only a single block of data may be decrypted, the size of this block is dependent on the target key and the algorithm to be used. The DECRYPT operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation requires the keys/decrypt permission.

myvault.vault.azure.net. Possible values include: ‘RSA-OAEP’, ‘RSA-OAEP-256’, ‘RSA1_5’, ‘A128GCM’, ‘A192GCM’, ‘A256GCM’, ‘A128KW’, ‘A192KW’, ‘A256KW’, ‘A128CBC’, ‘A192CBC’, ‘A256CBC’, ‘A128CBCPAD’, ‘A192CBCPAD’, ‘A256CBCPAD’ authenticated crypto algorithms. authenticated algorithm. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • key_version (String)

    The version of the key.

  • algorithm (JsonWebKeyEncryptionAlgorithm)

    algorithm identifier.

  • value
  • iv (defaults to: nil)

    Initialization vector for symmetric algorithms.

  • aad (defaults to: nil)

    Additional data to authenticate but not encrypt/decrypt when using

  • tag (defaults to: nil)

    The tag to authenticate when performing decryption with an

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

    A hash of custom headers that

Returns:

  • (KeyOperationResult)

    operation results.



4822
4823
4824
4825
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 4822

def decrypt(vault_base_url, key_name, key_version, algorithm, value, iv:nil, aad:nil, tag:nil, custom_headers:nil)
  response = decrypt_async(vault_base_url, key_name, key_version, algorithm, value, iv:iv, aad:aad, tag:tag, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#decrypt_async(vault_base_url, key_name, key_version, algorithm, value, iv: nil, aad: nil, tag: nil, custom_headers: nil) ⇒ Concurrent::Promise

Decrypts a single block of encrypted data.

The DECRYPT operation decrypts a well-formed block of ciphertext using the target encryption key and specified algorithm. This operation is the reverse of the ENCRYPT operation; only a single block of data may be decrypted, the size of this block is dependent on the target key and the algorithm to be used. The DECRYPT operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation requires the keys/decrypt permission.

myvault.vault.azure.net. Possible values include: ‘RSA-OAEP’, ‘RSA-OAEP-256’, ‘RSA1_5’, ‘A128GCM’, ‘A192GCM’, ‘A256GCM’, ‘A128KW’, ‘A192KW’, ‘A256KW’, ‘A128CBC’, ‘A192CBC’, ‘A256CBC’, ‘A128CBCPAD’, ‘A192CBCPAD’, ‘A256CBCPAD’ authenticated crypto algorithms. authenticated algorithm. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • key_version (String)

    The version of the key.

  • algorithm (JsonWebKeyEncryptionAlgorithm)

    algorithm identifier.

  • value
  • iv (defaults to: nil)

    Initialization vector for symmetric algorithms.

  • aad (defaults to: nil)

    Additional data to authenticate but not encrypt/decrypt when using

  • tag (defaults to: nil)

    The tag to authenticate when performing decryption with an

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 4891

def decrypt_async(vault_base_url, key_name, key_version, algorithm, value, iv:nil, aad:nil, tag:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, 'key_version is nil' if key_version.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'algorithm is nil' if algorithm.nil?
  fail ArgumentError, "'algorithm' should satisfy the constraint - 'MinLength': '1'" if !algorithm.nil? && algorithm.length < 1
  fail ArgumentError, 'value is nil' if value.nil?

  parameters = KeyOperationsParameters.new
  unless algorithm.nil? && value.nil? && iv.nil? && aad.nil? && tag.nil?
    parameters.algorithm = algorithm
    parameters.value = value
    parameters.iv = iv
    parameters.aad = aad
    parameters.tag = tag
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::KeyOperationsParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'keys/{key-name}/{key-version}/decrypt'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'key-name' => key_name,'key-version' => key_version},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::KeyOperationResult.mapper()
        result.body = self.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

#decrypt_with_http_info(vault_base_url, key_name, key_version, algorithm, value, iv: nil, aad: nil, tag: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Decrypts a single block of encrypted data.

The DECRYPT operation decrypts a well-formed block of ciphertext using the target encryption key and specified algorithm. This operation is the reverse of the ENCRYPT operation; only a single block of data may be decrypted, the size of this block is dependent on the target key and the algorithm to be used. The DECRYPT operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation requires the keys/decrypt permission.

myvault.vault.azure.net. Possible values include: ‘RSA-OAEP’, ‘RSA-OAEP-256’, ‘RSA1_5’, ‘A128GCM’, ‘A192GCM’, ‘A256GCM’, ‘A128KW’, ‘A192KW’, ‘A256KW’, ‘A128CBC’, ‘A192CBC’, ‘A256CBC’, ‘A128CBCPAD’, ‘A192CBCPAD’, ‘A256CBCPAD’ authenticated crypto algorithms. authenticated algorithm. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • key_version (String)

    The version of the key.

  • algorithm (JsonWebKeyEncryptionAlgorithm)

    algorithm identifier.

  • value
  • iv (defaults to: nil)

    Initialization vector for symmetric algorithms.

  • aad (defaults to: nil)

    Additional data to authenticate but not encrypt/decrypt when using

  • tag (defaults to: nil)

    The tag to authenticate when performing decryption with an

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



4857
4858
4859
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 4857

def decrypt_with_http_info(vault_base_url, key_name, key_version, algorithm, value, iv:nil, aad:nil, tag:nil, custom_headers:nil)
  decrypt_async(vault_base_url, key_name, key_version, algorithm, value, iv:iv, aad:aad, tag:tag, custom_headers:custom_headers).value!
end

#delete_certificate(vault_base_url, certificate_name, custom_headers: nil) ⇒ DeletedCertificateBundle

Deletes a certificate from a specified key vault.

Deletes all versions of a certificate object along with its associated policy. Delete certificate cannot be used to remove individual versions of a certificate object. This operation requires the certificates/delete permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

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

    A hash of custom headers that

Returns:

  • (DeletedCertificateBundle)

    operation results.



258
259
260
261
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 258

def delete_certificate(vault_base_url, certificate_name, custom_headers:nil)
  response = delete_certificate_async(vault_base_url, certificate_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#delete_certificate_async(vault_base_url, certificate_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes a certificate from a specified key vault.

Deletes all versions of a certificate object along with its associated policy. Delete certificate cannot be used to remove individual versions of a certificate object. This operation requires the certificates/delete permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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

def delete_certificate_async(vault_base_url, certificate_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'certificate_name is nil' if certificate_name.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'certificates/{certificate-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'certificate-name' => certificate_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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
      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::DeletedCertificateBundle.mapper()
        result.body = self.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

#delete_certificate_contacts(vault_base_url, custom_headers: nil) ⇒ Contacts

Deletes the certificate contacts for a specified key vault.

Deletes the certificate contacts for a specified key vault certificate. This operation requires the certificates/managecontacts permission.

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:

  • (Contacts)

    operation results.



583
584
585
586
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 583

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

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

Deletes the certificate contacts for a specified key vault.

Deletes the certificate contacts for a specified key vault certificate. This operation requires the certificates/managecontacts permission.

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.



618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 618

def delete_certificate_contacts_async(vault_base_url, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'certificates/contacts'

  request_url = @base_url || self.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' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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
      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::Contacts.mapper()
        result.body = self.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

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

Deletes the certificate contacts for a specified key vault.

Deletes the certificate contacts for a specified key vault certificate. This operation requires the certificates/managecontacts permission.

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.



601
602
603
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 601

def delete_certificate_contacts_with_http_info(vault_base_url, custom_headers:nil)
  delete_certificate_contacts_async(vault_base_url, custom_headers:custom_headers).value!
end

#delete_certificate_issuer(vault_base_url, issuer_name, custom_headers: nil) ⇒ IssuerBundle

Deletes the specified certificate issuer.

The DeleteCertificateIssuer operation permanently removes the specified certificate issuer from the vault. This operation requires the certificates/manageissuers/deleteissuers permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • issuer_name (String)

    The name of the issuer.

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

    A hash of custom headers that

Returns:

  • (IssuerBundle)

    operation results.



1187
1188
1189
1190
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1187

def delete_certificate_issuer(vault_base_url, issuer_name, custom_headers:nil)
  response = delete_certificate_issuer_async(vault_base_url, issuer_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#delete_certificate_issuer_async(vault_base_url, issuer_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes the specified certificate issuer.

The DeleteCertificateIssuer operation permanently removes the specified certificate issuer from the vault. This operation requires the certificates/manageissuers/deleteissuers permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • issuer_name (String)

    The name of the issuer.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1226

def delete_certificate_issuer_async(vault_base_url, issuer_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'issuer_name is nil' if issuer_name.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'certificates/issuers/{issuer-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'issuer-name' => issuer_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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
      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::IssuerBundle.mapper()
        result.body = self.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

#delete_certificate_issuer_with_http_info(vault_base_url, issuer_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes the specified certificate issuer.

The DeleteCertificateIssuer operation permanently removes the specified certificate issuer from the vault. This operation requires the certificates/manageissuers/deleteissuers permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • issuer_name (String)

    The name of the issuer.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1207
1208
1209
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1207

def delete_certificate_issuer_with_http_info(vault_base_url, issuer_name, custom_headers:nil)
  delete_certificate_issuer_async(vault_base_url, issuer_name, custom_headers:custom_headers).value!
end

#delete_certificate_operation(vault_base_url, certificate_name, custom_headers: nil) ⇒ CertificateOperation

Deletes the creation operation for a specific certificate.

Deletes the creation operation for a specified certificate that is in the process of being created. The certificate is no longer created. This operation requires the certificates/update permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

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

    A hash of custom headers that

Returns:

  • (CertificateOperation)

    operation results.



2444
2445
2446
2447
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2444

def delete_certificate_operation(vault_base_url, certificate_name, custom_headers:nil)
  response = delete_certificate_operation_async(vault_base_url, certificate_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#delete_certificate_operation_async(vault_base_url, certificate_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes the creation operation for a specific certificate.

Deletes the creation operation for a specified certificate that is in the process of being created. The certificate is no longer created. This operation requires the certificates/update permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2483

def delete_certificate_operation_async(vault_base_url, certificate_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'certificate_name is nil' if certificate_name.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'certificates/{certificate-name}/pending'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'certificate-name' => certificate_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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
      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::CertificateOperation.mapper()
        result.body = self.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

#delete_certificate_operation_with_http_info(vault_base_url, certificate_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes the creation operation for a specific certificate.

Deletes the creation operation for a specified certificate that is in the process of being created. The certificate is no longer created. This operation requires the certificates/update permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



2464
2465
2466
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2464

def delete_certificate_operation_with_http_info(vault_base_url, certificate_name, custom_headers:nil)
  delete_certificate_operation_async(vault_base_url, certificate_name, custom_headers:custom_headers).value!
end

#delete_certificate_with_http_info(vault_base_url, certificate_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a certificate from a specified key vault.

Deletes all versions of a certificate object along with its associated policy. Delete certificate cannot be used to remove individual versions of a certificate object. This operation requires the certificates/delete permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



279
280
281
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 279

def delete_certificate_with_http_info(vault_base_url, certificate_name, custom_headers:nil)
  delete_certificate_async(vault_base_url, certificate_name, custom_headers:custom_headers).value!
end

#delete_key(vault_base_url, key_name, custom_headers: nil) ⇒ DeletedKeyBundle

Deletes a key of any type from storage in Azure Key Vault.

The delete key operation cannot be used to remove individual versions of a key. This operation removes the cryptographic material associated with the key, which means the key is not usable for Sign/Verify, Wrap/Unwrap or Encrypt/Decrypt operations. This operation requires the keys/delete permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key to delete.

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

    A hash of custom headers that

Returns:

  • (DeletedKeyBundle)

    operation results.



3719
3720
3721
3722
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 3719

def delete_key(vault_base_url, key_name, custom_headers:nil)
  response = delete_key_async(vault_base_url, key_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#delete_key_async(vault_base_url, key_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes a key of any type from storage in Azure Key Vault.

The delete key operation cannot be used to remove individual versions of a key. This operation removes the cryptographic material associated with the key, which means the key is not usable for Sign/Verify, Wrap/Unwrap or Encrypt/Decrypt operations. This operation requires the keys/delete permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key to delete.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 3762

def delete_key_async(vault_base_url, key_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'keys/{key-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'key-name' => key_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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
      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::DeletedKeyBundle.mapper()
        result.body = self.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

#delete_key_with_http_info(vault_base_url, key_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a key of any type from storage in Azure Key Vault.

The delete key operation cannot be used to remove individual versions of a key. This operation removes the cryptographic material associated with the key, which means the key is not usable for Sign/Verify, Wrap/Unwrap or Encrypt/Decrypt operations. This operation requires the keys/delete permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key to delete.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



3741
3742
3743
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 3741

def delete_key_with_http_info(vault_base_url, key_name, custom_headers:nil)
  delete_key_async(vault_base_url, key_name, custom_headers:custom_headers).value!
end

#delete_sas_definition(vault_base_url, storage_account_name, sas_definition_name, custom_headers: nil) ⇒ DeletedSasDefinitionBundle

Deletes a SAS definition from a specified storage account. This operation requires the storage/deletesas permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • sas_definition_name (String)

    The name of the SAS definition.

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

    A hash of custom headers that

Returns:

  • (DeletedSasDefinitionBundle)

    operation results.



9426
9427
9428
9429
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9426

def delete_sas_definition(vault_base_url, , sas_definition_name, custom_headers:nil)
  response = delete_sas_definition_async(vault_base_url, , sas_definition_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#delete_sas_definition_async(vault_base_url, storage_account_name, sas_definition_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes a SAS definition from a specified storage account. This operation requires the storage/deletesas permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • sas_definition_name (String)

    The name of the SAS definition.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9461

def delete_sas_definition_async(vault_base_url, , sas_definition_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'storage_account_name is nil' if .nil?
  fail ArgumentError, "'storage_account_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !.nil? && .match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, 'sas_definition_name is nil' if sas_definition_name.nil?
  fail ArgumentError, "'sas_definition_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !sas_definition_name.nil? && sas_definition_name.match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'storage/{storage-account-name}/sas/{sas-definition-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'storage-account-name' => ,'sas-definition-name' => sas_definition_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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
      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::DeletedSasDefinitionBundle.mapper()
        result.body = self.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

#delete_sas_definition_with_http_info(vault_base_url, storage_account_name, sas_definition_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a SAS definition from a specified storage account. This operation requires the storage/deletesas permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • sas_definition_name (String)

    The name of the SAS definition.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



9444
9445
9446
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9444

def delete_sas_definition_with_http_info(vault_base_url, , sas_definition_name, custom_headers:nil)
  delete_sas_definition_async(vault_base_url, , sas_definition_name, custom_headers:custom_headers).value!
end

#delete_secret(vault_base_url, secret_name, custom_headers: nil) ⇒ DeletedSecretBundle

Deletes a secret from a specified key vault.

The DELETE operation applies to any secret stored in Azure Key Vault. DELETE cannot be applied to an individual version of a secret. This operation requires the secrets/delete permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

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

    A hash of custom headers that

Returns:

  • (DeletedSecretBundle)

    operation results.



6347
6348
6349
6350
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6347

def delete_secret(vault_base_url, secret_name, custom_headers:nil)
  response = delete_secret_async(vault_base_url, secret_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#delete_secret_async(vault_base_url, secret_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes a secret from a specified key vault.

The DELETE operation applies to any secret stored in Azure Key Vault. DELETE cannot be applied to an individual version of a secret. This operation requires the secrets/delete permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6386

def delete_secret_async(vault_base_url, secret_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'secret_name is nil' if secret_name.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'secrets/{secret-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'secret-name' => secret_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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
      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::DeletedSecretBundle.mapper()
        result.body = self.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

#delete_secret_with_http_info(vault_base_url, secret_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a secret from a specified key vault.

The DELETE operation applies to any secret stored in Azure Key Vault. DELETE cannot be applied to an individual version of a secret. This operation requires the secrets/delete permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



6367
6368
6369
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6367

def delete_secret_with_http_info(vault_base_url, secret_name, custom_headers:nil)
  delete_secret_async(vault_base_url, secret_name, custom_headers:custom_headers).value!
end

#delete_storage_account(vault_base_url, storage_account_name, custom_headers: nil) ⇒ DeletedStorageBundle

Deletes a storage account. This operation requires the storage/delete permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

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

    A hash of custom headers that

Returns:

  • (DeletedStorageBundle)

    operation results.



8357
8358
8359
8360
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8357

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

#delete_storage_account_async(vault_base_url, storage_account_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes a storage account. This operation requires the storage/delete permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8390

def (vault_base_url, , custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'storage_account_name is nil' if .nil?
  fail ArgumentError, "'storage_account_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !.nil? && .match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'storage/{storage-account-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'storage-account-name' => },
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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
      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::DeletedStorageBundle.mapper()
        result.body = self.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

#delete_storage_account_with_http_info(vault_base_url, storage_account_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a storage account. This operation requires the storage/delete permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



8374
8375
8376
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8374

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

#encrypt(vault_base_url, key_name, key_version, algorithm, value, iv: nil, aad: nil, tag: nil, custom_headers: nil) ⇒ KeyOperationResult

Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault.

The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encrypt permission.

myvault.vault.azure.net. Possible values include: ‘RSA-OAEP’, ‘RSA-OAEP-256’, ‘RSA1_5’, ‘A128GCM’, ‘A192GCM’, ‘A256GCM’, ‘A128KW’, ‘A192KW’, ‘A256KW’, ‘A128CBC’, ‘A192CBC’, ‘A256CBC’, ‘A128CBCPAD’, ‘A192CBCPAD’, ‘A256CBCPAD’ authenticated crypto algorithms. authenticated algorithm. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • key_version (String)

    The version of the key.

  • algorithm (JsonWebKeyEncryptionAlgorithm)

    algorithm identifier.

  • value
  • iv (defaults to: nil)

    Initialization vector for symmetric algorithms.

  • aad (defaults to: nil)

    Additional data to authenticate but not encrypt/decrypt when using

  • tag (defaults to: nil)

    The tag to authenticate when performing decryption with an

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

    A hash of custom headers that

Returns:

  • (KeyOperationResult)

    operation results.



4641
4642
4643
4644
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 4641

def encrypt(vault_base_url, key_name, key_version, algorithm, value, iv:nil, aad:nil, tag:nil, custom_headers:nil)
  response = encrypt_async(vault_base_url, key_name, key_version, algorithm, value, iv:iv, aad:aad, tag:tag, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#encrypt_async(vault_base_url, key_name, key_version, algorithm, value, iv: nil, aad: nil, tag: nil, custom_headers: nil) ⇒ Concurrent::Promise

Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault.

The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encrypt permission.

myvault.vault.azure.net. Possible values include: ‘RSA-OAEP’, ‘RSA-OAEP-256’, ‘RSA1_5’, ‘A128GCM’, ‘A192GCM’, ‘A256GCM’, ‘A128KW’, ‘A192KW’, ‘A256KW’, ‘A128CBC’, ‘A192CBC’, ‘A256CBC’, ‘A128CBCPAD’, ‘A192CBCPAD’, ‘A256CBCPAD’ authenticated crypto algorithms. authenticated algorithm. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • key_version (String)

    The version of the key.

  • algorithm (JsonWebKeyEncryptionAlgorithm)

    algorithm identifier.

  • value
  • iv (defaults to: nil)

    Initialization vector for symmetric algorithms.

  • aad (defaults to: nil)

    Additional data to authenticate but not encrypt/decrypt when using

  • tag (defaults to: nil)

    The tag to authenticate when performing decryption with an

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 4718

def encrypt_async(vault_base_url, key_name, key_version, algorithm, value, iv:nil, aad:nil, tag:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, 'key_version is nil' if key_version.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'algorithm is nil' if algorithm.nil?
  fail ArgumentError, "'algorithm' should satisfy the constraint - 'MinLength': '1'" if !algorithm.nil? && algorithm.length < 1
  fail ArgumentError, 'value is nil' if value.nil?

  parameters = KeyOperationsParameters.new
  unless algorithm.nil? && value.nil? && iv.nil? && aad.nil? && tag.nil?
    parameters.algorithm = algorithm
    parameters.value = value
    parameters.iv = iv
    parameters.aad = aad
    parameters.tag = tag
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::KeyOperationsParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'keys/{key-name}/{key-version}/encrypt'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'key-name' => key_name,'key-version' => key_version},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::KeyOperationResult.mapper()
        result.body = self.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

#encrypt_with_http_info(vault_base_url, key_name, key_version, algorithm, value, iv: nil, aad: nil, tag: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault.

The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encrypt permission.

myvault.vault.azure.net. Possible values include: ‘RSA-OAEP’, ‘RSA-OAEP-256’, ‘RSA1_5’, ‘A128GCM’, ‘A192GCM’, ‘A256GCM’, ‘A128KW’, ‘A192KW’, ‘A256KW’, ‘A128CBC’, ‘A192CBC’, ‘A256CBC’, ‘A128CBCPAD’, ‘A192CBCPAD’, ‘A256CBCPAD’ authenticated crypto algorithms. authenticated algorithm. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • key_version (String)

    The version of the key.

  • algorithm (JsonWebKeyEncryptionAlgorithm)

    algorithm identifier.

  • value
  • iv (defaults to: nil)

    Initialization vector for symmetric algorithms.

  • aad (defaults to: nil)

    Additional data to authenticate but not encrypt/decrypt when using

  • tag (defaults to: nil)

    The tag to authenticate when performing decryption with an

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



4680
4681
4682
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 4680

def encrypt_with_http_info(vault_base_url, key_name, key_version, algorithm, value, iv:nil, aad:nil, tag:nil, custom_headers:nil)
  encrypt_async(vault_base_url, key_name, key_version, algorithm, value, iv:iv, aad:aad, tag:tag, custom_headers:custom_headers).value!
end

#export_key(vault_base_url, key_name, key_version, environment, custom_headers: nil) ⇒ KeyBundle

Exports a key.

The export key operation is applicable to all key types. The target key must be marked exportable. This operation requires the keys/export permission.

myvault.vault.azure.net. version of a key. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key to get.

  • key_version (String)

    Adding the version parameter retrieves a specific

  • environment (String)

    The target environment assertion.

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

    A hash of custom headers that

Returns:

  • (KeyBundle)

    operation results.



5631
5632
5633
5634
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 5631

def export_key(vault_base_url, key_name, key_version, environment, custom_headers:nil)
  response = export_key_async(vault_base_url, key_name, key_version, environment, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#export_key_async(vault_base_url, key_name, key_version, environment, custom_headers: nil) ⇒ Concurrent::Promise

Exports a key.

The export key operation is applicable to all key types. The target key must be marked exportable. This operation requires the keys/export permission.

myvault.vault.azure.net. version of a key. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key to get.

  • key_version (String)

    Adding the version parameter retrieves a specific

  • environment (String)

    The target environment assertion.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 5674

def export_key_async(vault_base_url, key_name, key_version, environment, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, 'key_version is nil' if key_version.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'environment is nil' if environment.nil?
  fail ArgumentError, "'environment' should satisfy the constraint - 'MinLength': '1'" if !environment.nil? && environment.length < 1

  parameters = KeyExportParameters.new
  unless environment.nil?
    parameters.environment = environment
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::KeyExportParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'keys/{key-name}/{key-version}/export'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'key-name' => key_name,'key-version' => key_version},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::KeyBundle.mapper()
        result.body = self.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

#export_key_with_http_info(vault_base_url, key_name, key_version, environment, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Exports a key.

The export key operation is applicable to all key types. The target key must be marked exportable. This operation requires the keys/export permission.

myvault.vault.azure.net. version of a key. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key to get.

  • key_version (String)

    Adding the version parameter retrieves a specific

  • environment (String)

    The target environment assertion.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



5653
5654
5655
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 5653

def export_key_with_http_info(vault_base_url, key_name, key_version, environment, custom_headers:nil)
  export_key_async(vault_base_url, key_name, key_version, environment, custom_headers:custom_headers).value!
end

#full_backup(vault_base_url, azure_storage_blob_container_uri: nil, custom_headers: nil) ⇒ FullBackupOperation

Creates a full backup using a user-provided SAS token to an Azure blob storage container.

myvault.vault.azure.net. access signature token pointing to a valid Azure blob container where full backup needs to be stored. This token needs to be valid for at least next 24 hours from the time of making this call will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • azure_storage_blob_container_uri (SASTokenParameter) (defaults to: nil)

    Azure blob shared

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

    A hash of custom headers that

Returns:

  • (FullBackupOperation)

    operation results.



9951
9952
9953
9954
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9951

def full_backup(vault_base_url, azure_storage_blob_container_uri:nil, custom_headers:nil)
  response = full_backup_async(vault_base_url, azure_storage_blob_container_uri:azure_storage_blob_container_uri, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#full_backup_async(vault_base_url, azure_storage_blob_container_uri: nil, custom_headers: nil) ⇒ Concurrent::Promise

Creates a full backup using a user-provided SAS token to an Azure blob storage container.

myvault.vault.azure.net. access signature token pointing to a valid Azure blob container where full backup needs to be stored. This token needs to be valid for at least next 24 hours from the time of making this call to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • azure_storage_blob_container_uri (SASTokenParameter) (defaults to: nil)

    Azure blob shared

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9990

def full_backup_async(vault_base_url, azure_storage_blob_container_uri:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::SASTokenParameter.mapper()
  request_content = self.serialize(request_mapper,  azure_storage_blob_container_uri)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'backup'

  request_url = @base_url || self.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' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::FullBackupOperation.mapper()
        result.body = self.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

#full_backup_status(vault_base_url, job_id, custom_headers: nil) ⇒ FullBackupOperation

Returns the status of full backup operation

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • job_id (String)

    The id returned as part of the backup request

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

    A hash of custom headers that

Returns:

  • (FullBackupOperation)

    operation results.



10061
10062
10063
10064
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10061

def full_backup_status(vault_base_url, job_id, custom_headers:nil)
  response = full_backup_status_async(vault_base_url, job_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#full_backup_status_async(vault_base_url, job_id, custom_headers: nil) ⇒ Concurrent::Promise

Returns the status of full backup operation

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • job_id (String)

    The id returned as part of the backup request

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10092

def full_backup_status_async(vault_base_url, job_id, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'job_id is nil' if job_id.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'backup/{jobId}/pending'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'jobId' => job_id},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::FullBackupOperation.mapper()
        result.body = self.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

#full_backup_status_with_http_info(vault_base_url, job_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Returns the status of full backup operation

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • job_id (String)

    The id returned as part of the backup request

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



10077
10078
10079
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10077

def full_backup_status_with_http_info(vault_base_url, job_id, custom_headers:nil)
  full_backup_status_async(vault_base_url, job_id, custom_headers:custom_headers).value!
end

#full_backup_with_http_info(vault_base_url, azure_storage_blob_container_uri: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a full backup using a user-provided SAS token to an Azure blob storage container.

myvault.vault.azure.net. access signature token pointing to a valid Azure blob container where full backup needs to be stored. This token needs to be valid for at least next 24 hours from the time of making this call will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • azure_storage_blob_container_uri (SASTokenParameter) (defaults to: nil)

    Azure blob shared

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



9971
9972
9973
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9971

def full_backup_with_http_info(vault_base_url, azure_storage_blob_container_uri:nil, custom_headers:nil)
  full_backup_async(vault_base_url, azure_storage_blob_container_uri:azure_storage_blob_container_uri, custom_headers:custom_headers).value!
end

#full_restore_operation(vault_base_url, restore_blob_details: nil, custom_headers: nil) ⇒ RestoreOperation

Restores all key materials using the SAS token pointing to a previously stored Azure Blob storage backup folder

myvault.vault.azure.net. token pointing to a folder where the previous successful full backup was stored will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • restore_blob_details (RestoreOperationParameters) (defaults to: nil)

    The Azure blob SAS

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

    A hash of custom headers that

Returns:

  • (RestoreOperation)

    operation results.



10161
10162
10163
10164
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10161

def full_restore_operation(vault_base_url, restore_blob_details:nil, custom_headers:nil)
  response = full_restore_operation_async(vault_base_url, restore_blob_details:restore_blob_details, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#full_restore_operation_async(vault_base_url, restore_blob_details: nil, custom_headers: nil) ⇒ Concurrent::Promise

Restores all key materials using the SAS token pointing to a previously stored Azure Blob storage backup folder

myvault.vault.azure.net. token pointing to a folder where the previous successful full backup was stored to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • restore_blob_details (RestoreOperationParameters) (defaults to: nil)

    The Azure blob SAS

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10198

def full_restore_operation_async(vault_base_url, restore_blob_details:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::RestoreOperationParameters.mapper()
  request_content = self.serialize(request_mapper,  restore_blob_details)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'restore'

  request_url = @base_url || self.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' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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 == 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::RestoreOperation.mapper()
        result.body = self.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

#full_restore_operation_with_http_info(vault_base_url, restore_blob_details: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Restores all key materials using the SAS token pointing to a previously stored Azure Blob storage backup folder

myvault.vault.azure.net. token pointing to a folder where the previous successful full backup was stored will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • restore_blob_details (RestoreOperationParameters) (defaults to: nil)

    The Azure blob SAS

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



10180
10181
10182
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10180

def full_restore_operation_with_http_info(vault_base_url, restore_blob_details:nil, custom_headers:nil)
  full_restore_operation_async(vault_base_url, restore_blob_details:restore_blob_details, custom_headers:custom_headers).value!
end

#get_certificate(vault_base_url, certificate_name, certificate_version, custom_headers: nil) ⇒ CertificateBundle

Gets information about a certificate.

Gets information about a specific certificate. This operation requires the certificates/get permission.

myvault.vault.azure.net. vault. fragment is optional. If not specified, the latest version of the certificate is returned. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate in the given

  • certificate_version (String)

    The version of the certificate. This URI

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

    A hash of custom headers that

Returns:

  • (CertificateBundle)

    operation results.



2098
2099
2100
2101
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2098

def get_certificate(vault_base_url, certificate_name, certificate_version, custom_headers:nil)
  response = get_certificate_async(vault_base_url, certificate_name, certificate_version, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_certificate_async(vault_base_url, certificate_name, certificate_version, custom_headers: nil) ⇒ Concurrent::Promise

Gets information about a certificate.

Gets information about a specific certificate. This operation requires the certificates/get permission.

myvault.vault.azure.net. vault. fragment is optional. If not specified, the latest version of the certificate is returned. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate in the given

  • certificate_version (String)

    The version of the certificate. This URI

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2143

def get_certificate_async(vault_base_url, certificate_name, certificate_version, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'certificate_name is nil' if certificate_name.nil?
  fail ArgumentError, 'certificate_version is nil' if certificate_version.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'certificates/{certificate-name}/{certificate-version}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'certificate-name' => certificate_name,'certificate-version' => certificate_version},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::CertificateBundle.mapper()
        result.body = self.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_certificate_contacts(vault_base_url, custom_headers: nil) ⇒ Contacts

Lists the certificate contacts for a specified key vault.

The GetCertificateContacts operation returns the set of certificate contact resources in the specified key vault. This operation requires the certificates/managecontacts permission.

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:

  • (Contacts)

    operation results.



480
481
482
483
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 480

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

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

Lists the certificate contacts for a specified key vault.

The GetCertificateContacts operation returns the set of certificate contact resources in the specified key vault. This operation requires the certificates/managecontacts permission.

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.



517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 517

def get_certificate_contacts_async(vault_base_url, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'certificates/contacts'

  request_url = @base_url || self.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' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::Contacts.mapper()
        result.body = self.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_certificate_contacts_with_http_info(vault_base_url, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the certificate contacts for a specified key vault.

The GetCertificateContacts operation returns the set of certificate contact resources in the specified key vault. This operation requires the certificates/managecontacts permission.

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.



499
500
501
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 499

def get_certificate_contacts_with_http_info(vault_base_url, custom_headers:nil)
  get_certificate_contacts_async(vault_base_url, custom_headers:custom_headers).value!
end

#get_certificate_issuer(vault_base_url, issuer_name, custom_headers: nil) ⇒ IssuerBundle

Lists the specified certificate issuer.

The GetCertificateIssuer operation returns the specified certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • issuer_name (String)

    The name of the issuer.

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

    A hash of custom headers that

Returns:

  • (IssuerBundle)

    operation results.



1078
1079
1080
1081
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1078

def get_certificate_issuer(vault_base_url, issuer_name, custom_headers:nil)
  response = get_certificate_issuer_async(vault_base_url, issuer_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_certificate_issuer_async(vault_base_url, issuer_name, custom_headers: nil) ⇒ Concurrent::Promise

Lists the specified certificate issuer.

The GetCertificateIssuer operation returns the specified certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • issuer_name (String)

    The name of the issuer.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1117

def get_certificate_issuer_async(vault_base_url, issuer_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'issuer_name is nil' if issuer_name.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'certificates/issuers/{issuer-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'issuer-name' => issuer_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::IssuerBundle.mapper()
        result.body = self.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_certificate_issuer_with_http_info(vault_base_url, issuer_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the specified certificate issuer.

The GetCertificateIssuer operation returns the specified certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • issuer_name (String)

    The name of the issuer.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1098
1099
1100
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1098

def get_certificate_issuer_with_http_info(vault_base_url, issuer_name, custom_headers:nil)
  get_certificate_issuer_async(vault_base_url, issuer_name, custom_headers:custom_headers).value!
end

#get_certificate_issuers(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ Array<CertificateIssuerItem>

List certificate issuers for a specified key vault.

The GetCertificateIssuers operation returns the set of certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (Array<CertificateIssuerItem>)

    operation results.



687
688
689
690
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 687

def get_certificate_issuers(vault_base_url, maxresults:nil, custom_headers:nil)
  first_page = get_certificate_issuers_as_lazy(vault_base_url, maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_certificate_issuers_as_lazy(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ CertificateIssuerListResult

List certificate issuers for a specified key vault.

The GetCertificateIssuers operation returns the set of certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (CertificateIssuerListResult)

    operation results.



12381
12382
12383
12384
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12381

def get_certificate_issuers_as_lazy(vault_base_url, maxresults:nil, custom_headers:nil)
  first_page = get_certificate_issuers_as_lazy_as_lazy(vault_base_url, maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_certificate_issuers_as_lazy_async(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

List certificate issuers for a specified key vault.

The GetCertificateIssuers operation returns the set of certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
12452
12453
12454
12455
12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12422

def get_certificate_issuers_as_lazy_async(vault_base_url, maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  path_template = 'certificates/issuers'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'maxresults' => maxresults},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::CertificateIssuerListResult.mapper()
        result.body = self.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_certificate_issuers_as_lazy_with_http_info(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List certificate issuers for a specified key vault.

The GetCertificateIssuers operation returns the set of certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



12402
12403
12404
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12402

def get_certificate_issuers_as_lazy_with_http_info(vault_base_url, maxresults:nil, custom_headers:nil)
  get_certificate_issuers_as_lazy_async(vault_base_url, maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_certificate_issuers_async(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

List certificate issuers for a specified key vault.

The GetCertificateIssuers operation returns the set of certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 728

def get_certificate_issuers_async(vault_base_url, maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'certificates/issuers'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'maxresults' => maxresults,'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::CertificateIssuerListResult.mapper()
        result.body = self.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_certificate_issuers_next(next_page_link, custom_headers: nil) ⇒ CertificateIssuerListResult

List certificate issuers for a specified key vault.

The GetCertificateIssuers operation returns the set of certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (CertificateIssuerListResult)

    operation results.



10934
10935
10936
10937
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10934

def get_certificate_issuers_next(next_page_link, custom_headers:nil)
  response = get_certificate_issuers_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_certificate_issuers_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

List certificate issuers for a specified key vault.

The GetCertificateIssuers operation returns the set of certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10971

def get_certificate_issuers_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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'] = accept_language unless accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::CertificateIssuerListResult.mapper()
        result.body = self.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_certificate_issuers_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List certificate issuers for a specified key vault.

The GetCertificateIssuers operation returns the set of certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



10953
10954
10955
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10953

def get_certificate_issuers_next_with_http_info(next_page_link, custom_headers:nil)
  get_certificate_issuers_next_async(next_page_link, custom_headers:custom_headers).value!
end

#get_certificate_issuers_with_http_info(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List certificate issuers for a specified key vault.

The GetCertificateIssuers operation returns the set of certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



708
709
710
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 708

def get_certificate_issuers_with_http_info(vault_base_url, maxresults:nil, custom_headers:nil)
  get_certificate_issuers_async(vault_base_url, maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_certificate_operation(vault_base_url, certificate_name, custom_headers: nil) ⇒ CertificateOperation

Gets the creation operation of a certificate.

Gets the creation operation associated with a specified certificate. This operation requires the certificates/get permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

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

    A hash of custom headers that

Returns:

  • (CertificateOperation)

    operation results.



2337
2338
2339
2340
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2337

def get_certificate_operation(vault_base_url, certificate_name, custom_headers:nil)
  response = get_certificate_operation_async(vault_base_url, certificate_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_certificate_operation_async(vault_base_url, certificate_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the creation operation of a certificate.

Gets the creation operation associated with a specified certificate. This operation requires the certificates/get permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2374

def get_certificate_operation_async(vault_base_url, certificate_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'certificate_name is nil' if certificate_name.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'certificates/{certificate-name}/pending'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'certificate-name' => certificate_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::CertificateOperation.mapper()
        result.body = self.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_certificate_operation_with_http_info(vault_base_url, certificate_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the creation operation of a certificate.

Gets the creation operation associated with a specified certificate. This operation requires the certificates/get permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



2356
2357
2358
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2356

def get_certificate_operation_with_http_info(vault_base_url, certificate_name, custom_headers:nil)
  get_certificate_operation_async(vault_base_url, certificate_name, custom_headers:custom_headers).value!
end

#get_certificate_policy(vault_base_url, certificate_name, custom_headers: nil) ⇒ CertificatePolicy

Lists the policy for a certificate.

The GetCertificatePolicy operation returns the specified certificate policy resources in the specified key vault. This operation requires the certificates/get permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate in a given key

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

    A hash of custom headers that

Returns:

  • (CertificatePolicy)

    operation results.



1717
1718
1719
1720
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1717

def get_certificate_policy(vault_base_url, certificate_name, custom_headers:nil)
  response = get_certificate_policy_async(vault_base_url, certificate_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_certificate_policy_async(vault_base_url, certificate_name, custom_headers: nil) ⇒ Concurrent::Promise

Lists the policy for a certificate.

The GetCertificatePolicy operation returns the specified certificate policy resources in the specified key vault. This operation requires the certificates/get permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate in a given key

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1758

def get_certificate_policy_async(vault_base_url, certificate_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'certificate_name is nil' if certificate_name.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'certificates/{certificate-name}/policy'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'certificate-name' => certificate_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::CertificatePolicy.mapper()
        result.body = self.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_certificate_policy_with_http_info(vault_base_url, certificate_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the policy for a certificate.

The GetCertificatePolicy operation returns the specified certificate policy resources in the specified key vault. This operation requires the certificates/get permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate in a given key

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1738
1739
1740
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1738

def get_certificate_policy_with_http_info(vault_base_url, certificate_name, custom_headers:nil)
  get_certificate_policy_async(vault_base_url, certificate_name, custom_headers:custom_headers).value!
end

#get_certificate_versions(vault_base_url, certificate_name, maxresults: nil, custom_headers: nil) ⇒ Array<CertificateItem>

List the versions of a certificate.

The GetCertificateVersions operation returns the versions of a certificate in the specified key vault. This operation requires the certificates/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (Array<CertificateItem>)

    operation results.



1601
1602
1603
1604
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1601

def get_certificate_versions(vault_base_url, certificate_name, maxresults:nil, custom_headers:nil)
  first_page = get_certificate_versions_as_lazy(vault_base_url, certificate_name, maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_certificate_versions_as_lazy(vault_base_url, certificate_name, maxresults: nil, custom_headers: nil) ⇒ CertificateListResult

List the versions of a certificate.

The GetCertificateVersions operation returns the versions of a certificate in the specified key vault. This operation requires the certificates/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (CertificateListResult)

    operation results.



12489
12490
12491
12492
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12489

def get_certificate_versions_as_lazy(vault_base_url, certificate_name, maxresults:nil, custom_headers:nil)
  first_page = get_certificate_versions_as_lazy_as_lazy(vault_base_url, certificate_name, maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_certificate_versions_as_lazy_async(vault_base_url, certificate_name, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

List the versions of a certificate.

The GetCertificateVersions operation returns the versions of a certificate in the specified key vault. This operation requires the certificates/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
12549
12550
12551
12552
12553
12554
12555
12556
12557
12558
12559
12560
12561
12562
12563
12564
12565
12566
12567
12568
12569
12570
12571
12572
12573
12574
12575
12576
12577
12578
12579
12580
12581
12582
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12532

def get_certificate_versions_as_lazy_async(vault_base_url, certificate_name, maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'certificate_name is nil' if certificate_name.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  path_template = 'certificates/{certificate-name}/versions'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'certificate-name' => certificate_name},
      query_params: {'maxresults' => maxresults},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::CertificateListResult.mapper()
        result.body = self.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_certificate_versions_as_lazy_with_http_info(vault_base_url, certificate_name, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List the versions of a certificate.

The GetCertificateVersions operation returns the versions of a certificate in the specified key vault. This operation requires the certificates/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



12511
12512
12513
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12511

def get_certificate_versions_as_lazy_with_http_info(vault_base_url, certificate_name, maxresults:nil, custom_headers:nil)
  get_certificate_versions_as_lazy_async(vault_base_url, certificate_name, maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_certificate_versions_async(vault_base_url, certificate_name, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

List the versions of a certificate.

The GetCertificateVersions operation returns the versions of a certificate in the specified key vault. This operation requires the certificates/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1644

def get_certificate_versions_async(vault_base_url, certificate_name, maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'certificate_name is nil' if certificate_name.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'certificates/{certificate-name}/versions'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'certificate-name' => certificate_name},
      query_params: {'maxresults' => maxresults,'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::CertificateListResult.mapper()
        result.body = self.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_certificate_versions_next(next_page_link, custom_headers: nil) ⇒ CertificateListResult

List the versions of a certificate.

The GetCertificateVersions operation returns the versions of a certificate in the specified key vault. This operation requires the certificates/list permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (CertificateListResult)

    operation results.



11036
11037
11038
11039
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11036

def get_certificate_versions_next(next_page_link, custom_headers:nil)
  response = get_certificate_versions_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_certificate_versions_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

List the versions of a certificate.

The GetCertificateVersions operation returns the versions of a certificate in the specified key vault. This operation requires the certificates/list permission.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11073

def get_certificate_versions_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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'] = accept_language unless accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::CertificateListResult.mapper()
        result.body = self.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_certificate_versions_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List the versions of a certificate.

The GetCertificateVersions operation returns the versions of a certificate in the specified key vault. This operation requires the certificates/list permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



11055
11056
11057
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11055

def get_certificate_versions_next_with_http_info(next_page_link, custom_headers:nil)
  get_certificate_versions_next_async(next_page_link, custom_headers:custom_headers).value!
end

#get_certificate_versions_with_http_info(vault_base_url, certificate_name, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List the versions of a certificate.

The GetCertificateVersions operation returns the versions of a certificate in the specified key vault. This operation requires the certificates/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1623
1624
1625
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1623

def get_certificate_versions_with_http_info(vault_base_url, certificate_name, maxresults:nil, custom_headers:nil)
  get_certificate_versions_async(vault_base_url, certificate_name, maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_certificate_with_http_info(vault_base_url, certificate_name, certificate_version, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets information about a certificate.

Gets information about a specific certificate. This operation requires the certificates/get permission.

myvault.vault.azure.net. vault. fragment is optional. If not specified, the latest version of the certificate is returned. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate in the given

  • certificate_version (String)

    The version of the certificate. This URI

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



2121
2122
2123
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2121

def get_certificate_with_http_info(vault_base_url, certificate_name, certificate_version, custom_headers:nil)
  get_certificate_async(vault_base_url, certificate_name, certificate_version, custom_headers:custom_headers).value!
end

#get_certificates(vault_base_url, maxresults: nil, include_pending: nil, custom_headers: nil) ⇒ Array<CertificateItem>

List certificates in a specified key vault

The GetCertificates operation returns the set of certificates resources in the specified key vault. This operation requires the certificates/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. which are not completely provisioned. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • include_pending (Boolean) (defaults to: nil)

    Specifies whether to include certificates

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

    A hash of custom headers that

Returns:

  • (Array<CertificateItem>)

    operation results.



142
143
144
145
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 142

def get_certificates(vault_base_url, maxresults:nil, include_pending:nil, custom_headers:nil)
  first_page = get_certificates_as_lazy(vault_base_url, maxresults:maxresults, include_pending:include_pending, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_certificates_as_lazy(vault_base_url, maxresults: nil, include_pending: nil, custom_headers: nil) ⇒ CertificateListResult

List certificates in a specified key vault

The GetCertificates operation returns the set of certificates resources in the specified key vault. This operation requires the certificates/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. which are not completely provisioned. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • include_pending (Boolean) (defaults to: nil)

    Specifies whether to include certificates

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

    A hash of custom headers that

Returns:

  • (CertificateListResult)

    operation results.



12270
12271
12272
12273
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12270

def get_certificates_as_lazy(vault_base_url, maxresults:nil, include_pending:nil, custom_headers:nil)
  first_page = get_certificates_as_lazy_as_lazy(vault_base_url, maxresults:maxresults, include_pending:include_pending, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_certificates_as_lazy_async(vault_base_url, maxresults: nil, include_pending: nil, custom_headers: nil) ⇒ Concurrent::Promise

List certificates in a specified key vault

The GetCertificates operation returns the set of certificates resources in the specified key vault. This operation requires the certificates/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. which are not completely provisioned. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • include_pending (Boolean) (defaults to: nil)

    Specifies whether to include certificates

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



12315
12316
12317
12318
12319
12320
12321
12322
12323
12324
12325
12326
12327
12328
12329
12330
12331
12332
12333
12334
12335
12336
12337
12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12315

def get_certificates_as_lazy_async(vault_base_url, maxresults:nil, include_pending:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  path_template = 'certificates'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'maxresults' => maxresults,'includePending' => include_pending},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::CertificateListResult.mapper()
        result.body = self.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_certificates_as_lazy_with_http_info(vault_base_url, maxresults: nil, include_pending: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List certificates in a specified key vault

The GetCertificates operation returns the set of certificates resources in the specified key vault. This operation requires the certificates/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. which are not completely provisioned. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • include_pending (Boolean) (defaults to: nil)

    Specifies whether to include certificates

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



12293
12294
12295
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12293

def get_certificates_as_lazy_with_http_info(vault_base_url, maxresults:nil, include_pending:nil, custom_headers:nil)
  get_certificates_as_lazy_async(vault_base_url, maxresults:maxresults, include_pending:include_pending, custom_headers:custom_headers).value!
end

#get_certificates_async(vault_base_url, maxresults: nil, include_pending: nil, custom_headers: nil) ⇒ Concurrent::Promise

List certificates in a specified key vault

The GetCertificates operation returns the set of certificates resources in the specified key vault. This operation requires the certificates/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. which are not completely provisioned. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • include_pending (Boolean) (defaults to: nil)

    Specifies whether to include certificates

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

def get_certificates_async(vault_base_url, maxresults:nil, include_pending:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'certificates'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'maxresults' => maxresults,'includePending' => include_pending,'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::CertificateListResult.mapper()
        result.body = self.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_certificates_next(next_page_link, custom_headers: nil) ⇒ CertificateListResult

List certificates in a specified key vault

The GetCertificates operation returns the set of certificates resources in the specified key vault. This operation requires the certificates/list permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (CertificateListResult)

    operation results.



10832
10833
10834
10835
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10832

def get_certificates_next(next_page_link, custom_headers:nil)
  response = get_certificates_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_certificates_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

List certificates in a specified key vault

The GetCertificates operation returns the set of certificates resources in the specified key vault. This operation requires the certificates/list permission.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10869

def get_certificates_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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'] = accept_language unless accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::CertificateListResult.mapper()
        result.body = self.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_certificates_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List certificates in a specified key vault

The GetCertificates operation returns the set of certificates resources in the specified key vault. This operation requires the certificates/list permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



10851
10852
10853
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10851

def get_certificates_next_with_http_info(next_page_link, custom_headers:nil)
  get_certificates_next_async(next_page_link, custom_headers:custom_headers).value!
end

#get_certificates_with_http_info(vault_base_url, maxresults: nil, include_pending: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List certificates in a specified key vault

The GetCertificates operation returns the set of certificates resources in the specified key vault. This operation requires the certificates/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. which are not completely provisioned. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • include_pending (Boolean) (defaults to: nil)

    Specifies whether to include certificates

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



165
166
167
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 165

def get_certificates_with_http_info(vault_base_url, maxresults:nil, include_pending:nil, custom_headers:nil)
  get_certificates_async(vault_base_url, maxresults:maxresults, include_pending:include_pending, custom_headers:custom_headers).value!
end

#get_deleted_certificate(vault_base_url, certificate_name, custom_headers: nil) ⇒ DeletedCertificateBundle

Retrieves information about the specified deleted certificate.

The GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent deletion and the current deletion recovery level. This operation requires the certificates/get permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate

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

    A hash of custom headers that

Returns:

  • (DeletedCertificateBundle)

    operation results.



3053
3054
3055
3056
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 3053

def get_deleted_certificate(vault_base_url, certificate_name, custom_headers:nil)
  response = get_deleted_certificate_async(vault_base_url, certificate_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_deleted_certificate_async(vault_base_url, certificate_name, custom_headers: nil) ⇒ Concurrent::Promise

Retrieves information about the specified deleted certificate.

The GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent deletion and the current deletion recovery level. This operation requires the certificates/get permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 3094

def get_deleted_certificate_async(vault_base_url, certificate_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'certificate_name is nil' if certificate_name.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'deletedcertificates/{certificate-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'certificate-name' => certificate_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::DeletedCertificateBundle.mapper()
        result.body = self.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_deleted_certificate_with_http_info(vault_base_url, certificate_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves information about the specified deleted certificate.

The GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent deletion and the current deletion recovery level. This operation requires the certificates/get permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



3074
3075
3076
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 3074

def get_deleted_certificate_with_http_info(vault_base_url, certificate_name, custom_headers:nil)
  get_deleted_certificate_async(vault_base_url, certificate_name, custom_headers:custom_headers).value!
end

#get_deleted_certificates(vault_base_url, maxresults: nil, include_pending: nil, custom_headers: nil) ⇒ Array<DeletedCertificateItem>

Lists the deleted certificates in the specified vault currently available for recovery.

The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.

myvault.vault.azure.net. not specified the service will return up to 25 results. which are not completely provisioned. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • include_pending (Boolean) (defaults to: nil)

    Specifies whether to include certificates

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

    A hash of custom headers that

Returns:

  • (Array<DeletedCertificateItem>)

    operation results.



2931
2932
2933
2934
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2931

def get_deleted_certificates(vault_base_url, maxresults:nil, include_pending:nil, custom_headers:nil)
  first_page = get_deleted_certificates_as_lazy(vault_base_url, maxresults:maxresults, include_pending:include_pending, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_deleted_certificates_as_lazy(vault_base_url, maxresults: nil, include_pending: nil, custom_headers: nil) ⇒ DeletedCertificateListResult

Lists the deleted certificates in the specified vault currently available for recovery.

The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.

myvault.vault.azure.net. not specified the service will return up to 25 results. which are not completely provisioned. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • include_pending (Boolean) (defaults to: nil)

    Specifies whether to include certificates

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

    A hash of custom headers that

Returns:

  • (DeletedCertificateListResult)

    operation results.



12605
12606
12607
12608
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12605

def get_deleted_certificates_as_lazy(vault_base_url, maxresults:nil, include_pending:nil, custom_headers:nil)
  first_page = get_deleted_certificates_as_lazy_as_lazy(vault_base_url, maxresults:maxresults, include_pending:include_pending, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_deleted_certificates_as_lazy_async(vault_base_url, maxresults: nil, include_pending: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the deleted certificates in the specified vault currently available for recovery.

The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.

myvault.vault.azure.net. not specified the service will return up to 25 results. which are not completely provisioned. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • include_pending (Boolean) (defaults to: nil)

    Specifies whether to include certificates

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



12656
12657
12658
12659
12660
12661
12662
12663
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
12675
12676
12677
12678
12679
12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
12690
12691
12692
12693
12694
12695
12696
12697
12698
12699
12700
12701
12702
12703
12704
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12656

def get_deleted_certificates_as_lazy_async(vault_base_url, maxresults:nil, include_pending:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  path_template = 'deletedcertificates'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'maxresults' => maxresults,'includePending' => include_pending},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::DeletedCertificateListResult.mapper()
        result.body = self.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_deleted_certificates_as_lazy_with_http_info(vault_base_url, maxresults: nil, include_pending: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the deleted certificates in the specified vault currently available for recovery.

The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.

myvault.vault.azure.net. not specified the service will return up to 25 results. which are not completely provisioned. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • include_pending (Boolean) (defaults to: nil)

    Specifies whether to include certificates

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



12631
12632
12633
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12631

def get_deleted_certificates_as_lazy_with_http_info(vault_base_url, maxresults:nil, include_pending:nil, custom_headers:nil)
  get_deleted_certificates_as_lazy_async(vault_base_url, maxresults:maxresults, include_pending:include_pending, custom_headers:custom_headers).value!
end

#get_deleted_certificates_async(vault_base_url, maxresults: nil, include_pending: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the deleted certificates in the specified vault currently available for recovery.

The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.

myvault.vault.azure.net. not specified the service will return up to 25 results. which are not completely provisioned. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • include_pending (Boolean) (defaults to: nil)

    Specifies whether to include certificates

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2982

def get_deleted_certificates_async(vault_base_url, maxresults:nil, include_pending:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'deletedcertificates'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'maxresults' => maxresults,'includePending' => include_pending,'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::DeletedCertificateListResult.mapper()
        result.body = self.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_deleted_certificates_next(next_page_link, custom_headers: nil) ⇒ DeletedCertificateListResult

Lists the deleted certificates in the specified vault currently available for recovery.

The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (DeletedCertificateListResult)

    operation results.



11141
11142
11143
11144
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11141

def get_deleted_certificates_next(next_page_link, custom_headers:nil)
  response = get_deleted_certificates_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_deleted_certificates_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Lists the deleted certificates in the specified vault currently available for recovery.

The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11184

def get_deleted_certificates_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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'] = accept_language unless accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::DeletedCertificateListResult.mapper()
        result.body = self.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_deleted_certificates_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the deleted certificates in the specified vault currently available for recovery.

The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



11163
11164
11165
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11163

def get_deleted_certificates_next_with_http_info(next_page_link, custom_headers:nil)
  get_deleted_certificates_next_async(next_page_link, custom_headers:custom_headers).value!
end

#get_deleted_certificates_with_http_info(vault_base_url, maxresults: nil, include_pending: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the deleted certificates in the specified vault currently available for recovery.

The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.

myvault.vault.azure.net. not specified the service will return up to 25 results. which are not completely provisioned. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • include_pending (Boolean) (defaults to: nil)

    Specifies whether to include certificates

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



2957
2958
2959
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2957

def get_deleted_certificates_with_http_info(vault_base_url, maxresults:nil, include_pending:nil, custom_headers:nil)
  get_deleted_certificates_async(vault_base_url, maxresults:maxresults, include_pending:include_pending, custom_headers:custom_headers).value!
end

#get_deleted_key(vault_base_url, key_name, custom_headers: nil) ⇒ DeletedKeyBundle

Gets the public part of a deleted key.

The Get Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/get permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

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

    A hash of custom headers that

Returns:

  • (DeletedKeyBundle)

    operation results.



5880
5881
5882
5883
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 5880

def get_deleted_key(vault_base_url, key_name, custom_headers:nil)
  response = get_deleted_key_async(vault_base_url, key_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_deleted_key_async(vault_base_url, key_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the public part of a deleted key.

The Get Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/get permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 5921

def get_deleted_key_async(vault_base_url, key_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'deletedkeys/{key-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'key-name' => key_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::DeletedKeyBundle.mapper()
        result.body = self.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_deleted_key_with_http_info(vault_base_url, key_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the public part of a deleted key.

The Get Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/get permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



5901
5902
5903
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 5901

def get_deleted_key_with_http_info(vault_base_url, key_name, custom_headers:nil)
  get_deleted_key_async(vault_base_url, key_name, custom_headers:custom_headers).value!
end

#get_deleted_keys(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ Array<DeletedKeyItem>

Lists the deleted keys in the specified vault.

Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for vaults enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (Array<DeletedKeyItem>)

    operation results.



5762
5763
5764
5765
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 5762

def get_deleted_keys(vault_base_url, maxresults:nil, custom_headers:nil)
  first_page = get_deleted_keys_as_lazy(vault_base_url, maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_deleted_keys_as_lazy(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ DeletedKeyListResult

Lists the deleted keys in the specified vault.

Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for vaults enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (DeletedKeyListResult)

    operation results.



12947
12948
12949
12950
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12947

def get_deleted_keys_as_lazy(vault_base_url, maxresults:nil, custom_headers:nil)
  first_page = get_deleted_keys_as_lazy_as_lazy(vault_base_url, maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_deleted_keys_as_lazy_async(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the deleted keys in the specified vault.

Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for vaults enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



12994
12995
12996
12997
12998
12999
13000
13001
13002
13003
13004
13005
13006
13007
13008
13009
13010
13011
13012
13013
13014
13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12994

def get_deleted_keys_as_lazy_async(vault_base_url, maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  path_template = 'deletedkeys'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'maxresults' => maxresults},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::DeletedKeyListResult.mapper()
        result.body = self.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_deleted_keys_as_lazy_with_http_info(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the deleted keys in the specified vault.

Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for vaults enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



12971
12972
12973
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12971

def get_deleted_keys_as_lazy_with_http_info(vault_base_url, maxresults:nil, custom_headers:nil)
  get_deleted_keys_as_lazy_async(vault_base_url, maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_deleted_keys_async(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the deleted keys in the specified vault.

Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for vaults enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 5809

def get_deleted_keys_async(vault_base_url, maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'deletedkeys'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'maxresults' => maxresults,'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::DeletedKeyListResult.mapper()
        result.body = self.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_deleted_keys_next(next_page_link, custom_headers: nil) ⇒ DeletedKeyListResult

Lists the deleted keys in the specified vault.

Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for vaults enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (DeletedKeyListResult)

    operation results.



11459
11460
11461
11462
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11459

def get_deleted_keys_next(next_page_link, custom_headers:nil)
  response = get_deleted_keys_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_deleted_keys_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Lists the deleted keys in the specified vault.

Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for vaults enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11502

def get_deleted_keys_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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'] = accept_language unless accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::DeletedKeyListResult.mapper()
        result.body = self.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_deleted_keys_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the deleted keys in the specified vault.

Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for vaults enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



11481
11482
11483
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11481

def get_deleted_keys_next_with_http_info(next_page_link, custom_headers:nil)
  get_deleted_keys_next_async(next_page_link, custom_headers:custom_headers).value!
end

#get_deleted_keys_with_http_info(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the deleted keys in the specified vault.

Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for vaults enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



5786
5787
5788
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 5786

def get_deleted_keys_with_http_info(vault_base_url, maxresults:nil, custom_headers:nil)
  get_deleted_keys_async(vault_base_url, maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_deleted_sas_definition(vault_base_url, storage_account_name, sas_definition_name, custom_headers: nil) ⇒ DeletedSasDefinitionBundle

Gets the specified deleted sas definition.

The Get Deleted SAS Definition operation returns the specified deleted SAS definition along with its attributes. This operation requires the storage/getsas permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • sas_definition_name (String)

    The name of the SAS definition.

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

    A hash of custom headers that

Returns:

  • (DeletedSasDefinitionBundle)

    operation results.



9199
9200
9201
9202
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9199

def get_deleted_sas_definition(vault_base_url, , sas_definition_name, custom_headers:nil)
  response = get_deleted_sas_definition_async(vault_base_url, , sas_definition_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_deleted_sas_definition_async(vault_base_url, storage_account_name, sas_definition_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the specified deleted sas definition.

The Get Deleted SAS Definition operation returns the specified deleted SAS definition along with its attributes. This operation requires the storage/getsas permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • sas_definition_name (String)

    The name of the SAS definition.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9240

def get_deleted_sas_definition_async(vault_base_url, , sas_definition_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'storage_account_name is nil' if .nil?
  fail ArgumentError, "'storage_account_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !.nil? && .match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, 'sas_definition_name is nil' if sas_definition_name.nil?
  fail ArgumentError, "'sas_definition_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !sas_definition_name.nil? && sas_definition_name.match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'deletedstorage/{storage-account-name}/sas/{sas-definition-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'storage-account-name' => ,'sas-definition-name' => sas_definition_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::DeletedSasDefinitionBundle.mapper()
        result.body = self.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_deleted_sas_definition_with_http_info(vault_base_url, storage_account_name, sas_definition_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the specified deleted sas definition.

The Get Deleted SAS Definition operation returns the specified deleted SAS definition along with its attributes. This operation requires the storage/getsas permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • sas_definition_name (String)

    The name of the SAS definition.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



9220
9221
9222
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9220

def get_deleted_sas_definition_with_http_info(vault_base_url, , sas_definition_name, custom_headers:nil)
  get_deleted_sas_definition_async(vault_base_url, , sas_definition_name, custom_headers:custom_headers).value!
end

#get_deleted_sas_definitions(vault_base_url, storage_account_name, maxresults: nil, custom_headers: nil) ⇒ Array<DeletedSasDefinitionItem>

Lists deleted SAS definitions for the specified vault and storage account.

The Get Deleted Sas Definitions operation returns the SAS definitions that have been deleted for a vault enabled for soft-delete. This operation requires the storage/listsas permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (Array<DeletedSasDefinitionItem>)

    operation results.



9082
9083
9084
9085
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9082

def get_deleted_sas_definitions(vault_base_url, , maxresults:nil, custom_headers:nil)
  first_page = get_deleted_sas_definitions_as_lazy(vault_base_url, , maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_deleted_sas_definitions_as_lazy(vault_base_url, storage_account_name, maxresults: nil, custom_headers: nil) ⇒ DeletedSasDefinitionListResult

Lists deleted SAS definitions for the specified vault and storage account.

The Get Deleted Sas Definitions operation returns the SAS definitions that have been deleted for a vault enabled for soft-delete. This operation requires the storage/listsas permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (DeletedSasDefinitionListResult)

    operation results.



13699
13700
13701
13702
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 13699

def get_deleted_sas_definitions_as_lazy(vault_base_url, , maxresults:nil, custom_headers:nil)
  first_page = get_deleted_sas_definitions_as_lazy_as_lazy(vault_base_url, , maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_deleted_sas_definitions_as_lazy_async(vault_base_url, storage_account_name, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists deleted SAS definitions for the specified vault and storage account.

The Get Deleted Sas Definitions operation returns the SAS definitions that have been deleted for a vault enabled for soft-delete. This operation requires the storage/listsas permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



13742
13743
13744
13745
13746
13747
13748
13749
13750
13751
13752
13753
13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
13764
13765
13766
13767
13768
13769
13770
13771
13772
13773
13774
13775
13776
13777
13778
13779
13780
13781
13782
13783
13784
13785
13786
13787
13788
13789
13790
13791
13792
13793
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 13742

def get_deleted_sas_definitions_as_lazy_async(vault_base_url, , maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'storage_account_name is nil' if .nil?
  fail ArgumentError, "'storage_account_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !.nil? && .match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  path_template = 'deletedstorage/{storage-account-name}/sas'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'storage-account-name' => },
      query_params: {'maxresults' => maxresults},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::DeletedSasDefinitionListResult.mapper()
        result.body = self.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_deleted_sas_definitions_as_lazy_with_http_info(vault_base_url, storage_account_name, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists deleted SAS definitions for the specified vault and storage account.

The Get Deleted Sas Definitions operation returns the SAS definitions that have been deleted for a vault enabled for soft-delete. This operation requires the storage/listsas permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



13721
13722
13723
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 13721

def get_deleted_sas_definitions_as_lazy_with_http_info(vault_base_url, , maxresults:nil, custom_headers:nil)
  get_deleted_sas_definitions_as_lazy_async(vault_base_url, , maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_deleted_sas_definitions_async(vault_base_url, storage_account_name, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists deleted SAS definitions for the specified vault and storage account.

The Get Deleted Sas Definitions operation returns the SAS definitions that have been deleted for a vault enabled for soft-delete. This operation requires the storage/listsas permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9125

def get_deleted_sas_definitions_async(vault_base_url, , maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'storage_account_name is nil' if .nil?
  fail ArgumentError, "'storage_account_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !.nil? && .match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'deletedstorage/{storage-account-name}/sas'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'storage-account-name' => },
      query_params: {'maxresults' => maxresults,'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::DeletedSasDefinitionListResult.mapper()
        result.body = self.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_deleted_sas_definitions_next(next_page_link, custom_headers: nil) ⇒ DeletedSasDefinitionListResult

Lists deleted SAS definitions for the specified vault and storage account.

The Get Deleted Sas Definitions operation returns the SAS definitions that have been deleted for a vault enabled for soft-delete. This operation requires the storage/listsas permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (DeletedSasDefinitionListResult)

    operation results.



12164
12165
12166
12167
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12164

def get_deleted_sas_definitions_next(next_page_link, custom_headers:nil)
  response = get_deleted_sas_definitions_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_deleted_sas_definitions_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Lists deleted SAS definitions for the specified vault and storage account.

The Get Deleted Sas Definitions operation returns the SAS definitions that have been deleted for a vault enabled for soft-delete. This operation requires the storage/listsas permission.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
12241
12242
12243
12244
12245
12246
12247
12248
12249
12250
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12201

def get_deleted_sas_definitions_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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'] = accept_language unless accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::DeletedSasDefinitionListResult.mapper()
        result.body = self.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_deleted_sas_definitions_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists deleted SAS definitions for the specified vault and storage account.

The Get Deleted Sas Definitions operation returns the SAS definitions that have been deleted for a vault enabled for soft-delete. This operation requires the storage/listsas permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



12183
12184
12185
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12183

def get_deleted_sas_definitions_next_with_http_info(next_page_link, custom_headers:nil)
  get_deleted_sas_definitions_next_async(next_page_link, custom_headers:custom_headers).value!
end

#get_deleted_sas_definitions_with_http_info(vault_base_url, storage_account_name, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists deleted SAS definitions for the specified vault and storage account.

The Get Deleted Sas Definitions operation returns the SAS definitions that have been deleted for a vault enabled for soft-delete. This operation requires the storage/listsas permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



9104
9105
9106
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9104

def get_deleted_sas_definitions_with_http_info(vault_base_url, , maxresults:nil, custom_headers:nil)
  get_deleted_sas_definitions_async(vault_base_url, , maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_deleted_secret(vault_base_url, secret_name, custom_headers: nil) ⇒ DeletedSecretBundle

Gets the specified deleted secret.

The Get Deleted Secret operation returns the specified deleted secret along with its attributes. This operation requires the secrets/get permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

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

    A hash of custom headers that

Returns:

  • (DeletedSecretBundle)

    operation results.



7056
7057
7058
7059
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7056

def get_deleted_secret(vault_base_url, secret_name, custom_headers:nil)
  response = get_deleted_secret_async(vault_base_url, secret_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_deleted_secret_async(vault_base_url, secret_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the specified deleted secret.

The Get Deleted Secret operation returns the specified deleted secret along with its attributes. This operation requires the secrets/get permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7093

def get_deleted_secret_async(vault_base_url, secret_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'secret_name is nil' if secret_name.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'deletedsecrets/{secret-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'secret-name' => secret_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::DeletedSecretBundle.mapper()
        result.body = self.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_deleted_secret_with_http_info(vault_base_url, secret_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the specified deleted secret.

The Get Deleted Secret operation returns the specified deleted secret along with its attributes. This operation requires the secrets/get permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



7075
7076
7077
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7075

def get_deleted_secret_with_http_info(vault_base_url, secret_name, custom_headers:nil)
  get_deleted_secret_async(vault_base_url, secret_name, custom_headers:custom_headers).value!
end

#get_deleted_secrets(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ Array<DeletedSecretItem>

Lists deleted secrets for the specified vault.

The Get Deleted Secrets operation returns the secrets that have been deleted for a vault enabled for soft-delete. This operation requires the secrets/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (Array<DeletedSecretItem>)

    operation results.



6946
6947
6948
6949
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6946

def get_deleted_secrets(vault_base_url, maxresults:nil, custom_headers:nil)
  first_page = get_deleted_secrets_as_lazy(vault_base_url, maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_deleted_secrets_as_lazy(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ DeletedSecretListResult

Lists deleted secrets for the specified vault.

The Get Deleted Secrets operation returns the secrets that have been deleted for a vault enabled for soft-delete. This operation requires the secrets/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (DeletedSecretListResult)

    operation results.



13282
13283
13284
13285
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 13282

def get_deleted_secrets_as_lazy(vault_base_url, maxresults:nil, custom_headers:nil)
  first_page = get_deleted_secrets_as_lazy_as_lazy(vault_base_url, maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_deleted_secrets_as_lazy_async(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists deleted secrets for the specified vault.

The Get Deleted Secrets operation returns the secrets that have been deleted for a vault enabled for soft-delete. This operation requires the secrets/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
13338
13339
13340
13341
13342
13343
13344
13345
13346
13347
13348
13349
13350
13351
13352
13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 13323

def get_deleted_secrets_as_lazy_async(vault_base_url, maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  path_template = 'deletedsecrets'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'maxresults' => maxresults},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::DeletedSecretListResult.mapper()
        result.body = self.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_deleted_secrets_as_lazy_with_http_info(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists deleted secrets for the specified vault.

The Get Deleted Secrets operation returns the secrets that have been deleted for a vault enabled for soft-delete. This operation requires the secrets/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



13303
13304
13305
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 13303

def get_deleted_secrets_as_lazy_with_http_info(vault_base_url, maxresults:nil, custom_headers:nil)
  get_deleted_secrets_as_lazy_async(vault_base_url, maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_deleted_secrets_async(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists deleted secrets for the specified vault.

The Get Deleted Secrets operation returns the secrets that have been deleted for a vault enabled for soft-delete. This operation requires the secrets/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6987

def get_deleted_secrets_async(vault_base_url, maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'deletedsecrets'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'maxresults' => maxresults,'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::DeletedSecretListResult.mapper()
        result.body = self.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_deleted_secrets_next(next_page_link, custom_headers: nil) ⇒ DeletedSecretListResult

Lists deleted secrets for the specified vault.

The Get Deleted Secrets operation returns the secrets that have been deleted for a vault enabled for soft-delete. This operation requires the secrets/list permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (DeletedSecretListResult)

    operation results.



11774
11775
11776
11777
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11774

def get_deleted_secrets_next(next_page_link, custom_headers:nil)
  response = get_deleted_secrets_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_deleted_secrets_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Lists deleted secrets for the specified vault.

The Get Deleted Secrets operation returns the secrets that have been deleted for a vault enabled for soft-delete. This operation requires the secrets/list permission.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11811

def get_deleted_secrets_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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'] = accept_language unless accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::DeletedSecretListResult.mapper()
        result.body = self.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_deleted_secrets_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists deleted secrets for the specified vault.

The Get Deleted Secrets operation returns the secrets that have been deleted for a vault enabled for soft-delete. This operation requires the secrets/list permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



11793
11794
11795
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11793

def get_deleted_secrets_next_with_http_info(next_page_link, custom_headers:nil)
  get_deleted_secrets_next_async(next_page_link, custom_headers:custom_headers).value!
end

#get_deleted_secrets_with_http_info(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists deleted secrets for the specified vault.

The Get Deleted Secrets operation returns the secrets that have been deleted for a vault enabled for soft-delete. This operation requires the secrets/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



6967
6968
6969
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6967

def get_deleted_secrets_with_http_info(vault_base_url, maxresults:nil, custom_headers:nil)
  get_deleted_secrets_async(vault_base_url, maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_deleted_storage_account(vault_base_url, storage_account_name, custom_headers: nil) ⇒ DeletedStorageBundle

Gets the specified deleted storage account.

The Get Deleted Storage Account operation returns the specified deleted storage account along with its attributes. This operation requires the storage/get permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

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

    A hash of custom headers that

Returns:

  • (DeletedStorageBundle)

    operation results.



7813
7814
7815
7816
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7813

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

#get_deleted_storage_account_async(vault_base_url, storage_account_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the specified deleted storage account.

The Get Deleted Storage Account operation returns the specified deleted storage account along with its attributes. This operation requires the storage/get permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7852

def (vault_base_url, , custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'storage_account_name is nil' if .nil?
  fail ArgumentError, "'storage_account_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !.nil? && .match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'deletedstorage/{storage-account-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'storage-account-name' => },
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::DeletedStorageBundle.mapper()
        result.body = self.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_deleted_storage_account_with_http_info(vault_base_url, storage_account_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the specified deleted storage account.

The Get Deleted Storage Account operation returns the specified deleted storage account along with its attributes. This operation requires the storage/get permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



7833
7834
7835
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7833

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

#get_deleted_storage_accounts(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ Array<DeletedStorageAccountItem>

Lists deleted storage accounts for the specified vault.

The Get Deleted Storage Accounts operation returns the storage accounts that have been deleted for a vault enabled for soft-delete. This operation requires the storage/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (Array<DeletedStorageAccountItem>)

    operation results.



7702
7703
7704
7705
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7702

def get_deleted_storage_accounts(vault_base_url, maxresults:nil, custom_headers:nil)
  first_page = get_deleted_storage_accounts_as_lazy(vault_base_url, maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_deleted_storage_accounts_as_lazy(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ DeletedStorageListResult

Lists deleted storage accounts for the specified vault.

The Get Deleted Storage Accounts operation returns the storage accounts that have been deleted for a vault enabled for soft-delete. This operation requires the storage/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (DeletedStorageListResult)

    operation results.



13487
13488
13489
13490
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 13487

def get_deleted_storage_accounts_as_lazy(vault_base_url, maxresults:nil, custom_headers:nil)
  first_page = get_deleted_storage_accounts_as_lazy_as_lazy(vault_base_url, maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_deleted_storage_accounts_as_lazy_async(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists deleted storage accounts for the specified vault.

The Get Deleted Storage Accounts operation returns the storage accounts that have been deleted for a vault enabled for soft-delete. This operation requires the storage/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
13555
13556
13557
13558
13559
13560
13561
13562
13563
13564
13565
13566
13567
13568
13569
13570
13571
13572
13573
13574
13575
13576
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 13528

def get_deleted_storage_accounts_as_lazy_async(vault_base_url, maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  path_template = 'deletedstorage'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'maxresults' => maxresults},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::DeletedStorageListResult.mapper()
        result.body = self.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_deleted_storage_accounts_as_lazy_with_http_info(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists deleted storage accounts for the specified vault.

The Get Deleted Storage Accounts operation returns the storage accounts that have been deleted for a vault enabled for soft-delete. This operation requires the storage/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



13508
13509
13510
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 13508

def get_deleted_storage_accounts_as_lazy_with_http_info(vault_base_url, maxresults:nil, custom_headers:nil)
  get_deleted_storage_accounts_as_lazy_async(vault_base_url, maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_deleted_storage_accounts_async(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists deleted storage accounts for the specified vault.

The Get Deleted Storage Accounts operation returns the storage accounts that have been deleted for a vault enabled for soft-delete. This operation requires the storage/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7743

def get_deleted_storage_accounts_async(vault_base_url, maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'deletedstorage'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'maxresults' => maxresults,'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::DeletedStorageListResult.mapper()
        result.body = self.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_deleted_storage_accounts_next(next_page_link, custom_headers: nil) ⇒ DeletedStorageListResult

Lists deleted storage accounts for the specified vault.

The Get Deleted Storage Accounts operation returns the storage accounts that have been deleted for a vault enabled for soft-delete. This operation requires the storage/list permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (DeletedStorageListResult)

    operation results.



11969
11970
11971
11972
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11969

def get_deleted_storage_accounts_next(next_page_link, custom_headers:nil)
  response = get_deleted_storage_accounts_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_deleted_storage_accounts_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Lists deleted storage accounts for the specified vault.

The Get Deleted Storage Accounts operation returns the storage accounts that have been deleted for a vault enabled for soft-delete. This operation requires the storage/list permission.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



12006
12007
12008
12009
12010
12011
12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12006

def get_deleted_storage_accounts_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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'] = accept_language unless accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::DeletedStorageListResult.mapper()
        result.body = self.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_deleted_storage_accounts_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists deleted storage accounts for the specified vault.

The Get Deleted Storage Accounts operation returns the storage accounts that have been deleted for a vault enabled for soft-delete. This operation requires the storage/list permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



11988
11989
11990
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11988

def get_deleted_storage_accounts_next_with_http_info(next_page_link, custom_headers:nil)
  get_deleted_storage_accounts_next_async(next_page_link, custom_headers:custom_headers).value!
end

#get_deleted_storage_accounts_with_http_info(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists deleted storage accounts for the specified vault.

The Get Deleted Storage Accounts operation returns the storage accounts that have been deleted for a vault enabled for soft-delete. This operation requires the storage/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



7723
7724
7725
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7723

def get_deleted_storage_accounts_with_http_info(vault_base_url, maxresults:nil, custom_headers:nil)
  get_deleted_storage_accounts_async(vault_base_url, maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_key(vault_base_url, key_name, key_version, custom_headers: nil) ⇒ KeyBundle

Gets the public part of a stored key.

The get key operation is applicable to all key types. If the requested key is symmetric, then no key material is released in the response. This operation requires the keys/get permission.

myvault.vault.azure.net. version of a key. This URI fragment is optional. If not specified, the latest version of the key is returned. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key to get.

  • key_version (String)

    Adding the version parameter retrieves a specific

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

    A hash of custom headers that

Returns:

  • (KeyBundle)

    operation results.



3986
3987
3988
3989
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 3986

def get_key(vault_base_url, key_name, key_version, custom_headers:nil)
  response = get_key_async(vault_base_url, key_name, key_version, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_key_async(vault_base_url, key_name, key_version, custom_headers: nil) ⇒ Concurrent::Promise

Gets the public part of a stored key.

The get key operation is applicable to all key types. If the requested key is symmetric, then no key material is released in the response. This operation requires the keys/get permission.

myvault.vault.azure.net. version of a key. This URI fragment is optional. If not specified, the latest version of the key is returned. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key to get.

  • key_version (String)

    Adding the version parameter retrieves a specific

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 4031

def get_key_async(vault_base_url, key_name, key_version, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, 'key_version is nil' if key_version.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'keys/{key-name}/{key-version}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'key-name' => key_name,'key-version' => key_version},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::KeyBundle.mapper()
        result.body = self.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_key_versions(vault_base_url, key_name, maxresults: nil, custom_headers: nil) ⇒ Array<KeyItem>

Retrieves a list of individual key versions with the same key name.

The full key identifier, attributes, and tags are provided in the response. This operation requires the keys/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (Array<KeyItem>)

    operation results.



4103
4104
4105
4106
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 4103

def get_key_versions(vault_base_url, key_name, maxresults:nil, custom_headers:nil)
  first_page = get_key_versions_as_lazy(vault_base_url, key_name, maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_key_versions_as_lazy(vault_base_url, key_name, maxresults: nil, custom_headers: nil) ⇒ KeyListResult

Retrieves a list of individual key versions with the same key name.

The full key identifier, attributes, and tags are provided in the response. This operation requires the keys/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (KeyListResult)

    operation results.



12722
12723
12724
12725
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12722

def get_key_versions_as_lazy(vault_base_url, key_name, maxresults:nil, custom_headers:nil)
  first_page = get_key_versions_as_lazy_as_lazy(vault_base_url, key_name, maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_key_versions_as_lazy_async(vault_base_url, key_name, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

Retrieves a list of individual key versions with the same key name.

The full key identifier, attributes, and tags are provided in the response. This operation requires the keys/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



12763
12764
12765
12766
12767
12768
12769
12770
12771
12772
12773
12774
12775
12776
12777
12778
12779
12780
12781
12782
12783
12784
12785
12786
12787
12788
12789
12790
12791
12792
12793
12794
12795
12796
12797
12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
12811
12812
12813
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12763

def get_key_versions_as_lazy_async(vault_base_url, key_name, maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  path_template = 'keys/{key-name}/versions'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'key-name' => key_name},
      query_params: {'maxresults' => maxresults},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::KeyListResult.mapper()
        result.body = self.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_key_versions_as_lazy_with_http_info(vault_base_url, key_name, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves a list of individual key versions with the same key name.

The full key identifier, attributes, and tags are provided in the response. This operation requires the keys/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



12743
12744
12745
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12743

def get_key_versions_as_lazy_with_http_info(vault_base_url, key_name, maxresults:nil, custom_headers:nil)
  get_key_versions_as_lazy_async(vault_base_url, key_name, maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_key_versions_async(vault_base_url, key_name, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

Retrieves a list of individual key versions with the same key name.

The full key identifier, attributes, and tags are provided in the response. This operation requires the keys/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 4144

def get_key_versions_async(vault_base_url, key_name, maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'keys/{key-name}/versions'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'key-name' => key_name},
      query_params: {'maxresults' => maxresults,'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::KeyListResult.mapper()
        result.body = self.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_key_versions_next(next_page_link, custom_headers: nil) ⇒ KeyListResult

Retrieves a list of individual key versions with the same key name.

The full key identifier, attributes, and tags are provided in the response. This operation requires the keys/list permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (KeyListResult)

    operation results.



11248
11249
11250
11251
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11248

def get_key_versions_next(next_page_link, custom_headers:nil)
  response = get_key_versions_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_key_versions_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Retrieves a list of individual key versions with the same key name.

The full key identifier, attributes, and tags are provided in the response. This operation requires the keys/list permission.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11283

def get_key_versions_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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'] = accept_language unless accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::KeyListResult.mapper()
        result.body = self.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_key_versions_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves a list of individual key versions with the same key name.

The full key identifier, attributes, and tags are provided in the response. This operation requires the keys/list permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



11266
11267
11268
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11266

def get_key_versions_next_with_http_info(next_page_link, custom_headers:nil)
  get_key_versions_next_async(next_page_link, custom_headers:custom_headers).value!
end

#get_key_versions_with_http_info(vault_base_url, key_name, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves a list of individual key versions with the same key name.

The full key identifier, attributes, and tags are provided in the response. This operation requires the keys/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



4124
4125
4126
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 4124

def get_key_versions_with_http_info(vault_base_url, key_name, maxresults:nil, custom_headers:nil)
  get_key_versions_async(vault_base_url, key_name, maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_key_with_http_info(vault_base_url, key_name, key_version, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the public part of a stored key.

The get key operation is applicable to all key types. If the requested key is symmetric, then no key material is released in the response. This operation requires the keys/get permission.

myvault.vault.azure.net. version of a key. This URI fragment is optional. If not specified, the latest version of the key is returned. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key to get.

  • key_version (String)

    Adding the version parameter retrieves a specific

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



4009
4010
4011
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 4009

def get_key_with_http_info(vault_base_url, key_name, key_version, custom_headers:nil)
  get_key_async(vault_base_url, key_name, key_version, custom_headers:custom_headers).value!
end

#get_keys(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ Array<KeyItem>

List keys in the specified vault.

Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and tags are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (Array<KeyItem>)

    operation results.



4219
4220
4221
4222
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 4219

def get_keys(vault_base_url, maxresults:nil, custom_headers:nil)
  first_page = get_keys_as_lazy(vault_base_url, maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_keys_as_lazy(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ KeyListResult

List keys in the specified vault.

Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and tags are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (KeyListResult)

    operation results.



12833
12834
12835
12836
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12833

def get_keys_as_lazy(vault_base_url, maxresults:nil, custom_headers:nil)
  first_page = get_keys_as_lazy_as_lazy(vault_base_url, maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_keys_as_lazy_async(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

List keys in the specified vault.

Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and tags are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



12878
12879
12880
12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
12924
12925
12926
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12878

def get_keys_as_lazy_async(vault_base_url, maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  path_template = 'keys'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'maxresults' => maxresults},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::KeyListResult.mapper()
        result.body = self.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_keys_as_lazy_with_http_info(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List keys in the specified vault.

Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and tags are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



12856
12857
12858
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12856

def get_keys_as_lazy_with_http_info(vault_base_url, maxresults:nil, custom_headers:nil)
  get_keys_as_lazy_async(vault_base_url, maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_keys_async(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

List keys in the specified vault.

Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and tags are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 4264

def get_keys_async(vault_base_url, maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'keys'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'maxresults' => maxresults,'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::KeyListResult.mapper()
        result.body = self.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_keys_next(next_page_link, custom_headers: nil) ⇒ KeyListResult

List keys in the specified vault.

Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and tags are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (KeyListResult)

    operation results.



11350
11351
11352
11353
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11350

def get_keys_next(next_page_link, custom_headers:nil)
  response = get_keys_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_keys_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

List keys in the specified vault.

Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and tags are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11391

def get_keys_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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'] = accept_language unless accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::KeyListResult.mapper()
        result.body = self.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_keys_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List keys in the specified vault.

Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and tags are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



11371
11372
11373
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11371

def get_keys_next_with_http_info(next_page_link, custom_headers:nil)
  get_keys_next_async(next_page_link, custom_headers:custom_headers).value!
end

#get_keys_with_http_info(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List keys in the specified vault.

Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and tags are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



4242
4243
4244
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 4242

def get_keys_with_http_info(vault_base_url, maxresults:nil, custom_headers:nil)
  get_keys_async(vault_base_url, maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_sas_definition(vault_base_url, storage_account_name, sas_definition_name, custom_headers: nil) ⇒ SasDefinitionBundle

Gets information about a SAS definition for the specified storage account. This operation requires the storage/getsas permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • sas_definition_name (String)

    The name of the SAS definition.

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

    A hash of custom headers that

Returns:

  • (SasDefinitionBundle)

    operation results.



9532
9533
9534
9535
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9532

def get_sas_definition(vault_base_url, , sas_definition_name, custom_headers:nil)
  response = get_sas_definition_async(vault_base_url, , sas_definition_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_sas_definition_async(vault_base_url, storage_account_name, sas_definition_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets information about a SAS definition for the specified storage account. This operation requires the storage/getsas permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • sas_definition_name (String)

    The name of the SAS definition.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9567

def get_sas_definition_async(vault_base_url, , sas_definition_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'storage_account_name is nil' if .nil?
  fail ArgumentError, "'storage_account_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !.nil? && .match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, 'sas_definition_name is nil' if sas_definition_name.nil?
  fail ArgumentError, "'sas_definition_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !sas_definition_name.nil? && sas_definition_name.match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'storage/{storage-account-name}/sas/{sas-definition-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'storage-account-name' => ,'sas-definition-name' => sas_definition_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::SasDefinitionBundle.mapper()
        result.body = self.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_sas_definition_with_http_info(vault_base_url, storage_account_name, sas_definition_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets information about a SAS definition for the specified storage account. This operation requires the storage/getsas permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • sas_definition_name (String)

    The name of the SAS definition.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



9550
9551
9552
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9550

def get_sas_definition_with_http_info(vault_base_url, , sas_definition_name, custom_headers:nil)
  get_sas_definition_async(vault_base_url, , sas_definition_name, custom_headers:custom_headers).value!
end

#get_sas_definitions(vault_base_url, storage_account_name, maxresults: nil, custom_headers: nil) ⇒ Array<SasDefinitionItem>

List storage SAS definitions for the given storage account. This operation requires the storage/listsas permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (Array<SasDefinitionItem>)

    operation results.



8970
8971
8972
8973
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8970

def get_sas_definitions(vault_base_url, , maxresults:nil, custom_headers:nil)
  first_page = get_sas_definitions_as_lazy(vault_base_url, , maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_sas_definitions_as_lazy(vault_base_url, storage_account_name, maxresults: nil, custom_headers: nil) ⇒ SasDefinitionListResult

List storage SAS definitions for the given storage account. This operation requires the storage/listsas permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (SasDefinitionListResult)

    operation results.



13592
13593
13594
13595
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 13592

def get_sas_definitions_as_lazy(vault_base_url, , maxresults:nil, custom_headers:nil)
  first_page = get_sas_definitions_as_lazy_as_lazy(vault_base_url, , maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_sas_definitions_as_lazy_async(vault_base_url, storage_account_name, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

List storage SAS definitions for the given storage account. This operation requires the storage/listsas permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



13629
13630
13631
13632
13633
13634
13635
13636
13637
13638
13639
13640
13641
13642
13643
13644
13645
13646
13647
13648
13649
13650
13651
13652
13653
13654
13655
13656
13657
13658
13659
13660
13661
13662
13663
13664
13665
13666
13667
13668
13669
13670
13671
13672
13673
13674
13675
13676
13677
13678
13679
13680
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 13629

def get_sas_definitions_as_lazy_async(vault_base_url, , maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'storage_account_name is nil' if .nil?
  fail ArgumentError, "'storage_account_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !.nil? && .match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  path_template = 'storage/{storage-account-name}/sas'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'storage-account-name' => },
      query_params: {'maxresults' => maxresults},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::SasDefinitionListResult.mapper()
        result.body = self.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_sas_definitions_as_lazy_with_http_info(vault_base_url, storage_account_name, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List storage SAS definitions for the given storage account. This operation requires the storage/listsas permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



13611
13612
13613
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 13611

def get_sas_definitions_as_lazy_with_http_info(vault_base_url, , maxresults:nil, custom_headers:nil)
  get_sas_definitions_as_lazy_async(vault_base_url, , maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_sas_definitions_async(vault_base_url, storage_account_name, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

List storage SAS definitions for the given storage account. This operation requires the storage/listsas permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9007

def get_sas_definitions_async(vault_base_url, , maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'storage_account_name is nil' if .nil?
  fail ArgumentError, "'storage_account_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !.nil? && .match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'storage/{storage-account-name}/sas'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'storage-account-name' => },
      query_params: {'maxresults' => maxresults,'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::SasDefinitionListResult.mapper()
        result.body = self.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_sas_definitions_next(next_page_link, custom_headers: nil) ⇒ SasDefinitionListResult

List storage SAS definitions for the given storage account. This operation requires the storage/listsas permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (SasDefinitionListResult)

    operation results.



12068
12069
12070
12071
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12068

def get_sas_definitions_next(next_page_link, custom_headers:nil)
  response = get_sas_definitions_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_sas_definitions_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

List storage SAS definitions for the given storage account. This operation requires the storage/listsas permission.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12099

def get_sas_definitions_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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'] = accept_language unless accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::SasDefinitionListResult.mapper()
        result.body = self.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_sas_definitions_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List storage SAS definitions for the given storage account. This operation requires the storage/listsas permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



12084
12085
12086
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 12084

def get_sas_definitions_next_with_http_info(next_page_link, custom_headers:nil)
  get_sas_definitions_next_async(next_page_link, custom_headers:custom_headers).value!
end

#get_sas_definitions_with_http_info(vault_base_url, storage_account_name, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List storage SAS definitions for the given storage account. This operation requires the storage/listsas permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



8989
8990
8991
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8989

def get_sas_definitions_with_http_info(vault_base_url, , maxresults:nil, custom_headers:nil)
  get_sas_definitions_async(vault_base_url, , maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_secret(vault_base_url, secret_name, secret_version, custom_headers: nil) ⇒ SecretBundle

Get a specified secret from a given key vault.

The GET operation is applicable to any secret stored in Azure Key Vault. This operation requires the secrets/get permission.

myvault.vault.azure.net. is optional. If not specified, the latest version of the secret is returned. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

  • secret_version (String)

    The version of the secret. This URI fragment

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

    A hash of custom headers that

Returns:

  • (SecretBundle)

    operation results.



6601
6602
6603
6604
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6601

def get_secret(vault_base_url, secret_name, secret_version, custom_headers:nil)
  response = get_secret_async(vault_base_url, secret_name, secret_version, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_secret_async(vault_base_url, secret_name, secret_version, custom_headers: nil) ⇒ Concurrent::Promise

Get a specified secret from a given key vault.

The GET operation is applicable to any secret stored in Azure Key Vault. This operation requires the secrets/get permission.

myvault.vault.azure.net. is optional. If not specified, the latest version of the secret is returned. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

  • secret_version (String)

    The version of the secret. This URI fragment

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6642

def get_secret_async(vault_base_url, secret_name, secret_version, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'secret_name is nil' if secret_name.nil?
  fail ArgumentError, 'secret_version is nil' if secret_version.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'secrets/{secret-name}/{secret-version}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'secret-name' => secret_name,'secret-version' => secret_version},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::SecretBundle.mapper()
        result.body = self.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_secret_versions(vault_base_url, secret_name, maxresults: nil, custom_headers: nil) ⇒ Array<SecretItem>

List all versions of the specified secret.

The full secret identifier and attributes are provided in the response. No values are returned for the secrets. This operations requires the secrets/list permission.

myvault.vault.azure.net. not specified, the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (Array<SecretItem>)

    operation results.



6830
6831
6832
6833
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6830

def get_secret_versions(vault_base_url, secret_name, maxresults:nil, custom_headers:nil)
  first_page = get_secret_versions_as_lazy(vault_base_url, secret_name, maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_secret_versions_as_lazy(vault_base_url, secret_name, maxresults: nil, custom_headers: nil) ⇒ SecretListResult

List all versions of the specified secret.

The full secret identifier and attributes are provided in the response. No values are returned for the secrets. This operations requires the secrets/list permission.

myvault.vault.azure.net. not specified, the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (SecretListResult)

    operation results.



13171
13172
13173
13174
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 13171

def get_secret_versions_as_lazy(vault_base_url, secret_name, maxresults:nil, custom_headers:nil)
  first_page = get_secret_versions_as_lazy_as_lazy(vault_base_url, secret_name, maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_secret_versions_as_lazy_async(vault_base_url, secret_name, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

List all versions of the specified secret.

The full secret identifier and attributes are provided in the response. No values are returned for the secrets. This operations requires the secrets/list permission.

myvault.vault.azure.net. not specified, the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



13214
13215
13216
13217
13218
13219
13220
13221
13222
13223
13224
13225
13226
13227
13228
13229
13230
13231
13232
13233
13234
13235
13236
13237
13238
13239
13240
13241
13242
13243
13244
13245
13246
13247
13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
13261
13262
13263
13264
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 13214

def get_secret_versions_as_lazy_async(vault_base_url, secret_name, maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'secret_name is nil' if secret_name.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  path_template = 'secrets/{secret-name}/versions'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'secret-name' => secret_name},
      query_params: {'maxresults' => maxresults},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::SecretListResult.mapper()
        result.body = self.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_secret_versions_as_lazy_with_http_info(vault_base_url, secret_name, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List all versions of the specified secret.

The full secret identifier and attributes are provided in the response. No values are returned for the secrets. This operations requires the secrets/list permission.

myvault.vault.azure.net. not specified, the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



13193
13194
13195
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 13193

def get_secret_versions_as_lazy_with_http_info(vault_base_url, secret_name, maxresults:nil, custom_headers:nil)
  get_secret_versions_as_lazy_async(vault_base_url, secret_name, maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_secret_versions_async(vault_base_url, secret_name, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

List all versions of the specified secret.

The full secret identifier and attributes are provided in the response. No values are returned for the secrets. This operations requires the secrets/list permission.

myvault.vault.azure.net. not specified, the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6873

def get_secret_versions_async(vault_base_url, secret_name, maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'secret_name is nil' if secret_name.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'secrets/{secret-name}/versions'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'secret-name' => secret_name},
      query_params: {'maxresults' => maxresults,'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::SecretListResult.mapper()
        result.body = self.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_secret_versions_next(next_page_link, custom_headers: nil) ⇒ SecretListResult

List all versions of the specified secret.

The full secret identifier and attributes are provided in the response. No values are returned for the secrets. This operations requires the secrets/list permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (SecretListResult)

    operation results.



11672
11673
11674
11675
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11672

def get_secret_versions_next(next_page_link, custom_headers:nil)
  response = get_secret_versions_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_secret_versions_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

List all versions of the specified secret.

The full secret identifier and attributes are provided in the response. No values are returned for the secrets. This operations requires the secrets/list permission.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11709

def get_secret_versions_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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'] = accept_language unless accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::SecretListResult.mapper()
        result.body = self.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_secret_versions_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List all versions of the specified secret.

The full secret identifier and attributes are provided in the response. No values are returned for the secrets. This operations requires the secrets/list permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



11691
11692
11693
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11691

def get_secret_versions_next_with_http_info(next_page_link, custom_headers:nil)
  get_secret_versions_next_async(next_page_link, custom_headers:custom_headers).value!
end

#get_secret_versions_with_http_info(vault_base_url, secret_name, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List all versions of the specified secret.

The full secret identifier and attributes are provided in the response. No values are returned for the secrets. This operations requires the secrets/list permission.

myvault.vault.azure.net. not specified, the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



6852
6853
6854
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6852

def get_secret_versions_with_http_info(vault_base_url, secret_name, maxresults:nil, custom_headers:nil)
  get_secret_versions_async(vault_base_url, secret_name, maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_secret_with_http_info(vault_base_url, secret_name, secret_version, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get a specified secret from a given key vault.

The GET operation is applicable to any secret stored in Azure Key Vault. This operation requires the secrets/get permission.

myvault.vault.azure.net. is optional. If not specified, the latest version of the secret is returned. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

  • secret_version (String)

    The version of the secret. This URI fragment

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



6622
6623
6624
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6622

def get_secret_with_http_info(vault_base_url, secret_name, secret_version, custom_headers:nil)
  get_secret_async(vault_base_url, secret_name, secret_version, custom_headers:custom_headers).value!
end

#get_secrets(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ Array<SecretItem>

List secrets in a specified key vault.

The Get Secrets operation is applicable to the entire vault. However, only the base secret identifier and its attributes are provided in the response. Individual secret versions are not listed in the response. This operation requires the secrets/list permission.

myvault.vault.azure.net. not specified, the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (Array<SecretItem>)

    operation results.



6715
6716
6717
6718
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6715

def get_secrets(vault_base_url, maxresults:nil, custom_headers:nil)
  first_page = get_secrets_as_lazy(vault_base_url, maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_secrets_as_lazy(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ SecretListResult

List secrets in a specified key vault.

The Get Secrets operation is applicable to the entire vault. However, only the base secret identifier and its attributes are provided in the response. Individual secret versions are not listed in the response. This operation requires the secrets/list permission.

myvault.vault.azure.net. not specified, the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (SecretListResult)

    operation results.



13061
13062
13063
13064
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 13061

def get_secrets_as_lazy(vault_base_url, maxresults:nil, custom_headers:nil)
  first_page = get_secrets_as_lazy_as_lazy(vault_base_url, maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_secrets_as_lazy_async(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

List secrets in a specified key vault.

The Get Secrets operation is applicable to the entire vault. However, only the base secret identifier and its attributes are provided in the response. Individual secret versions are not listed in the response. This operation requires the secrets/list permission.

myvault.vault.azure.net. not specified, the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



13104
13105
13106
13107
13108
13109
13110
13111
13112
13113
13114
13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
13151
13152
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 13104

def get_secrets_as_lazy_async(vault_base_url, maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  path_template = 'secrets'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'maxresults' => maxresults},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::SecretListResult.mapper()
        result.body = self.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_secrets_as_lazy_with_http_info(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List secrets in a specified key vault.

The Get Secrets operation is applicable to the entire vault. However, only the base secret identifier and its attributes are provided in the response. Individual secret versions are not listed in the response. This operation requires the secrets/list permission.

myvault.vault.azure.net. not specified, the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



13083
13084
13085
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 13083

def get_secrets_as_lazy_with_http_info(vault_base_url, maxresults:nil, custom_headers:nil)
  get_secrets_as_lazy_async(vault_base_url, maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_secrets_async(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

List secrets in a specified key vault.

The Get Secrets operation is applicable to the entire vault. However, only the base secret identifier and its attributes are provided in the response. Individual secret versions are not listed in the response. This operation requires the secrets/list permission.

myvault.vault.azure.net. not specified, the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6758

def get_secrets_async(vault_base_url, maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'secrets'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'maxresults' => maxresults,'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::SecretListResult.mapper()
        result.body = self.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_secrets_next(next_page_link, custom_headers: nil) ⇒ SecretListResult

List secrets in a specified key vault.

The Get Secrets operation is applicable to the entire vault. However, only the base secret identifier and its attributes are provided in the response. Individual secret versions are not listed in the response. This operation requires the secrets/list permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (SecretListResult)

    operation results.



11568
11569
11570
11571
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11568

def get_secrets_next(next_page_link, custom_headers:nil)
  response = get_secrets_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_secrets_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

List secrets in a specified key vault.

The Get Secrets operation is applicable to the entire vault. However, only the base secret identifier and its attributes are provided in the response. Individual secret versions are not listed in the response. This operation requires the secrets/list permission.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11607

def get_secrets_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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'] = accept_language unless accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::SecretListResult.mapper()
        result.body = self.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_secrets_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List secrets in a specified key vault.

The Get Secrets operation is applicable to the entire vault. However, only the base secret identifier and its attributes are provided in the response. Individual secret versions are not listed in the response. This operation requires the secrets/list permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



11588
11589
11590
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11588

def get_secrets_next_with_http_info(next_page_link, custom_headers:nil)
  get_secrets_next_async(next_page_link, custom_headers:custom_headers).value!
end

#get_secrets_with_http_info(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List secrets in a specified key vault.

The Get Secrets operation is applicable to the entire vault. However, only the base secret identifier and its attributes are provided in the response. Individual secret versions are not listed in the response. This operation requires the secrets/list permission.

myvault.vault.azure.net. not specified, the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



6737
6738
6739
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6737

def get_secrets_with_http_info(vault_base_url, maxresults:nil, custom_headers:nil)
  get_secrets_async(vault_base_url, maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_storage_account(vault_base_url, storage_account_name, custom_headers: nil) ⇒ StorageBundle

Gets information about a specified storage account. This operation requires the storage/get permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

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

    A hash of custom headers that

Returns:

  • (StorageBundle)

    operation results.



8458
8459
8460
8461
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8458

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

#get_storage_account_async(vault_base_url, storage_account_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets information about a specified storage account. This operation requires the storage/get permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8491

def (vault_base_url, , custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'storage_account_name is nil' if .nil?
  fail ArgumentError, "'storage_account_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !.nil? && .match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'storage/{storage-account-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'storage-account-name' => },
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::StorageBundle.mapper()
        result.body = self.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_storage_account_with_http_info(vault_base_url, storage_account_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets information about a specified storage account. This operation requires the storage/get permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



8475
8476
8477
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8475

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

#get_storage_accounts(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ Array<StorageAccountItem>

List storage accounts managed by the specified key vault. This operation requires the storage/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (Array<StorageAccountItem>)

    operation results.



7596
7597
7598
7599
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7596

def get_storage_accounts(vault_base_url, maxresults:nil, custom_headers:nil)
  first_page = get_storage_accounts_as_lazy(vault_base_url, maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_storage_accounts_as_lazy(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ StorageListResult

List storage accounts managed by the specified key vault. This operation requires the storage/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (StorageListResult)

    operation results.



13386
13387
13388
13389
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 13386

def get_storage_accounts_as_lazy(vault_base_url, maxresults:nil, custom_headers:nil)
  first_page = get_storage_accounts_as_lazy_as_lazy(vault_base_url, maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#get_storage_accounts_as_lazy_async(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

List storage accounts managed by the specified key vault. This operation requires the storage/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455
13456
13457
13458
13459
13460
13461
13462
13463
13464
13465
13466
13467
13468
13469
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 13421

def get_storage_accounts_as_lazy_async(vault_base_url, maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  path_template = 'storage'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'maxresults' => maxresults},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::StorageListResult.mapper()
        result.body = self.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_storage_accounts_as_lazy_with_http_info(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List storage accounts managed by the specified key vault. This operation requires the storage/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



13404
13405
13406
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 13404

def get_storage_accounts_as_lazy_with_http_info(vault_base_url, maxresults:nil, custom_headers:nil)
  get_storage_accounts_as_lazy_async(vault_base_url, maxresults:maxresults, custom_headers:custom_headers).value!
end

#get_storage_accounts_async(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

List storage accounts managed by the specified key vault. This operation requires the storage/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7631

def get_storage_accounts_async(vault_base_url, maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMaximum': '25'" if !maxresults.nil? && maxresults > 25
  fail ArgumentError, "'maxresults' should satisfy the constraint - 'InclusiveMinimum': '1'" if !maxresults.nil? && maxresults < 1
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'storage'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'maxresults' => maxresults,'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::StorageListResult.mapper()
        result.body = self.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_storage_accounts_next(next_page_link, custom_headers: nil) ⇒ StorageListResult

List storage accounts managed by the specified key vault. This operation requires the storage/list permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (StorageListResult)

    operation results.



11873
11874
11875
11876
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11873

def get_storage_accounts_next(next_page_link, custom_headers:nil)
  response = get_storage_accounts_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_storage_accounts_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

List storage accounts managed by the specified key vault. This operation requires the storage/list permission.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11904

def get_storage_accounts_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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'] = accept_language unless accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::StorageListResult.mapper()
        result.body = self.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_storage_accounts_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List storage accounts managed by the specified key vault. This operation requires the storage/list permission.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



11889
11890
11891
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 11889

def get_storage_accounts_next_with_http_info(next_page_link, custom_headers:nil)
  get_storage_accounts_next_async(next_page_link, custom_headers:custom_headers).value!
end

#get_storage_accounts_with_http_info(vault_base_url, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List storage accounts managed by the specified key vault. This operation requires the storage/list permission.

myvault.vault.azure.net. not specified the service will return up to 25 results. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • maxresults (Integer) (defaults to: nil)

    Maximum number of results to return in a page. If

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



7614
7615
7616
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7614

def get_storage_accounts_with_http_info(vault_base_url, maxresults:nil, custom_headers:nil)
  get_storage_accounts_async(vault_base_url, maxresults:maxresults, custom_headers:custom_headers).value!
end

#import_certificate(vault_base_url, certificate_name, base64encoded_certificate, password: nil, certificate_policy: nil, certificate_attributes: nil, tags: nil, custom_headers: nil) ⇒ CertificateBundle

Imports a certificate into a specified key vault.

Imports an existing valid certificate, containing a private key, into Azure Key Vault. The certificate to be imported can be in either PFX or PEM format. If the certificate is in PEM format the PEM file must contain the key as well as x509 certificates. This operation requires the certificates/import permission.

myvault.vault.azure.net. the certificate object to import. This certificate needs to contain the private key. encrypted, the password used for encryption. certificate. certificate (optional). form of key-value pairs. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

  • base64encoded_certificate (String)

    Base64 encoded representation of

  • password (String) (defaults to: nil)

    If the private key in base64EncodedCertificate is

  • certificate_policy (CertificatePolicy) (defaults to: nil)

    The management policy for the

  • certificate_attributes (CertificateAttributes) (defaults to: nil)

    The attributes of the

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

    Application specific metadata in the

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

    A hash of custom headers that

Returns:

  • (CertificateBundle)

    operation results.



1447
1448
1449
1450
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1447

def import_certificate(vault_base_url, certificate_name, base64encoded_certificate, password:nil, certificate_policy:nil, certificate_attributes:nil, tags:nil, custom_headers:nil)
  response = import_certificate_async(vault_base_url, certificate_name, base64encoded_certificate, password:password, certificate_policy:certificate_policy, certificate_attributes:certificate_attributes, tags:tags, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#import_certificate_async(vault_base_url, certificate_name, base64encoded_certificate, password: nil, certificate_policy: nil, certificate_attributes: nil, tags: nil, custom_headers: nil) ⇒ Concurrent::Promise

Imports a certificate into a specified key vault.

Imports an existing valid certificate, containing a private key, into Azure Key Vault. The certificate to be imported can be in either PFX or PEM format. If the certificate is in PEM format the PEM file must contain the key as well as x509 certificates. This operation requires the certificates/import permission.

myvault.vault.azure.net. the certificate object to import. This certificate needs to contain the private key. encrypted, the password used for encryption. certificate. certificate (optional). form of key-value pairs. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

  • base64encoded_certificate (String)

    Base64 encoded representation of

  • password (String) (defaults to: nil)

    If the private key in base64EncodedCertificate is

  • certificate_policy (CertificatePolicy) (defaults to: nil)

    The management policy for the

  • certificate_attributes (CertificateAttributes) (defaults to: nil)

    The attributes of the

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

    Application specific metadata in the

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1512

def import_certificate_async(vault_base_url, certificate_name, base64encoded_certificate, password:nil, certificate_policy:nil, certificate_attributes:nil, tags:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'certificate_name is nil' if certificate_name.nil?
  fail ArgumentError, "'certificate_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z-]+$'" if !certificate_name.nil? && certificate_name.match(Regexp.new('^^[0-9a-zA-Z-]+$$')).nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'base64encoded_certificate is nil' if base64encoded_certificate.nil?

  parameters = CertificateImportParameters.new
  unless base64encoded_certificate.nil? && password.nil? && certificate_policy.nil? && certificate_attributes.nil? && tags.nil?
    parameters.base64EncodedCertificate = base64encoded_certificate
    parameters.password = password
    parameters.CertificatePolicy = certificate_policy
    parameters.CertificateAttributes = certificate_attributes
    parameters.tags = tags
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::CertificateImportParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'certificates/{certificate-name}/import'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'certificate-name' => certificate_name},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::CertificateBundle.mapper()
        result.body = self.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

#import_certificate_with_http_info(vault_base_url, certificate_name, base64encoded_certificate, password: nil, certificate_policy: nil, certificate_attributes: nil, tags: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Imports a certificate into a specified key vault.

Imports an existing valid certificate, containing a private key, into Azure Key Vault. The certificate to be imported can be in either PFX or PEM format. If the certificate is in PEM format the PEM file must contain the key as well as x509 certificates. This operation requires the certificates/import permission.

myvault.vault.azure.net. the certificate object to import. This certificate needs to contain the private key. encrypted, the password used for encryption. certificate. certificate (optional). form of key-value pairs. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

  • base64encoded_certificate (String)

    Base64 encoded representation of

  • password (String) (defaults to: nil)

    If the private key in base64EncodedCertificate is

  • certificate_policy (CertificatePolicy) (defaults to: nil)

    The management policy for the

  • certificate_attributes (CertificateAttributes) (defaults to: nil)

    The attributes of the

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

    Application specific metadata in the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1480
1481
1482
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1480

def import_certificate_with_http_info(vault_base_url, certificate_name, base64encoded_certificate, password:nil, certificate_policy:nil, certificate_attributes:nil, tags:nil, custom_headers:nil)
  import_certificate_async(vault_base_url, certificate_name, base64encoded_certificate, password:password, certificate_policy:certificate_policy, certificate_attributes:certificate_attributes, tags:tags, custom_headers:custom_headers).value!
end

#import_key(vault_base_url, key_name, key, hsm: nil, key_attributes: nil, tags: nil, release_policy: nil, custom_headers: nil) ⇒ KeyBundle

Imports an externally created key, stores it, and returns key parameters and attributes to the client.

The import key operation may be used to import any key type into an Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. This operation requires the keys/import permission.

myvault.vault.azure.net. key. form of key-value pairs. can be exported. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    Name for the imported key.

  • key (JsonWebKey)

    The Json web key

  • hsm (Boolean) (defaults to: nil)

    Whether to import as a hardware key (HSM) or software

  • key_attributes (KeyAttributes) (defaults to: nil)

    The key management attributes.

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

    Application specific metadata in the

  • release_policy (KeyReleasePolicy) (defaults to: nil)

    The policy rules under which the key

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

    A hash of custom headers that

Returns:

  • (KeyBundle)

    operation results.



3573
3574
3575
3576
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 3573

def import_key(vault_base_url, key_name, key, hsm:nil, key_attributes:nil, tags:nil, release_policy:nil, custom_headers:nil)
  response = import_key_async(vault_base_url, key_name, key, hsm:hsm, key_attributes:key_attributes, tags:tags, release_policy:release_policy, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#import_key_async(vault_base_url, key_name, key, hsm: nil, key_attributes: nil, tags: nil, release_policy: nil, custom_headers: nil) ⇒ Concurrent::Promise

Imports an externally created key, stores it, and returns key parameters and attributes to the client.

The import key operation may be used to import any key type into an Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. This operation requires the keys/import permission.

myvault.vault.azure.net. key. form of key-value pairs. can be exported. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    Name for the imported key.

  • key (JsonWebKey)

    The Json web key

  • hsm (Boolean) (defaults to: nil)

    Whether to import as a hardware key (HSM) or software

  • key_attributes (KeyAttributes) (defaults to: nil)

    The key management attributes.

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

    Application specific metadata in the

  • release_policy (KeyReleasePolicy) (defaults to: nil)

    The policy rules under which the key

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 3630

def import_key_async(vault_base_url, key_name, key, hsm:nil, key_attributes:nil, tags:nil, release_policy:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, "'key_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z-]+$'" if !key_name.nil? && key_name.match(Regexp.new('^^[0-9a-zA-Z-]+$$')).nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'key is nil' if key.nil?

  parameters = KeyImportParameters.new
  unless hsm.nil? && key.nil? && key_attributes.nil? && tags.nil? && release_policy.nil?
    parameters.hsm = hsm
    parameters.key = key
    parameters.keyAttributes = key_attributes
    parameters.tags = tags
    parameters.release_policy = release_policy
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::KeyImportParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'keys/{key-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'key-name' => key_name},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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 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::KeyBundle.mapper()
        result.body = self.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

#import_key_with_http_info(vault_base_url, key_name, key, hsm: nil, key_attributes: nil, tags: nil, release_policy: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Imports an externally created key, stores it, and returns key parameters and attributes to the client.

The import key operation may be used to import any key type into an Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. This operation requires the keys/import permission.

myvault.vault.azure.net. key. form of key-value pairs. can be exported. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    Name for the imported key.

  • key (JsonWebKey)

    The Json web key

  • hsm (Boolean) (defaults to: nil)

    Whether to import as a hardware key (HSM) or software

  • key_attributes (KeyAttributes) (defaults to: nil)

    The key management attributes.

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

    Application specific metadata in the

  • release_policy (KeyReleasePolicy) (defaults to: nil)

    The policy rules under which the key

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



3602
3603
3604
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 3602

def import_key_with_http_info(vault_base_url, key_name, key, hsm:nil, key_attributes:nil, tags:nil, release_policy:nil, custom_headers:nil)
  import_key_async(vault_base_url, key_name, key, hsm:hsm, key_attributes:key_attributes, tags:tags, release_policy:release_policy, custom_headers:custom_headers).value!
end

#make_request(method, path, options = {}) ⇒ Hash{String=>String}

Makes a request and returns the body of the response. Example:

request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
path = "/path"
options = {
  body: request_content,
  query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, options)

Parameters:

  • method (Symbol)

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String)

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Hash{String=>String})

    containing the body of the response.



82
83
84
85
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 82

def make_request(method, path, options = {})
  result = make_request_with_http_info(method, path, options)
  result.body unless result.nil?
end

#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise

Makes a request asynchronously.

Parameters:

  • method (Symbol)

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String)

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 107

def make_request_async(method, path, options = {})
  fail ArgumentError, 'method is nil' if method.nil?
  fail ArgumentError, 'path is nil' if path.nil?

  request_url = options[:base_url] || @base_url
  if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
    @request_headers['Content-Type'] = options[:headers]['Content-Type']
  end

  request_headers = @request_headers
  request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
  options.merge!({headers: request_headers.merge(options[:headers] || {})})
  options.merge!({credentials: @credentials}) unless @credentials.nil?

  super(request_url, method, path, options)
end

#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse

Makes a request and returns the operation response.

Parameters:

  • method (Symbol)

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String)

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (MsRestAzure::AzureOperationResponse)

    Operation response containing the request, response and status.



94
95
96
97
98
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 94

def make_request_with_http_info(method, path, options = {})
  result = make_request_async(method, path, options).value!
  result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
  result
end

#merge_certificate(vault_base_url, certificate_name, x509certificates, certificate_attributes: nil, tags: nil, custom_headers: nil) ⇒ CertificateBundle

Merges a certificate or a certificate chain with a key pair existing on the server.

The MergeCertificate operation performs the merging of a certificate or certificate chain with a key pair currently available in the service. This operation requires the certificates/create permission.

myvault.vault.azure.net. certificate chain to merge. certificate (optional). form of key-value pairs. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

  • x509certificates (Array<Array<Integer>>)

    The certificate or the

  • certificate_attributes (CertificateAttributes) (defaults to: nil)

    The attributes of the

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

    Application specific metadata in the

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

    A hash of custom headers that

Returns:

  • (CertificateBundle)

    operation results.



2560
2561
2562
2563
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2560

def merge_certificate(vault_base_url, certificate_name, x509certificates, certificate_attributes:nil, tags:nil, custom_headers:nil)
  response = merge_certificate_async(vault_base_url, certificate_name, x509certificates, certificate_attributes:certificate_attributes, tags:tags, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#merge_certificate_async(vault_base_url, certificate_name, x509certificates, certificate_attributes: nil, tags: nil, custom_headers: nil) ⇒ Concurrent::Promise

Merges a certificate or a certificate chain with a key pair existing on the server.

The MergeCertificate operation performs the merging of a certificate or certificate chain with a key pair currently available in the service. This operation requires the certificates/create permission.

myvault.vault.azure.net. certificate chain to merge. certificate (optional). form of key-value pairs. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

  • x509certificates (Array<Array<Integer>>)

    The certificate or the

  • certificate_attributes (CertificateAttributes) (defaults to: nil)

    The attributes of the

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

    Application specific metadata in the

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2613

def merge_certificate_async(vault_base_url, certificate_name, x509certificates, certificate_attributes:nil, tags:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'certificate_name is nil' if certificate_name.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'x509certificates is nil' if x509certificates.nil?

  parameters = CertificateMergeParameters.new
  unless x509certificates.nil? && certificate_attributes.nil? && tags.nil?
    parameters.x509Certificates = x509certificates
    parameters.CertificateAttributes = certificate_attributes
    parameters.tags = tags
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::CertificateMergeParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'certificates/{certificate-name}/pending/merge'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'certificate-name' => certificate_name},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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 == 201
      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 == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::KeyVault::V7_2_preview::Models::CertificateBundle.mapper()
        result.body = self.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

#merge_certificate_with_http_info(vault_base_url, certificate_name, x509certificates, certificate_attributes: nil, tags: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Merges a certificate or a certificate chain with a key pair existing on the server.

The MergeCertificate operation performs the merging of a certificate or certificate chain with a key pair currently available in the service. This operation requires the certificates/create permission.

myvault.vault.azure.net. certificate chain to merge. certificate (optional). form of key-value pairs. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

  • x509certificates (Array<Array<Integer>>)

    The certificate or the

  • certificate_attributes (CertificateAttributes) (defaults to: nil)

    The attributes of the

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

    Application specific metadata in the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



2587
2588
2589
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2587

def merge_certificate_with_http_info(vault_base_url, certificate_name, x509certificates, certificate_attributes:nil, tags:nil, custom_headers:nil)
  merge_certificate_async(vault_base_url, certificate_name, x509certificates, certificate_attributes:certificate_attributes, tags:tags, custom_headers:custom_headers).value!
end

#purge_deleted_certificate(vault_base_url, certificate_name, custom_headers: nil) ⇒ Object

Permanently deletes the specified deleted certificate.

The PurgeDeletedCertificate operation performs an irreversible deletion of the specified certificate, without possibility for recovery. The operation is not available if the recovery level does not specify ‘Purgeable’. This operation requires the certificate/purge permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate

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

    A hash of custom headers that



3164
3165
3166
3167
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 3164

def purge_deleted_certificate(vault_base_url, certificate_name, custom_headers:nil)
  response = purge_deleted_certificate_async(vault_base_url, certificate_name, custom_headers:custom_headers).value!
  nil
end

#purge_deleted_certificate_async(vault_base_url, certificate_name, custom_headers: nil) ⇒ Concurrent::Promise

Permanently deletes the specified deleted certificate.

The PurgeDeletedCertificate operation performs an irreversible deletion of the specified certificate, without possibility for recovery. The operation is not available if the recovery level does not specify ‘Purgeable’. This operation requires the certificate/purge permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 3205

def purge_deleted_certificate_async(vault_base_url, certificate_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'certificate_name is nil' if certificate_name.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'deletedcertificates/{certificate-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'certificate-name' => certificate_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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 == 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

#purge_deleted_certificate_with_http_info(vault_base_url, certificate_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Permanently deletes the specified deleted certificate.

The PurgeDeletedCertificate operation performs an irreversible deletion of the specified certificate, without possibility for recovery. The operation is not available if the recovery level does not specify ‘Purgeable’. This operation requires the certificate/purge permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



3185
3186
3187
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 3185

def purge_deleted_certificate_with_http_info(vault_base_url, certificate_name, custom_headers:nil)
  purge_deleted_certificate_async(vault_base_url, certificate_name, custom_headers:custom_headers).value!
end

#purge_deleted_key(vault_base_url, key_name, custom_headers: nil) ⇒ Object

Permanently deletes the specified key.

The Purge Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/purge permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key

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

    A hash of custom headers that



5991
5992
5993
5994
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 5991

def purge_deleted_key(vault_base_url, key_name, custom_headers:nil)
  response = purge_deleted_key_async(vault_base_url, key_name, custom_headers:custom_headers).value!
  nil
end

#purge_deleted_key_async(vault_base_url, key_name, custom_headers: nil) ⇒ Concurrent::Promise

Permanently deletes the specified key.

The Purge Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/purge permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6032

def purge_deleted_key_async(vault_base_url, key_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'deletedkeys/{key-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'key-name' => key_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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 == 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

#purge_deleted_key_with_http_info(vault_base_url, key_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Permanently deletes the specified key.

The Purge Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/purge permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



6012
6013
6014
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6012

def purge_deleted_key_with_http_info(vault_base_url, key_name, custom_headers:nil)
  purge_deleted_key_async(vault_base_url, key_name, custom_headers:custom_headers).value!
end

#purge_deleted_secret(vault_base_url, secret_name, custom_headers: nil) ⇒ Object

Permanently deletes the specified secret.

The purge deleted secret operation removes the secret permanently, without the possibility of recovery. This operation can only be enabled on a soft-delete enabled vault. This operation requires the secrets/purge permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

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

    A hash of custom headers that



7163
7164
7165
7166
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7163

def purge_deleted_secret(vault_base_url, secret_name, custom_headers:nil)
  response = purge_deleted_secret_async(vault_base_url, secret_name, custom_headers:custom_headers).value!
  nil
end

#purge_deleted_secret_async(vault_base_url, secret_name, custom_headers: nil) ⇒ Concurrent::Promise

Permanently deletes the specified secret.

The purge deleted secret operation removes the secret permanently, without the possibility of recovery. This operation can only be enabled on a soft-delete enabled vault. This operation requires the secrets/purge permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7204

def purge_deleted_secret_async(vault_base_url, secret_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'secret_name is nil' if secret_name.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'deletedsecrets/{secret-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'secret-name' => secret_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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 == 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

#purge_deleted_secret_with_http_info(vault_base_url, secret_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Permanently deletes the specified secret.

The purge deleted secret operation removes the secret permanently, without the possibility of recovery. This operation can only be enabled on a soft-delete enabled vault. This operation requires the secrets/purge permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



7184
7185
7186
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7184

def purge_deleted_secret_with_http_info(vault_base_url, secret_name, custom_headers:nil)
  purge_deleted_secret_async(vault_base_url, secret_name, custom_headers:custom_headers).value!
end

#purge_deleted_storage_account(vault_base_url, storage_account_name, custom_headers: nil) ⇒ Object

Permanently deletes the specified storage account.

The purge deleted storage account operation removes the secret permanently, without the possibility of recovery. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/purge permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

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

    A hash of custom headers that



7923
7924
7925
7926
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7923

def (vault_base_url, , custom_headers:nil)
  response = (vault_base_url, , custom_headers:custom_headers).value!
  nil
end

#purge_deleted_storage_account_async(vault_base_url, storage_account_name, custom_headers: nil) ⇒ Concurrent::Promise

Permanently deletes the specified storage account.

The purge deleted storage account operation removes the secret permanently, without the possibility of recovery. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/purge permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7964

def (vault_base_url, , custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'storage_account_name is nil' if .nil?
  fail ArgumentError, "'storage_account_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !.nil? && .match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'deletedstorage/{storage-account-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'storage-account-name' => },
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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 == 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

#purge_deleted_storage_account_with_http_info(vault_base_url, storage_account_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Permanently deletes the specified storage account.

The purge deleted storage account operation removes the secret permanently, without the possibility of recovery. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/purge permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



7944
7945
7946
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7944

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

#recover_deleted_certificate(vault_base_url, certificate_name, custom_headers: nil) ⇒ CertificateBundle

Recovers the deleted certificate back to its current version under /certificates.

The RecoverDeletedCertificate operation performs the reversal of the Delete operation. The operation is applicable in vaults enabled for soft-delete, and must be issued during the retention interval (available in the deleted certificate’s attributes). This operation requires the certificates/recover permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the deleted certificate

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

    A hash of custom headers that

Returns:

  • (CertificateBundle)

    operation results.



3268
3269
3270
3271
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 3268

def recover_deleted_certificate(vault_base_url, certificate_name, custom_headers:nil)
  response = recover_deleted_certificate_async(vault_base_url, certificate_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#recover_deleted_certificate_async(vault_base_url, certificate_name, custom_headers: nil) ⇒ Concurrent::Promise

Recovers the deleted certificate back to its current version under /certificates.

The RecoverDeletedCertificate operation performs the reversal of the Delete operation. The operation is applicable in vaults enabled for soft-delete, and must be issued during the retention interval (available in the deleted certificate’s attributes). This operation requires the certificates/recover permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the deleted certificate

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 3313

def recover_deleted_certificate_async(vault_base_url, certificate_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'certificate_name is nil' if certificate_name.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'deletedcertificates/{certificate-name}/recover'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'certificate-name' => certificate_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::CertificateBundle.mapper()
        result.body = self.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

#recover_deleted_certificate_with_http_info(vault_base_url, certificate_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Recovers the deleted certificate back to its current version under /certificates.

The RecoverDeletedCertificate operation performs the reversal of the Delete operation. The operation is applicable in vaults enabled for soft-delete, and must be issued during the retention interval (available in the deleted certificate’s attributes). This operation requires the certificates/recover permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the deleted certificate

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



3291
3292
3293
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 3291

def recover_deleted_certificate_with_http_info(vault_base_url, certificate_name, custom_headers:nil)
  recover_deleted_certificate_async(vault_base_url, certificate_name, custom_headers:custom_headers).value!
end

#recover_deleted_key(vault_base_url, key_name, custom_headers: nil) ⇒ KeyBundle

Recovers the deleted key to its latest version.

The Recover Deleted Key operation is applicable for deleted keys in soft-delete enabled vaults. It recovers the deleted key back to its latest version under /keys. An attempt to recover an non-deleted key will return an error. Consider this the inverse of the delete operation on soft-delete enabled vaults. This operation requires the keys/recover permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the deleted key.

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

    A hash of custom headers that

Returns:

  • (KeyBundle)

    operation results.



6094
6095
6096
6097
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6094

def recover_deleted_key(vault_base_url, key_name, custom_headers:nil)
  response = recover_deleted_key_async(vault_base_url, key_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#recover_deleted_key_async(vault_base_url, key_name, custom_headers: nil) ⇒ Concurrent::Promise

Recovers the deleted key to its latest version.

The Recover Deleted Key operation is applicable for deleted keys in soft-delete enabled vaults. It recovers the deleted key back to its latest version under /keys. An attempt to recover an non-deleted key will return an error. Consider this the inverse of the delete operation on soft-delete enabled vaults. This operation requires the keys/recover permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the deleted key.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6137

def recover_deleted_key_async(vault_base_url, key_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'deletedkeys/{key-name}/recover'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'key-name' => key_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::KeyBundle.mapper()
        result.body = self.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

#recover_deleted_key_with_http_info(vault_base_url, key_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Recovers the deleted key to its latest version.

The Recover Deleted Key operation is applicable for deleted keys in soft-delete enabled vaults. It recovers the deleted key back to its latest version under /keys. An attempt to recover an non-deleted key will return an error. Consider this the inverse of the delete operation on soft-delete enabled vaults. This operation requires the keys/recover permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the deleted key.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



6116
6117
6118
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6116

def recover_deleted_key_with_http_info(vault_base_url, key_name, custom_headers:nil)
  recover_deleted_key_async(vault_base_url, key_name, custom_headers:custom_headers).value!
end

#recover_deleted_sas_definition(vault_base_url, storage_account_name, sas_definition_name, custom_headers: nil) ⇒ SasDefinitionBundle

Recovers the deleted SAS definition.

Recovers the deleted SAS definition for the specified storage account. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • sas_definition_name (String)

    The name of the SAS definition.

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

    A hash of custom headers that

Returns:

  • (SasDefinitionBundle)

    operation results.



9314
9315
9316
9317
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9314

def recover_deleted_sas_definition(vault_base_url, , sas_definition_name, custom_headers:nil)
  response = recover_deleted_sas_definition_async(vault_base_url, , sas_definition_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#recover_deleted_sas_definition_async(vault_base_url, storage_account_name, sas_definition_name, custom_headers: nil) ⇒ Concurrent::Promise

Recovers the deleted SAS definition.

Recovers the deleted SAS definition for the specified storage account. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • sas_definition_name (String)

    The name of the SAS definition.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9355

def recover_deleted_sas_definition_async(vault_base_url, , sas_definition_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'storage_account_name is nil' if .nil?
  fail ArgumentError, "'storage_account_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !.nil? && .match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, 'sas_definition_name is nil' if sas_definition_name.nil?
  fail ArgumentError, "'sas_definition_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !sas_definition_name.nil? && sas_definition_name.match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'deletedstorage/{storage-account-name}/sas/{sas-definition-name}/recover'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'storage-account-name' => ,'sas-definition-name' => sas_definition_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::SasDefinitionBundle.mapper()
        result.body = self.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

#recover_deleted_sas_definition_with_http_info(vault_base_url, storage_account_name, sas_definition_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Recovers the deleted SAS definition.

Recovers the deleted SAS definition for the specified storage account. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • sas_definition_name (String)

    The name of the SAS definition.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



9335
9336
9337
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9335

def recover_deleted_sas_definition_with_http_info(vault_base_url, , sas_definition_name, custom_headers:nil)
  recover_deleted_sas_definition_async(vault_base_url, , sas_definition_name, custom_headers:custom_headers).value!
end

#recover_deleted_secret(vault_base_url, secret_name, custom_headers: nil) ⇒ SecretBundle

Recovers the deleted secret to the latest version.

Recovers the deleted secret in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the secrets/recover permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the deleted secret.

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

    A hash of custom headers that

Returns:

  • (SecretBundle)

    operation results.



7264
7265
7266
7267
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7264

def recover_deleted_secret(vault_base_url, secret_name, custom_headers:nil)
  response = recover_deleted_secret_async(vault_base_url, secret_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#recover_deleted_secret_async(vault_base_url, secret_name, custom_headers: nil) ⇒ Concurrent::Promise

Recovers the deleted secret to the latest version.

Recovers the deleted secret in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the secrets/recover permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the deleted secret.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7303

def recover_deleted_secret_async(vault_base_url, secret_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'secret_name is nil' if secret_name.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'deletedsecrets/{secret-name}/recover'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'secret-name' => secret_name},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::SecretBundle.mapper()
        result.body = self.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

#recover_deleted_secret_with_http_info(vault_base_url, secret_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Recovers the deleted secret to the latest version.

Recovers the deleted secret in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the secrets/recover permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the deleted secret.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



7284
7285
7286
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7284

def recover_deleted_secret_with_http_info(vault_base_url, secret_name, custom_headers:nil)
  recover_deleted_secret_async(vault_base_url, secret_name, custom_headers:custom_headers).value!
end

#recover_deleted_storage_account(vault_base_url, storage_account_name, custom_headers: nil) ⇒ StorageBundle

Recovers the deleted storage account.

Recovers the deleted storage account in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

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

    A hash of custom headers that

Returns:

  • (StorageBundle)

    operation results.



8025
8026
8027
8028
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8025

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

#recover_deleted_storage_account_async(vault_base_url, storage_account_name, custom_headers: nil) ⇒ Concurrent::Promise

Recovers the deleted storage account.

Recovers the deleted storage account in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8064

def (vault_base_url, , custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'storage_account_name is nil' if .nil?
  fail ArgumentError, "'storage_account_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !.nil? && .match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'deletedstorage/{storage-account-name}/recover'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'storage-account-name' => },
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::StorageBundle.mapper()
        result.body = self.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

#recover_deleted_storage_account_with_http_info(vault_base_url, storage_account_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Recovers the deleted storage account.

Recovers the deleted storage account in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



8045
8046
8047
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8045

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

#regenerate_storage_account_key(vault_base_url, storage_account_name, key_name, custom_headers: nil) ⇒ StorageBundle

Regenerates the specified key value for the given storage account. This operation requires the storage/regeneratekey permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • key_name (String)

    The storage account key name.

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

    A hash of custom headers that

Returns:

  • (StorageBundle)

    operation results.



8853
8854
8855
8856
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8853

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

#regenerate_storage_account_key_async(vault_base_url, storage_account_name, key_name, custom_headers: nil) ⇒ Concurrent::Promise

Regenerates the specified key value for the given storage account. This operation requires the storage/regeneratekey permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • key_name (String)

    The storage account key name.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8888

def (vault_base_url, , key_name, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'storage_account_name is nil' if .nil?
  fail ArgumentError, "'storage_account_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !.nil? && .match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?

  parameters = StorageAccountRegenerteKeyParameters.new
  unless key_name.nil?
    parameters.key_name = key_name
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::StorageAccountRegenerteKeyParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'storage/{storage-account-name}/regeneratekey'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'storage-account-name' => },
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::StorageBundle.mapper()
        result.body = self.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

#regenerate_storage_account_key_with_http_info(vault_base_url, storage_account_name, key_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Regenerates the specified key value for the given storage account. This operation requires the storage/regeneratekey permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • key_name (String)

    The storage account key name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



8871
8872
8873
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8871

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

#restore_certificate(vault_base_url, certificate_bundle_backup, custom_headers: nil) ⇒ CertificateBundle

Restores a backed up certificate to a vault.

Restores a backed up certificate, and all its versions, to a vault. This operation requires the certificates/restore permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_bundle_backup

    The backup blob associated with a

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

    A hash of custom headers that

Returns:

  • (CertificateBundle)

    operation results.



2806
2807
2808
2809
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2806

def restore_certificate(vault_base_url, certificate_bundle_backup, custom_headers:nil)
  response = restore_certificate_async(vault_base_url, certificate_bundle_backup, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#restore_certificate_async(vault_base_url, certificate_bundle_backup, custom_headers: nil) ⇒ Concurrent::Promise

Restores a backed up certificate to a vault.

Restores a backed up certificate, and all its versions, to a vault. This operation requires the certificates/restore permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_bundle_backup

    The backup blob associated with a

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2845

def restore_certificate_async(vault_base_url, certificate_bundle_backup, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'certificate_bundle_backup is nil' if certificate_bundle_backup.nil?

  parameters = CertificateRestoreParameters.new
  unless certificate_bundle_backup.nil?
    parameters.certificateBundleBackup = certificate_bundle_backup
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::CertificateRestoreParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'certificates/restore'

  request_url = @base_url || self.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' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::CertificateBundle.mapper()
        result.body = self.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

#restore_certificate_with_http_info(vault_base_url, certificate_bundle_backup, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Restores a backed up certificate to a vault.

Restores a backed up certificate, and all its versions, to a vault. This operation requires the certificates/restore permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_bundle_backup

    The backup blob associated with a

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



2826
2827
2828
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2826

def restore_certificate_with_http_info(vault_base_url, certificate_bundle_backup, custom_headers:nil)
  restore_certificate_async(vault_base_url, certificate_bundle_backup, custom_headers:custom_headers).value!
end

#restore_key(vault_base_url, key_bundle_backup, custom_headers: nil) ⇒ KeyBundle

Restores a backed up key to a vault.

Imports a previously backed up key into Azure Key Vault, restoring the key, its key identifier, attributes and access control policies. The RESTORE operation may be used to import a previously backed up key. Individual versions of a key cannot be restored. The key is restored in its entirety with the same key name as it had when it was backed up. If the key name is not available in the target Key Vault, the RESTORE operation will be rejected. While the key name is retained during restore, the final key identifier will change if the key is restored to a different vault. Restore will restore all versions and preserve version identifiers. The RESTORE operation is subject to security constraints: The target Key Vault must be owned by the same Microsoft Azure Subscription as the source Key Vault The user must have RESTORE permission in the target Key Vault. This operation requires the keys/restore permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_bundle_backup

    The backup blob associated with a key bundle.

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

    A hash of custom headers that

Returns:

  • (KeyBundle)

    operation results.



4483
4484
4485
4486
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 4483

def restore_key(vault_base_url, key_bundle_backup, custom_headers:nil)
  response = restore_key_async(vault_base_url, key_bundle_backup, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#restore_key_async(vault_base_url, key_bundle_backup, custom_headers: nil) ⇒ Concurrent::Promise

Restores a backed up key to a vault.

Imports a previously backed up key into Azure Key Vault, restoring the key, its key identifier, attributes and access control policies. The RESTORE operation may be used to import a previously backed up key. Individual versions of a key cannot be restored. The key is restored in its entirety with the same key name as it had when it was backed up. If the key name is not available in the target Key Vault, the RESTORE operation will be rejected. While the key name is retained during restore, the final key identifier will change if the key is restored to a different vault. Restore will restore all versions and preserve version identifiers. The RESTORE operation is subject to security constraints: The target Key Vault must be owned by the same Microsoft Azure Subscription as the source Key Vault The user must have RESTORE permission in the target Key Vault. This operation requires the keys/restore permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_bundle_backup

    The backup blob associated with a key bundle.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 4542

def restore_key_async(vault_base_url, key_bundle_backup, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'key_bundle_backup is nil' if key_bundle_backup.nil?

  parameters = KeyRestoreParameters.new
  unless key_bundle_backup.nil?
    parameters.keyBundleBackup = key_bundle_backup
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::KeyRestoreParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'keys/restore'

  request_url = @base_url || self.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' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::KeyBundle.mapper()
        result.body = self.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

#restore_key_with_http_info(vault_base_url, key_bundle_backup, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Restores a backed up key to a vault.

Imports a previously backed up key into Azure Key Vault, restoring the key, its key identifier, attributes and access control policies. The RESTORE operation may be used to import a previously backed up key. Individual versions of a key cannot be restored. The key is restored in its entirety with the same key name as it had when it was backed up. If the key name is not available in the target Key Vault, the RESTORE operation will be rejected. While the key name is retained during restore, the final key identifier will change if the key is restored to a different vault. Restore will restore all versions and preserve version identifiers. The RESTORE operation is subject to security constraints: The target Key Vault must be owned by the same Microsoft Azure Subscription as the source Key Vault The user must have RESTORE permission in the target Key Vault. This operation requires the keys/restore permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_bundle_backup

    The backup blob associated with a key bundle.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



4513
4514
4515
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 4513

def restore_key_with_http_info(vault_base_url, key_bundle_backup, custom_headers:nil)
  restore_key_async(vault_base_url, key_bundle_backup, custom_headers:custom_headers).value!
end

#restore_secret(vault_base_url, secret_bundle_backup, custom_headers: nil) ⇒ SecretBundle

Restores a backed up secret to a vault.

Restores a backed up secret, and all its versions, to a vault. This operation requires the secrets/restore permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_bundle_backup

    The backup blob associated with a secret bundle.

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

    A hash of custom headers that

Returns:

  • (SecretBundle)

    operation results.



7481
7482
7483
7484
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7481

def restore_secret(vault_base_url, secret_bundle_backup, custom_headers:nil)
  response = restore_secret_async(vault_base_url, secret_bundle_backup, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#restore_secret_async(vault_base_url, secret_bundle_backup, custom_headers: nil) ⇒ Concurrent::Promise

Restores a backed up secret to a vault.

Restores a backed up secret, and all its versions, to a vault. This operation requires the secrets/restore permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_bundle_backup

    The backup blob associated with a secret bundle.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7518

def restore_secret_async(vault_base_url, secret_bundle_backup, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'secret_bundle_backup is nil' if secret_bundle_backup.nil?

  parameters = SecretRestoreParameters.new
  unless secret_bundle_backup.nil?
    parameters.secretBundleBackup = secret_bundle_backup
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::SecretRestoreParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'secrets/restore'

  request_url = @base_url || self.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' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::SecretBundle.mapper()
        result.body = self.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

#restore_secret_with_http_info(vault_base_url, secret_bundle_backup, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Restores a backed up secret to a vault.

Restores a backed up secret, and all its versions, to a vault. This operation requires the secrets/restore permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_bundle_backup

    The backup blob associated with a secret bundle.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



7500
7501
7502
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 7500

def restore_secret_with_http_info(vault_base_url, secret_bundle_backup, custom_headers:nil)
  restore_secret_async(vault_base_url, secret_bundle_backup, custom_headers:custom_headers).value!
end

#restore_status(vault_base_url, job_id, custom_headers: nil) ⇒ RestoreOperation

Returns the status of restore operation

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • job_id (String)

    The Job Id returned part of the restore operation

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

    A hash of custom headers that

Returns:

  • (RestoreOperation)

    operation results.



10269
10270
10271
10272
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10269

def restore_status(vault_base_url, job_id, custom_headers:nil)
  response = restore_status_async(vault_base_url, job_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#restore_status_async(vault_base_url, job_id, custom_headers: nil) ⇒ Concurrent::Promise

Returns the status of restore operation

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • job_id (String)

    The Job Id returned part of the restore operation

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10300

def restore_status_async(vault_base_url, job_id, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'job_id is nil' if job_id.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'restore/{jobId}/pending'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'jobId' => job_id},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::RestoreOperation.mapper()
        result.body = self.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

#restore_status_with_http_info(vault_base_url, job_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Returns the status of restore operation

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • job_id (String)

    The Job Id returned part of the restore operation

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



10285
10286
10287
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10285

def restore_status_with_http_info(vault_base_url, job_id, custom_headers:nil)
  restore_status_async(vault_base_url, job_id, custom_headers:custom_headers).value!
end

#restore_storage_account(vault_base_url, storage_bundle_backup, custom_headers: nil) ⇒ StorageBundle

Restores a backed up storage account to a vault.

Restores a backed up storage account to a vault. This operation requires the storage/restore permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_bundle_backup

    The backup blob associated with a storage

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

    A hash of custom headers that

Returns:

  • (StorageBundle)

    operation results.



8241
8242
8243
8244
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8241

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

#restore_storage_account_async(vault_base_url, storage_bundle_backup, custom_headers: nil) ⇒ Concurrent::Promise

Restores a backed up storage account to a vault.

Restores a backed up storage account to a vault. This operation requires the storage/restore permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_bundle_backup

    The backup blob associated with a storage

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8280

def (vault_base_url, storage_bundle_backup, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'storage_bundle_backup is nil' if storage_bundle_backup.nil?

  parameters = StorageRestoreParameters.new
  unless storage_bundle_backup.nil?
    parameters.storageBundleBackup = storage_bundle_backup
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::StorageRestoreParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'storage/restore'

  request_url = @base_url || self.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' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::StorageBundle.mapper()
        result.body = self.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

#restore_storage_account_with_http_info(vault_base_url, storage_bundle_backup, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Restores a backed up storage account to a vault.

Restores a backed up storage account to a vault. This operation requires the storage/restore permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_bundle_backup

    The backup blob associated with a storage

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



8261
8262
8263
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8261

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

#selective_key_restore_operation_method(vault_base_url, key_name, restore_blob_details: nil, custom_headers: nil) ⇒ SelectiveKeyRestoreOperation

Restores all key versions of a given key using user supplied SAS token pointing to a previously stored Azure Blob storage backup folder

myvault.vault.azure.net. supplied backup Azure blob SAS token pointing to a folder where the previous successful full backup was stored will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key to be restored from the user

  • restore_blob_details (SelectiveKeyRestoreOperationParameters) (defaults to: nil)

    The

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

    A hash of custom headers that

Returns:

  • (SelectiveKeyRestoreOperation)

    operation results.



10371
10372
10373
10374
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10371

def selective_key_restore_operation_method(vault_base_url, key_name, restore_blob_details:nil, custom_headers:nil)
  response = selective_key_restore_operation_method_async(vault_base_url, key_name, restore_blob_details:restore_blob_details, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#selective_key_restore_operation_method_async(vault_base_url, key_name, restore_blob_details: nil, custom_headers: nil) ⇒ Concurrent::Promise

Restores all key versions of a given key using user supplied SAS token pointing to a previously stored Azure Blob storage backup folder

myvault.vault.azure.net. supplied backup Azure blob SAS token pointing to a folder where the previous successful full backup was stored to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key to be restored from the user

  • restore_blob_details (SelectiveKeyRestoreOperationParameters) (defaults to: nil)

    The

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10412

def selective_key_restore_operation_method_async(vault_base_url, key_name, restore_blob_details:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::SelectiveKeyRestoreOperationParameters.mapper()
  request_content = self.serialize(request_mapper,  restore_blob_details)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'keys/{keyName}/restore'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'keyName' => key_name},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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 == 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::SelectiveKeyRestoreOperation.mapper()
        result.body = self.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

#selective_key_restore_operation_method_with_http_info(vault_base_url, key_name, restore_blob_details: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Restores all key versions of a given key using user supplied SAS token pointing to a previously stored Azure Blob storage backup folder

myvault.vault.azure.net. supplied backup Azure blob SAS token pointing to a folder where the previous successful full backup was stored will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key to be restored from the user

  • restore_blob_details (SelectiveKeyRestoreOperationParameters) (defaults to: nil)

    The

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



10392
10393
10394
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 10392

def selective_key_restore_operation_method_with_http_info(vault_base_url, key_name, restore_blob_details:nil, custom_headers:nil)
  selective_key_restore_operation_method_async(vault_base_url, key_name, restore_blob_details:restore_blob_details, custom_headers:custom_headers).value!
end

#set_certificate_contacts(vault_base_url, contacts, custom_headers: nil) ⇒ Contacts

Sets the certificate contacts for the specified key vault.

Sets the certificate contacts for the specified key vault. This operation requires the certificates/managecontacts permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • contacts (Contacts)

    The contacts for the key vault certificate.

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

    A hash of custom headers that

Returns:

  • (Contacts)

    operation results.



368
369
370
371
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 368

def set_certificate_contacts(vault_base_url, contacts, custom_headers:nil)
  response = set_certificate_contacts_async(vault_base_url, contacts, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#set_certificate_contacts_async(vault_base_url, contacts, custom_headers: nil) ⇒ Concurrent::Promise

Sets the certificate contacts for the specified key vault.

Sets the certificate contacts for the specified key vault. This operation requires the certificates/managecontacts permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • contacts (Contacts)

    The contacts for the key vault certificate.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
460
461
462
463
464
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 405

def set_certificate_contacts_async(vault_base_url, contacts, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'contacts is nil' if contacts.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::Contacts.mapper()
  request_content = self.serialize(request_mapper,  contacts)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'certificates/contacts'

  request_url = @base_url || self.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' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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 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::Contacts.mapper()
        result.body = self.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

#set_certificate_contacts_with_http_info(vault_base_url, contacts, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Sets the certificate contacts for the specified key vault.

Sets the certificate contacts for the specified key vault. This operation requires the certificates/managecontacts permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • contacts (Contacts)

    The contacts for the key vault certificate.

  • 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/key_vault_client.rb', line 387

def set_certificate_contacts_with_http_info(vault_base_url, contacts, custom_headers:nil)
  set_certificate_contacts_async(vault_base_url, contacts, custom_headers:custom_headers).value!
end

#set_certificate_issuer(vault_base_url, issuer_name, provider, credentials: nil, organization_details: nil, attributes: nil, custom_headers: nil) ⇒ IssuerBundle

Sets the specified certificate issuer.

The SetCertificateIssuer operation adds or updates the specified certificate issuer. This operation requires the certificates/setissuers permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • issuer_name (String)

    The name of the issuer.

  • provider (String)

    The issuer provider.

  • credentials (IssuerCredentials) (defaults to: nil)

    The credentials to be used for the

  • organization_details (OrganizationDetails) (defaults to: nil)

    Details of the organization

  • attributes (IssuerAttributes) (defaults to: nil)

    Attributes of the issuer object.

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

    A hash of custom headers that

Returns:

  • (IssuerBundle)

    operation results.



803
804
805
806
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 803

def set_certificate_issuer(vault_base_url, issuer_name, provider, credentials:nil, organization_details:nil, attributes:nil, custom_headers:nil)
  response = set_certificate_issuer_async(vault_base_url, issuer_name, provider, credentials:credentials, organization_details:organization_details, attributes:attributes, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#set_certificate_issuer_async(vault_base_url, issuer_name, provider, credentials: nil, organization_details: nil, attributes: nil, custom_headers: nil) ⇒ Concurrent::Promise

Sets the specified certificate issuer.

The SetCertificateIssuer operation adds or updates the specified certificate issuer. This operation requires the certificates/setissuers permission.

myvault.vault.azure.net. issuer. as provided to the issuer. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • issuer_name (String)

    The name of the issuer.

  • provider (String)

    The issuer provider.

  • credentials (IssuerCredentials) (defaults to: nil)

    The credentials to be used for the

  • organization_details (OrganizationDetails) (defaults to: nil)

    Details of the organization

  • attributes (IssuerAttributes) (defaults to: nil)

    Attributes of the issuer object.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 852

def set_certificate_issuer_async(vault_base_url, issuer_name, provider, credentials:nil, organization_details:nil, attributes:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'issuer_name is nil' if issuer_name.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'provider is nil' if provider.nil?

  parameter = CertificateIssuerSetParameters.new
  unless provider.nil? && credentials.nil? && organization_details.nil? && attributes.nil?
    parameter.provider = provider
    parameter.credentials = credentials
    parameter.OrganizationDetails = organization_details
    parameter.attributes = attributes
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::CertificateIssuerSetParameters.mapper()
  request_content = self.serialize(request_mapper,  parameter)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'certificates/issuers/{issuer-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'issuer-name' => issuer_name},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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 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::IssuerBundle.mapper()
        result.body = self.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

#set_certificate_issuer_with_http_info(vault_base_url, issuer_name, provider, credentials: nil, organization_details: nil, attributes: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Sets the specified certificate issuer.

The SetCertificateIssuer operation adds or updates the specified certificate issuer. This operation requires the certificates/setissuers permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • issuer_name (String)

    The name of the issuer.

  • provider (String)

    The issuer provider.

  • credentials (IssuerCredentials) (defaults to: nil)

    The credentials to be used for the

  • organization_details (OrganizationDetails) (defaults to: nil)

    Details of the organization

  • attributes (IssuerAttributes) (defaults to: nil)

    Attributes of the issuer object.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



828
829
830
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 828

def set_certificate_issuer_with_http_info(vault_base_url, issuer_name, provider, credentials:nil, organization_details:nil, attributes:nil, custom_headers:nil)
  set_certificate_issuer_async(vault_base_url, issuer_name, provider, credentials:credentials, organization_details:organization_details, attributes:attributes, custom_headers:custom_headers).value!
end

#set_sas_definition(vault_base_url, storage_account_name, sas_definition_name, template_uri, sas_type, validity_period, sas_definition_attributes: nil, tags: nil, custom_headers: nil) ⇒ SasDefinitionBundle

Creates or updates a new SAS definition for the specified storage account. This operation requires the storage/setsas permission.

myvault.vault.azure.net. arbitrary key. Tokens created according to the SAS definition will have the same properties as the template. create. Possible values include: ‘account’, ‘service’ according to the SAS definition. the SAS definition. form of key-value pairs. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • sas_definition_name (String)

    The name of the SAS definition.

  • template_uri (String)

    The SAS definition token template signed with an

  • sas_type (SasTokenType)

    The type of SAS token the SAS definition will

  • validity_period (String)

    The validity period of SAS tokens created

  • sas_definition_attributes (SasDefinitionAttributes) (defaults to: nil)

    The attributes of

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

    Application specific metadata in the

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

    A hash of custom headers that

Returns:

  • (SasDefinitionBundle)

    operation results.



9649
9650
9651
9652
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9649

def set_sas_definition(vault_base_url, , sas_definition_name, template_uri, sas_type, validity_period, sas_definition_attributes:nil, tags:nil, custom_headers:nil)
  response = set_sas_definition_async(vault_base_url, , sas_definition_name, template_uri, sas_type, validity_period, sas_definition_attributes:sas_definition_attributes, tags:tags, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#set_sas_definition_async(vault_base_url, storage_account_name, sas_definition_name, template_uri, sas_type, validity_period, sas_definition_attributes: nil, tags: nil, custom_headers: nil) ⇒ Concurrent::Promise

Creates or updates a new SAS definition for the specified storage account. This operation requires the storage/setsas permission.

myvault.vault.azure.net. arbitrary key. Tokens created according to the SAS definition will have the same properties as the template. create. Possible values include: ‘account’, ‘service’ according to the SAS definition. the SAS definition. form of key-value pairs. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • sas_definition_name (String)

    The name of the SAS definition.

  • template_uri (String)

    The SAS definition token template signed with an

  • sas_type (SasTokenType)

    The type of SAS token the SAS definition will

  • validity_period (String)

    The validity period of SAS tokens created

  • sas_definition_attributes (SasDefinitionAttributes) (defaults to: nil)

    The attributes of

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

    Application specific metadata in the

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9706

def set_sas_definition_async(vault_base_url, , sas_definition_name, template_uri, sas_type, validity_period, sas_definition_attributes:nil, tags:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'storage_account_name is nil' if .nil?
  fail ArgumentError, "'storage_account_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !.nil? && .match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, 'sas_definition_name is nil' if sas_definition_name.nil?
  fail ArgumentError, "'sas_definition_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !sas_definition_name.nil? && sas_definition_name.match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'template_uri is nil' if template_uri.nil?
  fail ArgumentError, 'sas_type is nil' if sas_type.nil?
  fail ArgumentError, 'validity_period is nil' if validity_period.nil?

  parameters = SasDefinitionCreateParameters.new
  unless template_uri.nil? && sas_type.nil? && validity_period.nil? && sas_definition_attributes.nil? && tags.nil?
    parameters.template_uri = template_uri
    parameters.sas_type = sas_type
    parameters.validity_period = validity_period
    parameters.SasDefinitionAttributes = sas_definition_attributes
    parameters.tags = tags
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::SasDefinitionCreateParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'storage/{storage-account-name}/sas/{sas-definition-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'storage-account-name' => ,'sas-definition-name' => sas_definition_name},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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 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::SasDefinitionBundle.mapper()
        result.body = self.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

#set_sas_definition_with_http_info(vault_base_url, storage_account_name, sas_definition_name, template_uri, sas_type, validity_period, sas_definition_attributes: nil, tags: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates a new SAS definition for the specified storage account. This operation requires the storage/setsas permission.

myvault.vault.azure.net. arbitrary key. Tokens created according to the SAS definition will have the same properties as the template. create. Possible values include: ‘account’, ‘service’ according to the SAS definition. the SAS definition. form of key-value pairs. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • sas_definition_name (String)

    The name of the SAS definition.

  • template_uri (String)

    The SAS definition token template signed with an

  • sas_type (SasTokenType)

    The type of SAS token the SAS definition will

  • validity_period (String)

    The validity period of SAS tokens created

  • sas_definition_attributes (SasDefinitionAttributes) (defaults to: nil)

    The attributes of

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

    Application specific metadata in the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



9678
9679
9680
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9678

def set_sas_definition_with_http_info(vault_base_url, , sas_definition_name, template_uri, sas_type, validity_period, sas_definition_attributes:nil, tags:nil, custom_headers:nil)
  set_sas_definition_async(vault_base_url, , sas_definition_name, template_uri, sas_type, validity_period, sas_definition_attributes:sas_definition_attributes, tags:tags, custom_headers:custom_headers).value!
end

#set_secret(vault_base_url, secret_name, value, tags: nil, content_type: nil, secret_attributes: nil, custom_headers: nil) ⇒ SecretBundle

Sets a secret in a specified key vault.

The SET operation adds a secret to the Azure Key Vault. If the named secret already exists, Azure Key Vault creates a new version of that secret. This operation requires the secrets/set permission.

myvault.vault.azure.net. form of key-value pairs. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

  • value (String)

    The value of the secret.

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

    Application specific metadata in the

  • content_type (String) (defaults to: nil)

    Type of the secret value such as a password.

  • secret_attributes (SecretAttributes) (defaults to: nil)

    The secret management attributes.

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

    A hash of custom headers that

Returns:

  • (SecretBundle)

    operation results.



6212
6213
6214
6215
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6212

def set_secret(vault_base_url, secret_name, value, tags:nil, content_type:nil, secret_attributes:nil, custom_headers:nil)
  response = set_secret_async(vault_base_url, secret_name, value, tags:tags, content_type:content_type, secret_attributes:secret_attributes, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#set_secret_async(vault_base_url, secret_name, value, tags: nil, content_type: nil, secret_attributes: nil, custom_headers: nil) ⇒ Concurrent::Promise

Sets a secret in a specified key vault.

The SET operation adds a secret to the Azure Key Vault. If the named secret already exists, Azure Key Vault creates a new version of that secret. This operation requires the secrets/set permission.

myvault.vault.azure.net. form of key-value pairs. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

  • value (String)

    The value of the secret.

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

    Application specific metadata in the

  • content_type (String) (defaults to: nil)

    Type of the secret value such as a password.

  • secret_attributes (SecretAttributes) (defaults to: nil)

    The secret management attributes.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6261

def set_secret_async(vault_base_url, secret_name, value, tags:nil, content_type:nil, secret_attributes:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'secret_name is nil' if secret_name.nil?
  fail ArgumentError, "'secret_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z-]+$'" if !secret_name.nil? && secret_name.match(Regexp.new('^^[0-9a-zA-Z-]+$$')).nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'value is nil' if value.nil?

  parameters = SecretSetParameters.new
  unless value.nil? && tags.nil? && content_type.nil? && secret_attributes.nil?
    parameters.value = value
    parameters.tags = tags
    parameters.content_type = content_type
    parameters.secretAttributes = secret_attributes
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::SecretSetParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'secrets/{secret-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'secret-name' => secret_name},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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 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::SecretBundle.mapper()
        result.body = self.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

#set_secret_with_http_info(vault_base_url, secret_name, value, tags: nil, content_type: nil, secret_attributes: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Sets a secret in a specified key vault.

The SET operation adds a secret to the Azure Key Vault. If the named secret already exists, Azure Key Vault creates a new version of that secret. This operation requires the secrets/set permission.

myvault.vault.azure.net. form of key-value pairs. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

  • value (String)

    The value of the secret.

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

    Application specific metadata in the

  • content_type (String) (defaults to: nil)

    Type of the secret value such as a password.

  • secret_attributes (SecretAttributes) (defaults to: nil)

    The secret management attributes.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



6237
6238
6239
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6237

def set_secret_with_http_info(vault_base_url, secret_name, value, tags:nil, content_type:nil, secret_attributes:nil, custom_headers:nil)
  set_secret_async(vault_base_url, secret_name, value, tags:tags, content_type:content_type, secret_attributes:secret_attributes, custom_headers:custom_headers).value!
end

#set_storage_account(vault_base_url, storage_account_name, resource_id, active_key_name, auto_regenerate_key, regeneration_period: nil, storage_account_attributes: nil, tags: nil, custom_headers: nil) ⇒ StorageBundle

Creates or updates a new storage account. This operation requires the storage/set permission.

myvault.vault.azure.net. storage account for the user. specified in ISO-8601 format. of the storage account. form of key-value pairs. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • resource_id (String)

    Storage account resource id.

  • active_key_name (String)

    Current active storage account key name.

  • auto_regenerate_key (Boolean)

    whether keyvault should manage the

  • regeneration_period (String) (defaults to: nil)

    The key regeneration time duration

  • storage_account_attributes (StorageAccountAttributes) (defaults to: nil)

    The attributes

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

    Application specific metadata in the

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

    A hash of custom headers that

Returns:

  • (StorageBundle)

    operation results.



8569
8570
8571
8572
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8569

def (vault_base_url, , resource_id, active_key_name, auto_regenerate_key, regeneration_period:nil, storage_account_attributes:nil, tags:nil, custom_headers:nil)
  response = (vault_base_url, , resource_id, active_key_name, auto_regenerate_key, regeneration_period:regeneration_period, storage_account_attributes:, tags:tags, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#set_storage_account_async(vault_base_url, storage_account_name, resource_id, active_key_name, auto_regenerate_key, regeneration_period: nil, storage_account_attributes: nil, tags: nil, custom_headers: nil) ⇒ Concurrent::Promise

Creates or updates a new storage account. This operation requires the storage/set permission.

myvault.vault.azure.net. storage account for the user. specified in ISO-8601 format. of the storage account. form of key-value pairs. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • resource_id (String)

    Storage account resource id.

  • active_key_name (String)

    Current active storage account key name.

  • auto_regenerate_key (Boolean)

    whether keyvault should manage the

  • regeneration_period (String) (defaults to: nil)

    The key regeneration time duration

  • storage_account_attributes (StorageAccountAttributes) (defaults to: nil)

    The attributes

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

    Application specific metadata in the

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8622

def (vault_base_url, , resource_id, active_key_name, auto_regenerate_key, regeneration_period:nil, storage_account_attributes:nil, tags:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'storage_account_name is nil' if .nil?
  fail ArgumentError, "'storage_account_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !.nil? && .match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'resource_id is nil' if resource_id.nil?
  fail ArgumentError, 'active_key_name is nil' if active_key_name.nil?
  fail ArgumentError, 'auto_regenerate_key is nil' if auto_regenerate_key.nil?

  parameters = StorageAccountCreateParameters.new
  unless resource_id.nil? && active_key_name.nil? && auto_regenerate_key.nil? && regeneration_period.nil? && .nil? && tags.nil?
    parameters.resource_id = resource_id
    parameters.active_key_name = active_key_name
    parameters.auto_regenerate_key = auto_regenerate_key
    parameters.regeneration_period = regeneration_period
    parameters.StorageAccountAttributes = 
    parameters.tags = tags
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::StorageAccountCreateParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'storage/{storage-account-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'storage-account-name' => },
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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 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::StorageBundle.mapper()
        result.body = self.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

#set_storage_account_with_http_info(vault_base_url, storage_account_name, resource_id, active_key_name, auto_regenerate_key, regeneration_period: nil, storage_account_attributes: nil, tags: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates a new storage account. This operation requires the storage/set permission.

myvault.vault.azure.net. storage account for the user. specified in ISO-8601 format. of the storage account. form of key-value pairs. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • resource_id (String)

    Storage account resource id.

  • active_key_name (String)

    Current active storage account key name.

  • auto_regenerate_key (Boolean)

    whether keyvault should manage the

  • regeneration_period (String) (defaults to: nil)

    The key regeneration time duration

  • storage_account_attributes (StorageAccountAttributes) (defaults to: nil)

    The attributes

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

    Application specific metadata in the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



8596
8597
8598
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8596

def (vault_base_url, , resource_id, active_key_name, auto_regenerate_key, regeneration_period:nil, storage_account_attributes:nil, tags:nil, custom_headers:nil)
  (vault_base_url, , resource_id, active_key_name, auto_regenerate_key, regeneration_period:regeneration_period, storage_account_attributes:, tags:tags, custom_headers:custom_headers).value!
end

#sign(vault_base_url, key_name, key_version, algorithm, value, custom_headers: nil) ⇒ KeyOperationResult

Creates a signature from a digest using the specified key.

The SIGN operation is applicable to asymmetric and symmetric keys stored in Azure Key Vault since this operation uses the private portion of the key. This operation requires the keys/sign permission.

myvault.vault.azure.net. algorithm identifier. For more information on possible algorithm types, see JsonWebKeySignatureAlgorithm. Possible values include: ‘PS256’, ‘PS384’, ‘PS512’, ‘RS256’, ‘RS384’, ‘RS512’, ‘RSNULL’, ‘ES256’, ‘ES384’, ‘ES512’, ‘ES256K’ will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • key_version (String)

    The version of the key.

  • algorithm (JsonWebKeySignatureAlgorithm)

    The signing/verification

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

    A hash of custom headers that

Returns:

  • (KeyOperationResult)

    operation results.



4987
4988
4989
4990
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 4987

def sign(vault_base_url, key_name, key_version, algorithm, value, custom_headers:nil)
  response = sign_async(vault_base_url, key_name, key_version, algorithm, value, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#sign_async(vault_base_url, key_name, key_version, algorithm, value, custom_headers: nil) ⇒ Concurrent::Promise

Creates a signature from a digest using the specified key.

The SIGN operation is applicable to asymmetric and symmetric keys stored in Azure Key Vault since this operation uses the private portion of the key. This operation requires the keys/sign permission.

myvault.vault.azure.net. algorithm identifier. For more information on possible algorithm types, see JsonWebKeySignatureAlgorithm. Possible values include: ‘PS256’, ‘PS384’, ‘PS512’, ‘RS256’, ‘RS384’, ‘RS512’, ‘RSNULL’, ‘ES256’, ‘ES384’, ‘ES512’, ‘ES256K’ to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • key_version (String)

    The version of the key.

  • algorithm (JsonWebKeySignatureAlgorithm)

    The signing/verification

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 5040

def sign_async(vault_base_url, key_name, key_version, algorithm, value, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, 'key_version is nil' if key_version.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'algorithm is nil' if algorithm.nil?
  fail ArgumentError, "'algorithm' should satisfy the constraint - 'MinLength': '1'" if !algorithm.nil? && algorithm.length < 1
  fail ArgumentError, 'value is nil' if value.nil?

  parameters = KeySignParameters.new
  unless algorithm.nil? && value.nil?
    parameters.algorithm = algorithm
    parameters.value = value
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::KeySignParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'keys/{key-name}/{key-version}/sign'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'key-name' => key_name,'key-version' => key_version},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::KeyOperationResult.mapper()
        result.body = self.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

#sign_with_http_info(vault_base_url, key_name, key_version, algorithm, value, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a signature from a digest using the specified key.

The SIGN operation is applicable to asymmetric and symmetric keys stored in Azure Key Vault since this operation uses the private portion of the key. This operation requires the keys/sign permission.

myvault.vault.azure.net. algorithm identifier. For more information on possible algorithm types, see JsonWebKeySignatureAlgorithm. Possible values include: ‘PS256’, ‘PS384’, ‘PS512’, ‘RS256’, ‘RS384’, ‘RS512’, ‘RSNULL’, ‘ES256’, ‘ES384’, ‘ES512’, ‘ES256K’ will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • key_version (String)

    The version of the key.

  • algorithm (JsonWebKeySignatureAlgorithm)

    The signing/verification

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



5014
5015
5016
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 5014

def sign_with_http_info(vault_base_url, key_name, key_version, algorithm, value, custom_headers:nil)
  sign_async(vault_base_url, key_name, key_version, algorithm, value, custom_headers:custom_headers).value!
end

#unwrap_key(vault_base_url, key_name, key_version, algorithm, value, iv: nil, aad: nil, tag: nil, custom_headers: nil) ⇒ KeyOperationResult

Unwraps a symmetric key using the specified key that was initially used for wrapping that key.

The UNWRAP operation supports decryption of a symmetric key using the target key encryption key. This operation is the reverse of the WRAP operation. The UNWRAP operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation requires the keys/unwrapKey permission.

myvault.vault.azure.net. Possible values include: ‘RSA-OAEP’, ‘RSA-OAEP-256’, ‘RSA1_5’, ‘A128GCM’, ‘A192GCM’, ‘A256GCM’, ‘A128KW’, ‘A192KW’, ‘A256KW’, ‘A128CBC’, ‘A192CBC’, ‘A256CBC’, ‘A128CBCPAD’, ‘A192CBCPAD’, ‘A256CBCPAD’ authenticated crypto algorithms. authenticated algorithm. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • key_version (String)

    The version of the key.

  • algorithm (JsonWebKeyEncryptionAlgorithm)

    algorithm identifier.

  • value
  • iv (defaults to: nil)

    Initialization vector for symmetric algorithms.

  • aad (defaults to: nil)

    Additional data to authenticate but not encrypt/decrypt when using

  • tag (defaults to: nil)

    The tag to authenticate when performing decryption with an

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

    A hash of custom headers that

Returns:

  • (KeyOperationResult)

    operation results.



5473
5474
5475
5476
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 5473

def unwrap_key(vault_base_url, key_name, key_version, algorithm, value, iv:nil, aad:nil, tag:nil, custom_headers:nil)
  response = unwrap_key_async(vault_base_url, key_name, key_version, algorithm, value, iv:iv, aad:aad, tag:tag, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#unwrap_key_async(vault_base_url, key_name, key_version, algorithm, value, iv: nil, aad: nil, tag: nil, custom_headers: nil) ⇒ Concurrent::Promise

Unwraps a symmetric key using the specified key that was initially used for wrapping that key.

The UNWRAP operation supports decryption of a symmetric key using the target key encryption key. This operation is the reverse of the WRAP operation. The UNWRAP operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation requires the keys/unwrapKey permission.

myvault.vault.azure.net. Possible values include: ‘RSA-OAEP’, ‘RSA-OAEP-256’, ‘RSA1_5’, ‘A128GCM’, ‘A192GCM’, ‘A256GCM’, ‘A128KW’, ‘A192KW’, ‘A256KW’, ‘A128CBC’, ‘A192CBC’, ‘A256CBC’, ‘A128CBCPAD’, ‘A192CBCPAD’, ‘A256CBCPAD’ authenticated crypto algorithms. authenticated algorithm. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • key_version (String)

    The version of the key.

  • algorithm (JsonWebKeyEncryptionAlgorithm)

    algorithm identifier.

  • value
  • iv (defaults to: nil)

    Initialization vector for symmetric algorithms.

  • aad (defaults to: nil)

    Additional data to authenticate but not encrypt/decrypt when using

  • tag (defaults to: nil)

    The tag to authenticate when performing decryption with an

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 5540

def unwrap_key_async(vault_base_url, key_name, key_version, algorithm, value, iv:nil, aad:nil, tag:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, 'key_version is nil' if key_version.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'algorithm is nil' if algorithm.nil?
  fail ArgumentError, "'algorithm' should satisfy the constraint - 'MinLength': '1'" if !algorithm.nil? && algorithm.length < 1
  fail ArgumentError, 'value is nil' if value.nil?

  parameters = KeyOperationsParameters.new
  unless algorithm.nil? && value.nil? && iv.nil? && aad.nil? && tag.nil?
    parameters.algorithm = algorithm
    parameters.value = value
    parameters.iv = iv
    parameters.aad = aad
    parameters.tag = tag
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::KeyOperationsParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'keys/{key-name}/{key-version}/unwrapkey'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'key-name' => key_name,'key-version' => key_version},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::KeyOperationResult.mapper()
        result.body = self.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

#unwrap_key_with_http_info(vault_base_url, key_name, key_version, algorithm, value, iv: nil, aad: nil, tag: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Unwraps a symmetric key using the specified key that was initially used for wrapping that key.

The UNWRAP operation supports decryption of a symmetric key using the target key encryption key. This operation is the reverse of the WRAP operation. The UNWRAP operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation requires the keys/unwrapKey permission.

myvault.vault.azure.net. Possible values include: ‘RSA-OAEP’, ‘RSA-OAEP-256’, ‘RSA1_5’, ‘A128GCM’, ‘A192GCM’, ‘A256GCM’, ‘A128KW’, ‘A192KW’, ‘A256KW’, ‘A128CBC’, ‘A192CBC’, ‘A256CBC’, ‘A128CBCPAD’, ‘A192CBCPAD’, ‘A256CBCPAD’ authenticated crypto algorithms. authenticated algorithm. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • key_version (String)

    The version of the key.

  • algorithm (JsonWebKeyEncryptionAlgorithm)

    algorithm identifier.

  • value
  • iv (defaults to: nil)

    Initialization vector for symmetric algorithms.

  • aad (defaults to: nil)

    Additional data to authenticate but not encrypt/decrypt when using

  • tag (defaults to: nil)

    The tag to authenticate when performing decryption with an

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



5507
5508
5509
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 5507

def unwrap_key_with_http_info(vault_base_url, key_name, key_version, algorithm, value, iv:nil, aad:nil, tag:nil, custom_headers:nil)
  unwrap_key_async(vault_base_url, key_name, key_version, algorithm, value, iv:iv, aad:aad, tag:tag, custom_headers:custom_headers).value!
end

#update_certificate(vault_base_url, certificate_name, certificate_version, certificate_policy: nil, certificate_attributes: nil, tags: nil, custom_headers: nil) ⇒ CertificateBundle

Updates the specified attributes associated with the given certificate.

The UpdateCertificate operation applies the specified update on the given certificate; the only elements updated are the certificate’s attributes. This operation requires the certificates/update permission.

myvault.vault.azure.net. vault. certificate. certificate (optional). form of key-value pairs. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate in the given key

  • certificate_version (String)

    The version of the certificate.

  • certificate_policy (CertificatePolicy) (defaults to: nil)

    The management policy for the

  • certificate_attributes (CertificateAttributes) (defaults to: nil)

    The attributes of the

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

    Application specific metadata in the

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

    A hash of custom headers that

Returns:

  • (CertificateBundle)

    operation results.



1956
1957
1958
1959
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1956

def update_certificate(vault_base_url, certificate_name, certificate_version, certificate_policy:nil, certificate_attributes:nil, tags:nil, custom_headers:nil)
  response = update_certificate_async(vault_base_url, certificate_name, certificate_version, certificate_policy:certificate_policy, certificate_attributes:certificate_attributes, tags:tags, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_certificate_async(vault_base_url, certificate_name, certificate_version, certificate_policy: nil, certificate_attributes: nil, tags: nil, custom_headers: nil) ⇒ Concurrent::Promise

Updates the specified attributes associated with the given certificate.

The UpdateCertificate operation applies the specified update on the given certificate; the only elements updated are the certificate’s attributes. This operation requires the certificates/update permission.

myvault.vault.azure.net. vault. certificate. certificate (optional). form of key-value pairs. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate in the given key

  • certificate_version (String)

    The version of the certificate.

  • certificate_policy (CertificatePolicy) (defaults to: nil)

    The management policy for the

  • certificate_attributes (CertificateAttributes) (defaults to: nil)

    The attributes of the

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

    Application specific metadata in the

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2011

def update_certificate_async(vault_base_url, certificate_name, certificate_version, certificate_policy:nil, certificate_attributes:nil, tags:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'certificate_name is nil' if certificate_name.nil?
  fail ArgumentError, 'certificate_version is nil' if certificate_version.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?

  parameters = CertificateUpdateParameters.new
  unless certificate_policy.nil? && certificate_attributes.nil? && tags.nil?
    parameters.CertificatePolicy = certificate_policy
    parameters.CertificateAttributes = certificate_attributes
    parameters.tags = tags
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::CertificateUpdateParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'certificates/{certificate-name}/{certificate-version}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'certificate-name' => certificate_name,'certificate-version' => certificate_version},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:patch, 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::CertificateBundle.mapper()
        result.body = self.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

#update_certificate_issuer(vault_base_url, issuer_name, provider: nil, credentials: nil, organization_details: nil, attributes: nil, custom_headers: nil) ⇒ IssuerBundle

Updates the specified certificate issuer.

The UpdateCertificateIssuer operation performs an update on the specified certificate issuer entity. This operation requires the certificates/setissuers permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • issuer_name (String)

    The name of the issuer.

  • provider (String) (defaults to: nil)

    The issuer provider.

  • credentials (IssuerCredentials) (defaults to: nil)

    The credentials to be used for the

  • organization_details (OrganizationDetails) (defaults to: nil)

    Details of the organization

  • attributes (IssuerAttributes) (defaults to: nil)

    Attributes of the issuer object.

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

    A hash of custom headers that

Returns:

  • (IssuerBundle)

    operation results.



943
944
945
946
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 943

def update_certificate_issuer(vault_base_url, issuer_name, provider:nil, credentials:nil, organization_details:nil, attributes:nil, custom_headers:nil)
  response = update_certificate_issuer_async(vault_base_url, issuer_name, provider:provider, credentials:credentials, organization_details:organization_details, attributes:attributes, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_certificate_issuer_async(vault_base_url, issuer_name, provider: nil, credentials: nil, organization_details: nil, attributes: nil, custom_headers: nil) ⇒ Concurrent::Promise

Updates the specified certificate issuer.

The UpdateCertificateIssuer operation performs an update on the specified certificate issuer entity. This operation requires the certificates/setissuers permission.

myvault.vault.azure.net. issuer. as provided to the issuer. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • issuer_name (String)

    The name of the issuer.

  • provider (String) (defaults to: nil)

    The issuer provider.

  • credentials (IssuerCredentials) (defaults to: nil)

    The credentials to be used for the

  • organization_details (OrganizationDetails) (defaults to: nil)

    Details of the organization

  • attributes (IssuerAttributes) (defaults to: nil)

    Attributes of the issuer object.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 994

def update_certificate_issuer_async(vault_base_url, issuer_name, provider:nil, credentials:nil, organization_details:nil, attributes:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'issuer_name is nil' if issuer_name.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?

  parameter = CertificateIssuerUpdateParameters.new
  unless provider.nil? && credentials.nil? && organization_details.nil? && attributes.nil?
    parameter.provider = provider
    parameter.credentials = credentials
    parameter.OrganizationDetails = organization_details
    parameter.attributes = attributes
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::CertificateIssuerUpdateParameters.mapper()
  request_content = self.serialize(request_mapper,  parameter)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'certificates/issuers/{issuer-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'issuer-name' => issuer_name},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:patch, 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::IssuerBundle.mapper()
        result.body = self.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

#update_certificate_issuer_with_http_info(vault_base_url, issuer_name, provider: nil, credentials: nil, organization_details: nil, attributes: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Updates the specified certificate issuer.

The UpdateCertificateIssuer operation performs an update on the specified certificate issuer entity. This operation requires the certificates/setissuers permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • issuer_name (String)

    The name of the issuer.

  • provider (String) (defaults to: nil)

    The issuer provider.

  • credentials (IssuerCredentials) (defaults to: nil)

    The credentials to be used for the

  • organization_details (OrganizationDetails) (defaults to: nil)

    Details of the organization

  • attributes (IssuerAttributes) (defaults to: nil)

    Attributes of the issuer object.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



969
970
971
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 969

def update_certificate_issuer_with_http_info(vault_base_url, issuer_name, provider:nil, credentials:nil, organization_details:nil, attributes:nil, custom_headers:nil)
  update_certificate_issuer_async(vault_base_url, issuer_name, provider:provider, credentials:credentials, organization_details:organization_details, attributes:attributes, custom_headers:custom_headers).value!
end

#update_certificate_operation(vault_base_url, certificate_name, cancellation_requested, custom_headers: nil) ⇒ CertificateOperation

Updates a certificate operation.

Updates a certificate creation operation that is already in progress. This operation requires the certificates/update permission.

myvault.vault.azure.net. requested on the certificate operation. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

  • cancellation_requested (Boolean)

    Indicates if cancellation was

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

    A hash of custom headers that

Returns:

  • (CertificateOperation)

    operation results.



2215
2216
2217
2218
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2215

def update_certificate_operation(vault_base_url, certificate_name, cancellation_requested, custom_headers:nil)
  response = update_certificate_operation_async(vault_base_url, certificate_name, cancellation_requested, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_certificate_operation_async(vault_base_url, certificate_name, cancellation_requested, custom_headers: nil) ⇒ Concurrent::Promise

Updates a certificate operation.

Updates a certificate creation operation that is already in progress. This operation requires the certificates/update permission.

myvault.vault.azure.net. requested on the certificate operation. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

  • cancellation_requested (Boolean)

    Indicates if cancellation was

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2256

def update_certificate_operation_async(vault_base_url, certificate_name, cancellation_requested, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'certificate_name is nil' if certificate_name.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'cancellation_requested is nil' if cancellation_requested.nil?

  certificate_operation = CertificateOperationUpdateParameter.new
  unless cancellation_requested.nil?
    certificate_operation.cancellation_requested = cancellation_requested
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::CertificateOperationUpdateParameter.mapper()
  request_content = self.serialize(request_mapper,  certificate_operation)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'certificates/{certificate-name}/pending'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'certificate-name' => certificate_name},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:patch, 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::CertificateOperation.mapper()
        result.body = self.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

#update_certificate_operation_with_http_info(vault_base_url, certificate_name, cancellation_requested, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Updates a certificate operation.

Updates a certificate creation operation that is already in progress. This operation requires the certificates/update permission.

myvault.vault.azure.net. requested on the certificate operation. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate.

  • cancellation_requested (Boolean)

    Indicates if cancellation was

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



2236
2237
2238
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 2236

def update_certificate_operation_with_http_info(vault_base_url, certificate_name, cancellation_requested, custom_headers:nil)
  update_certificate_operation_async(vault_base_url, certificate_name, cancellation_requested, custom_headers:custom_headers).value!
end

#update_certificate_policy(vault_base_url, certificate_name, certificate_policy, custom_headers: nil) ⇒ CertificatePolicy

Updates the policy for a certificate.

Set specified members in the certificate policy. Leave others as null. This operation requires the certificates/update permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate in the given

  • certificate_policy (CertificatePolicy)

    The policy for the certificate.

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

    A hash of custom headers that

Returns:

  • (CertificatePolicy)

    operation results.



1829
1830
1831
1832
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1829

def update_certificate_policy(vault_base_url, certificate_name, certificate_policy, custom_headers:nil)
  response = update_certificate_policy_async(vault_base_url, certificate_name, certificate_policy, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_certificate_policy_async(vault_base_url, certificate_name, certificate_policy, custom_headers: nil) ⇒ Concurrent::Promise

Updates the policy for a certificate.

Set specified members in the certificate policy. Leave others as null. This operation requires the certificates/update permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate in the given

  • certificate_policy (CertificatePolicy)

    The policy for the certificate.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1870

def update_certificate_policy_async(vault_base_url, certificate_name, certificate_policy, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'certificate_name is nil' if certificate_name.nil?
  fail ArgumentError, 'certificate_policy is nil' if certificate_policy.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::CertificatePolicy.mapper()
  request_content = self.serialize(request_mapper,  certificate_policy)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'certificates/{certificate-name}/policy'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'certificate-name' => certificate_name},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:patch, 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::CertificatePolicy.mapper()
        result.body = self.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

#update_certificate_policy_with_http_info(vault_base_url, certificate_name, certificate_policy, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Updates the policy for a certificate.

Set specified members in the certificate policy. Leave others as null. This operation requires the certificates/update permission.

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

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate in the given

  • certificate_policy (CertificatePolicy)

    The policy for the certificate.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1850
1851
1852
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1850

def update_certificate_policy_with_http_info(vault_base_url, certificate_name, certificate_policy, custom_headers:nil)
  update_certificate_policy_async(vault_base_url, certificate_name, certificate_policy, custom_headers:custom_headers).value!
end

#update_certificate_with_http_info(vault_base_url, certificate_name, certificate_version, certificate_policy: nil, certificate_attributes: nil, tags: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Updates the specified attributes associated with the given certificate.

The UpdateCertificate operation applies the specified update on the given certificate; the only elements updated are the certificate’s attributes. This operation requires the certificates/update permission.

myvault.vault.azure.net. vault. certificate. certificate (optional). form of key-value pairs. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • certificate_name (String)

    The name of the certificate in the given key

  • certificate_version (String)

    The version of the certificate.

  • certificate_policy (CertificatePolicy) (defaults to: nil)

    The management policy for the

  • certificate_attributes (CertificateAttributes) (defaults to: nil)

    The attributes of the

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

    Application specific metadata in the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1984
1985
1986
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 1984

def update_certificate_with_http_info(vault_base_url, certificate_name, certificate_version, certificate_policy:nil, certificate_attributes:nil, tags:nil, custom_headers:nil)
  update_certificate_async(vault_base_url, certificate_name, certificate_version, certificate_policy:certificate_policy, certificate_attributes:certificate_attributes, tags:tags, custom_headers:custom_headers).value!
end

#update_key(vault_base_url, key_name, key_version, key_ops: nil, key_attributes: nil, tags: nil, release_policy: nil, custom_headers: nil) ⇒ KeyBundle

The update key operation changes specified attributes of a stored key and can be applied to any key type and key version stored in Azure Key Vault.

In order to perform this operation, the key must already exist in the Key Vault. Note: The cryptographic material of a key itself cannot be changed. This operation requires the keys/update permission.

myvault.vault.azure.net. information on possible key operations, see JsonWebKeyOperation. form of key-value pairs. can be exported. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of key to update.

  • key_version (String)

    The version of the key to update.

  • key_ops (Array<JsonWebKeyOperation>) (defaults to: nil)

    Json web key operations. For more

  • key_attributes (KeyAttributes) (defaults to: nil)
  • tags (Hash{String => String}) (defaults to: nil)

    Application specific metadata in the

  • release_policy (KeyReleasePolicy) (defaults to: nil)

    The policy rules under which the key

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

    A hash of custom headers that

Returns:

  • (KeyBundle)

    operation results.



3841
3842
3843
3844
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 3841

def update_key(vault_base_url, key_name, key_version, key_ops:nil, key_attributes:nil, tags:nil, release_policy:nil, custom_headers:nil)
  response = update_key_async(vault_base_url, key_name, key_version, key_ops:key_ops, key_attributes:key_attributes, tags:tags, release_policy:release_policy, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_key_async(vault_base_url, key_name, key_version, key_ops: nil, key_attributes: nil, tags: nil, release_policy: nil, custom_headers: nil) ⇒ Concurrent::Promise

The update key operation changes specified attributes of a stored key and can be applied to any key type and key version stored in Azure Key Vault.

In order to perform this operation, the key must already exist in the Key Vault. Note: The cryptographic material of a key itself cannot be changed. This operation requires the keys/update permission.

myvault.vault.azure.net. information on possible key operations, see JsonWebKeyOperation. form of key-value pairs. can be exported. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of key to update.

  • key_version (String)

    The version of the key to update.

  • key_ops (Array<JsonWebKeyOperation>) (defaults to: nil)

    Json web key operations. For more

  • key_attributes (KeyAttributes) (defaults to: nil)
  • tags (Hash{String => String}) (defaults to: nil)

    Application specific metadata in the

  • release_policy (KeyReleasePolicy) (defaults to: nil)

    The policy rules under which the key

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 3898

def update_key_async(vault_base_url, key_name, key_version, key_ops:nil, key_attributes:nil, tags:nil, release_policy:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, 'key_version is nil' if key_version.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?

  parameters = KeyUpdateParameters.new
  unless key_ops.nil? && key_attributes.nil? && tags.nil? && release_policy.nil?
    parameters.key_ops = key_ops
    parameters.keyAttributes = key_attributes
    parameters.tags = tags
    parameters.release_policy = release_policy
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::KeyUpdateParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'keys/{key-name}/{key-version}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'key-name' => key_name,'key-version' => key_version},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:patch, 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::KeyBundle.mapper()
        result.body = self.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

#update_key_with_http_info(vault_base_url, key_name, key_version, key_ops: nil, key_attributes: nil, tags: nil, release_policy: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

The update key operation changes specified attributes of a stored key and can be applied to any key type and key version stored in Azure Key Vault.

In order to perform this operation, the key must already exist in the Key Vault. Note: The cryptographic material of a key itself cannot be changed. This operation requires the keys/update permission.

myvault.vault.azure.net. information on possible key operations, see JsonWebKeyOperation. form of key-value pairs. can be exported. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of key to update.

  • key_version (String)

    The version of the key to update.

  • key_ops (Array<JsonWebKeyOperation>) (defaults to: nil)

    Json web key operations. For more

  • key_attributes (KeyAttributes) (defaults to: nil)
  • tags (Hash{String => String}) (defaults to: nil)

    Application specific metadata in the

  • release_policy (KeyReleasePolicy) (defaults to: nil)

    The policy rules under which the key

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



3870
3871
3872
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 3870

def update_key_with_http_info(vault_base_url, key_name, key_version, key_ops:nil, key_attributes:nil, tags:nil, release_policy:nil, custom_headers:nil)
  update_key_async(vault_base_url, key_name, key_version, key_ops:key_ops, key_attributes:key_attributes, tags:tags, release_policy:release_policy, custom_headers:custom_headers).value!
end

#update_sas_definition(vault_base_url, storage_account_name, sas_definition_name, template_uri: nil, sas_type: nil, validity_period: nil, sas_definition_attributes: nil, tags: nil, custom_headers: nil) ⇒ SasDefinitionBundle

Updates the specified attributes associated with the given SAS definition. This operation requires the storage/setsas permission.

myvault.vault.azure.net. arbitrary key. Tokens created according to the SAS definition will have the same properties as the template. create. Possible values include: ‘account’, ‘service’ according to the SAS definition. the SAS definition. form of key-value pairs. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • sas_definition_name (String)

    The name of the SAS definition.

  • template_uri (String) (defaults to: nil)

    The SAS definition token template signed with an

  • sas_type (SasTokenType) (defaults to: nil)

    The type of SAS token the SAS definition will

  • validity_period (String) (defaults to: nil)

    The validity period of SAS tokens created

  • sas_definition_attributes (SasDefinitionAttributes) (defaults to: nil)

    The attributes of

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

    Application specific metadata in the

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

    A hash of custom headers that

Returns:

  • (SasDefinitionBundle)

    operation results.



9806
9807
9808
9809
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9806

def update_sas_definition(vault_base_url, , sas_definition_name, template_uri:nil, sas_type:nil, validity_period:nil, sas_definition_attributes:nil, tags:nil, custom_headers:nil)
  response = update_sas_definition_async(vault_base_url, , sas_definition_name, template_uri:template_uri, sas_type:sas_type, validity_period:validity_period, sas_definition_attributes:sas_definition_attributes, tags:tags, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_sas_definition_async(vault_base_url, storage_account_name, sas_definition_name, template_uri: nil, sas_type: nil, validity_period: nil, sas_definition_attributes: nil, tags: nil, custom_headers: nil) ⇒ Concurrent::Promise

Updates the specified attributes associated with the given SAS definition. This operation requires the storage/setsas permission.

myvault.vault.azure.net. arbitrary key. Tokens created according to the SAS definition will have the same properties as the template. create. Possible values include: ‘account’, ‘service’ according to the SAS definition. the SAS definition. form of key-value pairs. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • sas_definition_name (String)

    The name of the SAS definition.

  • template_uri (String) (defaults to: nil)

    The SAS definition token template signed with an

  • sas_type (SasTokenType) (defaults to: nil)

    The type of SAS token the SAS definition will

  • validity_period (String) (defaults to: nil)

    The validity period of SAS tokens created

  • sas_definition_attributes (SasDefinitionAttributes) (defaults to: nil)

    The attributes of

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

    Application specific metadata in the

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9863

def update_sas_definition_async(vault_base_url, , sas_definition_name, template_uri:nil, sas_type:nil, validity_period:nil, sas_definition_attributes:nil, tags:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'storage_account_name is nil' if .nil?
  fail ArgumentError, "'storage_account_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !.nil? && .match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, 'sas_definition_name is nil' if sas_definition_name.nil?
  fail ArgumentError, "'sas_definition_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !sas_definition_name.nil? && sas_definition_name.match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?

  parameters = SasDefinitionUpdateParameters.new
  unless template_uri.nil? && sas_type.nil? && validity_period.nil? && sas_definition_attributes.nil? && tags.nil?
    parameters.template_uri = template_uri
    parameters.sas_type = sas_type
    parameters.validity_period = validity_period
    parameters.SasDefinitionAttributes = sas_definition_attributes
    parameters.tags = tags
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::SasDefinitionUpdateParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'storage/{storage-account-name}/sas/{sas-definition-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'storage-account-name' => ,'sas-definition-name' => sas_definition_name},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:patch, 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::SasDefinitionBundle.mapper()
        result.body = self.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

#update_sas_definition_with_http_info(vault_base_url, storage_account_name, sas_definition_name, template_uri: nil, sas_type: nil, validity_period: nil, sas_definition_attributes: nil, tags: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Updates the specified attributes associated with the given SAS definition. This operation requires the storage/setsas permission.

myvault.vault.azure.net. arbitrary key. Tokens created according to the SAS definition will have the same properties as the template. create. Possible values include: ‘account’, ‘service’ according to the SAS definition. the SAS definition. form of key-value pairs. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • sas_definition_name (String)

    The name of the SAS definition.

  • template_uri (String) (defaults to: nil)

    The SAS definition token template signed with an

  • sas_type (SasTokenType) (defaults to: nil)

    The type of SAS token the SAS definition will

  • validity_period (String) (defaults to: nil)

    The validity period of SAS tokens created

  • sas_definition_attributes (SasDefinitionAttributes) (defaults to: nil)

    The attributes of

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

    Application specific metadata in the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



9835
9836
9837
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 9835

def update_sas_definition_with_http_info(vault_base_url, , sas_definition_name, template_uri:nil, sas_type:nil, validity_period:nil, sas_definition_attributes:nil, tags:nil, custom_headers:nil)
  update_sas_definition_async(vault_base_url, , sas_definition_name, template_uri:template_uri, sas_type:sas_type, validity_period:validity_period, sas_definition_attributes:sas_definition_attributes, tags:tags, custom_headers:custom_headers).value!
end

#update_secret(vault_base_url, secret_name, secret_version, content_type: nil, secret_attributes: nil, tags: nil, custom_headers: nil) ⇒ SecretBundle

Updates the attributes associated with a specified secret in a given key vault.

The UPDATE operation changes specified attributes of an existing stored secret. Attributes that are not specified in the request are left unchanged. The value of a secret itself cannot be changed. This operation requires the secrets/set permission.

myvault.vault.azure.net. form of key-value pairs. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

  • secret_version (String)

    The version of the secret.

  • content_type (String) (defaults to: nil)

    Type of the secret value such as a password.

  • secret_attributes (SecretAttributes) (defaults to: nil)

    The secret management attributes.

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

    Application specific metadata in the

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

    A hash of custom headers that

Returns:

  • (SecretBundle)

    operation results.



6463
6464
6465
6466
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6463

def update_secret(vault_base_url, secret_name, secret_version, content_type:nil, secret_attributes:nil, tags:nil, custom_headers:nil)
  response = update_secret_async(vault_base_url, secret_name, secret_version, content_type:content_type, secret_attributes:secret_attributes, tags:tags, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_secret_async(vault_base_url, secret_name, secret_version, content_type: nil, secret_attributes: nil, tags: nil, custom_headers: nil) ⇒ Concurrent::Promise

Updates the attributes associated with a specified secret in a given key vault.

The UPDATE operation changes specified attributes of an existing stored secret. Attributes that are not specified in the request are left unchanged. The value of a secret itself cannot be changed. This operation requires the secrets/set permission.

myvault.vault.azure.net. form of key-value pairs. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

  • secret_version (String)

    The version of the secret.

  • content_type (String) (defaults to: nil)

    Type of the secret value such as a password.

  • secret_attributes (SecretAttributes) (defaults to: nil)

    The secret management attributes.

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

    Application specific metadata in the

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6516

def update_secret_async(vault_base_url, secret_name, secret_version, content_type:nil, secret_attributes:nil, tags:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'secret_name is nil' if secret_name.nil?
  fail ArgumentError, 'secret_version is nil' if secret_version.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?

  parameters = SecretUpdateParameters.new
  unless content_type.nil? && secret_attributes.nil? && tags.nil?
    parameters.content_type = content_type
    parameters.secretAttributes = secret_attributes
    parameters.tags = tags
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::SecretUpdateParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'secrets/{secret-name}/{secret-version}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'secret-name' => secret_name,'secret-version' => secret_version},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:patch, 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::SecretBundle.mapper()
        result.body = self.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

#update_secret_with_http_info(vault_base_url, secret_name, secret_version, content_type: nil, secret_attributes: nil, tags: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Updates the attributes associated with a specified secret in a given key vault.

The UPDATE operation changes specified attributes of an existing stored secret. Attributes that are not specified in the request are left unchanged. The value of a secret itself cannot be changed. This operation requires the secrets/set permission.

myvault.vault.azure.net. form of key-value pairs. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • secret_name (String)

    The name of the secret.

  • secret_version (String)

    The version of the secret.

  • content_type (String) (defaults to: nil)

    Type of the secret value such as a password.

  • secret_attributes (SecretAttributes) (defaults to: nil)

    The secret management attributes.

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

    Application specific metadata in the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



6490
6491
6492
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 6490

def update_secret_with_http_info(vault_base_url, secret_name, secret_version, content_type:nil, secret_attributes:nil, tags:nil, custom_headers:nil)
  update_secret_async(vault_base_url, secret_name, secret_version, content_type:content_type, secret_attributes:secret_attributes, tags:tags, custom_headers:custom_headers).value!
end

#update_storage_account(vault_base_url, storage_account_name, active_key_name: nil, auto_regenerate_key: nil, regeneration_period: nil, storage_account_attributes: nil, tags: nil, custom_headers: nil) ⇒ StorageBundle

Updates the specified attributes associated with the given storage account. This operation requires the storage/set/update permission.

myvault.vault.azure.net. storage account for the user. specified in ISO-8601 format. of the storage account. form of key-value pairs. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • active_key_name (String) (defaults to: nil)

    The current active storage account key name.

  • auto_regenerate_key (Boolean) (defaults to: nil)

    whether keyvault should manage the

  • regeneration_period (String) (defaults to: nil)

    The key regeneration time duration

  • storage_account_attributes (StorageAccountAttributes) (defaults to: nil)

    The attributes

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

    Application specific metadata in the

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

    A hash of custom headers that

Returns:

  • (StorageBundle)

    operation results.



8718
8719
8720
8721
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8718

def (vault_base_url, , active_key_name:nil, auto_regenerate_key:nil, regeneration_period:nil, storage_account_attributes:nil, tags:nil, custom_headers:nil)
  response = (vault_base_url, , active_key_name:active_key_name, auto_regenerate_key:auto_regenerate_key, regeneration_period:regeneration_period, storage_account_attributes:, tags:tags, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_storage_account_async(vault_base_url, storage_account_name, active_key_name: nil, auto_regenerate_key: nil, regeneration_period: nil, storage_account_attributes: nil, tags: nil, custom_headers: nil) ⇒ Concurrent::Promise

Updates the specified attributes associated with the given storage account. This operation requires the storage/set/update permission.

myvault.vault.azure.net. storage account for the user. specified in ISO-8601 format. of the storage account. form of key-value pairs. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • active_key_name (String) (defaults to: nil)

    The current active storage account key name.

  • auto_regenerate_key (Boolean) (defaults to: nil)

    whether keyvault should manage the

  • regeneration_period (String) (defaults to: nil)

    The key regeneration time duration

  • storage_account_attributes (StorageAccountAttributes) (defaults to: nil)

    The attributes

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

    Application specific metadata in the

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8769

def (vault_base_url, , active_key_name:nil, auto_regenerate_key:nil, regeneration_period:nil, storage_account_attributes:nil, tags:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'storage_account_name is nil' if .nil?
  fail ArgumentError, "'storage_account_name' should satisfy the constraint - 'Pattern': '^[0-9a-zA-Z]+$'" if !.nil? && .match(Regexp.new('^^[0-9a-zA-Z]+$$')).nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?

  parameters = StorageAccountUpdateParameters.new
  unless active_key_name.nil? && auto_regenerate_key.nil? && regeneration_period.nil? && .nil? && tags.nil?
    parameters.active_key_name = active_key_name
    parameters.auto_regenerate_key = auto_regenerate_key
    parameters.regeneration_period = regeneration_period
    parameters.StorageAccountAttributes = 
    parameters.tags = tags
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::StorageAccountUpdateParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'storage/{storage-account-name}'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'storage-account-name' => },
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:patch, 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::StorageBundle.mapper()
        result.body = self.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

#update_storage_account_with_http_info(vault_base_url, storage_account_name, active_key_name: nil, auto_regenerate_key: nil, regeneration_period: nil, storage_account_attributes: nil, tags: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Updates the specified attributes associated with the given storage account. This operation requires the storage/set/update permission.

myvault.vault.azure.net. storage account for the user. specified in ISO-8601 format. of the storage account. form of key-value pairs. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • storage_account_name (String)

    The name of the storage account.

  • active_key_name (String) (defaults to: nil)

    The current active storage account key name.

  • auto_regenerate_key (Boolean) (defaults to: nil)

    whether keyvault should manage the

  • regeneration_period (String) (defaults to: nil)

    The key regeneration time duration

  • storage_account_attributes (StorageAccountAttributes) (defaults to: nil)

    The attributes

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

    Application specific metadata in the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



8744
8745
8746
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 8744

def (vault_base_url, , active_key_name:nil, auto_regenerate_key:nil, regeneration_period:nil, storage_account_attributes:nil, tags:nil, custom_headers:nil)
  (vault_base_url, , active_key_name:active_key_name, auto_regenerate_key:auto_regenerate_key, regeneration_period:regeneration_period, storage_account_attributes:, tags:tags, custom_headers:custom_headers).value!
end

#verify(vault_base_url, key_name, key_version, algorithm, digest, signature, custom_headers: nil) ⇒ KeyVerifyResult

Verifies a signature using a specified key.

The VERIFY operation is applicable to symmetric keys stored in Azure Key Vault. VERIFY is not strictly necessary for asymmetric keys stored in Azure Key Vault since signature verification can be performed using the public portion of the key but this operation is supported as a convenience for callers that only have a key-reference and not the public portion of the key. This operation requires the keys/verify permission.

myvault.vault.azure.net. algorithm. For more information on possible algorithm types, see JsonWebKeySignatureAlgorithm. Possible values include: ‘PS256’, ‘PS384’, ‘PS512’, ‘RS256’, ‘RS384’, ‘RS512’, ‘RSNULL’, ‘ES256’, ‘ES384’, ‘ES512’, ‘ES256K’ will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • key_version (String)

    The version of the key.

  • algorithm (JsonWebKeySignatureAlgorithm)

    The signing/verification

  • digest

    The digest used for signing.

  • signature

    The signature to be verified.

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

    A hash of custom headers that

Returns:

  • (KeyVerifyResult)

    operation results.



5137
5138
5139
5140
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 5137

def verify(vault_base_url, key_name, key_version, algorithm, digest, signature, custom_headers:nil)
  response = verify_async(vault_base_url, key_name, key_version, algorithm, digest, signature, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#verify_async(vault_base_url, key_name, key_version, algorithm, digest, signature, custom_headers: nil) ⇒ Concurrent::Promise

Verifies a signature using a specified key.

The VERIFY operation is applicable to symmetric keys stored in Azure Key Vault. VERIFY is not strictly necessary for asymmetric keys stored in Azure Key Vault since signature verification can be performed using the public portion of the key but this operation is supported as a convenience for callers that only have a key-reference and not the public portion of the key. This operation requires the keys/verify permission.

myvault.vault.azure.net. algorithm. For more information on possible algorithm types, see JsonWebKeySignatureAlgorithm. Possible values include: ‘PS256’, ‘PS384’, ‘PS512’, ‘RS256’, ‘RS384’, ‘RS512’, ‘RSNULL’, ‘ES256’, ‘ES384’, ‘ES512’, ‘ES256K’ to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • key_version (String)

    The version of the key.

  • algorithm (JsonWebKeySignatureAlgorithm)

    The signing/verification

  • digest

    The digest used for signing.

  • signature

    The signature to be verified.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 5198

def verify_async(vault_base_url, key_name, key_version, algorithm, digest, signature, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, 'key_version is nil' if key_version.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'algorithm is nil' if algorithm.nil?
  fail ArgumentError, "'algorithm' should satisfy the constraint - 'MinLength': '1'" if !algorithm.nil? && algorithm.length < 1
  fail ArgumentError, 'digest is nil' if digest.nil?
  fail ArgumentError, 'signature is nil' if signature.nil?

  parameters = KeyVerifyParameters.new
  unless algorithm.nil? && digest.nil? && signature.nil?
    parameters.algorithm = algorithm
    parameters.digest = digest
    parameters.signature = signature
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::KeyVerifyParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'keys/{key-name}/{key-version}/verify'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'key-name' => key_name,'key-version' => key_version},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::KeyVerifyResult.mapper()
        result.body = self.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

#verify_with_http_info(vault_base_url, key_name, key_version, algorithm, digest, signature, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Verifies a signature using a specified key.

The VERIFY operation is applicable to symmetric keys stored in Azure Key Vault. VERIFY is not strictly necessary for asymmetric keys stored in Azure Key Vault since signature verification can be performed using the public portion of the key but this operation is supported as a convenience for callers that only have a key-reference and not the public portion of the key. This operation requires the keys/verify permission.

myvault.vault.azure.net. algorithm. For more information on possible algorithm types, see JsonWebKeySignatureAlgorithm. Possible values include: ‘PS256’, ‘PS384’, ‘PS512’, ‘RS256’, ‘RS384’, ‘RS512’, ‘RSNULL’, ‘ES256’, ‘ES384’, ‘ES512’, ‘ES256K’ will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • key_version (String)

    The version of the key.

  • algorithm (JsonWebKeySignatureAlgorithm)

    The signing/verification

  • digest

    The digest used for signing.

  • signature

    The signature to be verified.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



5168
5169
5170
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 5168

def verify_with_http_info(vault_base_url, key_name, key_version, algorithm, digest, signature, custom_headers:nil)
  verify_async(vault_base_url, key_name, key_version, algorithm, digest, signature, custom_headers:custom_headers).value!
end

#wrap_key(vault_base_url, key_name, key_version, algorithm, value, iv: nil, aad: nil, tag: nil, custom_headers: nil) ⇒ KeyOperationResult

Wraps a symmetric key using a specified key.

The WRAP operation supports encryption of a symmetric key using a key encryption key that has previously been stored in an Azure Key Vault. The WRAP operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using the public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/wrapKey permission.

myvault.vault.azure.net. Possible values include: ‘RSA-OAEP’, ‘RSA-OAEP-256’, ‘RSA1_5’, ‘A128GCM’, ‘A192GCM’, ‘A256GCM’, ‘A128KW’, ‘A192KW’, ‘A256KW’, ‘A128CBC’, ‘A192CBC’, ‘A256CBC’, ‘A128CBCPAD’, ‘A192CBCPAD’, ‘A256CBCPAD’ authenticated crypto algorithms. authenticated algorithm. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • key_version (String)

    The version of the key.

  • algorithm (JsonWebKeyEncryptionAlgorithm)

    algorithm identifier.

  • value
  • iv (defaults to: nil)

    Initialization vector for symmetric algorithms.

  • aad (defaults to: nil)

    Additional data to authenticate but not encrypt/decrypt when using

  • tag (defaults to: nil)

    The tag to authenticate when performing decryption with an

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

    A hash of custom headers that

Returns:

  • (KeyOperationResult)

    operation results.



5301
5302
5303
5304
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 5301

def wrap_key(vault_base_url, key_name, key_version, algorithm, value, iv:nil, aad:nil, tag:nil, custom_headers:nil)
  response = wrap_key_async(vault_base_url, key_name, key_version, algorithm, value, iv:iv, aad:aad, tag:tag, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#wrap_key_async(vault_base_url, key_name, key_version, algorithm, value, iv: nil, aad: nil, tag: nil, custom_headers: nil) ⇒ Concurrent::Promise

Wraps a symmetric key using a specified key.

The WRAP operation supports encryption of a symmetric key using a key encryption key that has previously been stored in an Azure Key Vault. The WRAP operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using the public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/wrapKey permission.

myvault.vault.azure.net. Possible values include: ‘RSA-OAEP’, ‘RSA-OAEP-256’, ‘RSA1_5’, ‘A128GCM’, ‘A192GCM’, ‘A256GCM’, ‘A128KW’, ‘A192KW’, ‘A256KW’, ‘A128CBC’, ‘A192CBC’, ‘A256CBC’, ‘A128CBCPAD’, ‘A192CBCPAD’, ‘A256CBCPAD’ authenticated crypto algorithms. authenticated algorithm. to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • key_version (String)

    The version of the key.

  • algorithm (JsonWebKeyEncryptionAlgorithm)

    algorithm identifier.

  • value
  • iv (defaults to: nil)

    Initialization vector for symmetric algorithms.

  • aad (defaults to: nil)

    Additional data to authenticate but not encrypt/decrypt when using

  • tag (defaults to: nil)

    The tag to authenticate when performing decryption with an

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 5370

def wrap_key_async(vault_base_url, key_name, key_version, algorithm, value, iv:nil, aad:nil, tag:nil, custom_headers:nil)
  fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, 'key_version is nil' if key_version.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'algorithm is nil' if algorithm.nil?
  fail ArgumentError, "'algorithm' should satisfy the constraint - 'MinLength': '1'" if !algorithm.nil? && algorithm.length < 1
  fail ArgumentError, 'value is nil' if value.nil?

  parameters = KeyOperationsParameters.new
  unless algorithm.nil? && value.nil? && iv.nil? && aad.nil? && tag.nil?
    parameters.algorithm = algorithm
    parameters.value = value
    parameters.iv = iv
    parameters.aad = aad
    parameters.tag = tag
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::KeyVault::V7_2_preview::Models::KeyOperationsParameters.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'keys/{key-name}/{key-version}/wrapkey'

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

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'key-name' => key_name,'key-version' => key_version},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::KeyOperationResult.mapper()
        result.body = self.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

#wrap_key_with_http_info(vault_base_url, key_name, key_version, algorithm, value, iv: nil, aad: nil, tag: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Wraps a symmetric key using a specified key.

The WRAP operation supports encryption of a symmetric key using a key encryption key that has previously been stored in an Azure Key Vault. The WRAP operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using the public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/wrapKey permission.

myvault.vault.azure.net. Possible values include: ‘RSA-OAEP’, ‘RSA-OAEP-256’, ‘RSA1_5’, ‘A128GCM’, ‘A192GCM’, ‘A256GCM’, ‘A128KW’, ‘A192KW’, ‘A256KW’, ‘A128CBC’, ‘A192CBC’, ‘A256CBC’, ‘A128CBCPAD’, ‘A192CBCPAD’, ‘A256CBCPAD’ authenticated crypto algorithms. authenticated algorithm. will be added to the HTTP request.

Parameters:

  • vault_base_url (String)

    The vault name, for example

  • key_name (String)

    The name of the key.

  • key_version (String)

    The version of the key.

  • algorithm (JsonWebKeyEncryptionAlgorithm)

    algorithm identifier.

  • value
  • iv (defaults to: nil)

    Initialization vector for symmetric algorithms.

  • aad (defaults to: nil)

    Additional data to authenticate but not encrypt/decrypt when using

  • tag (defaults to: nil)

    The tag to authenticate when performing decryption with an

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



5336
5337
5338
# File 'lib/7.2-preview/generated/azure_key_vault/key_vault_client.rb', line 5336

def wrap_key_with_http_info(vault_base_url, key_name, key_version, algorithm, value, iv:nil, aad:nil, tag:nil, custom_headers:nil)
  wrap_key_async(vault_base_url, key_name, key_version, algorithm, value, iv:iv, aad:aad, tag:tag, custom_headers:custom_headers).value!
end