Class: Azure::KeyVault::V7_1_preview::KeyVaultClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/7.1-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.



40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 40

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

  @api_version = '7.1-preview'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Instance Attribute Details

#accept_language ⇒ String

Returns The preferred language for the response.

Returns:

  • (String) —

    The preferred language for the response.



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

def accept_language
  @accept_language
end

#api_version ⇒ String (readonly)

Returns Client API version.

Returns:

  • (String) —

    Client API version.



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

def api_version
  @api_version
end

#base_url ⇒ String (readonly)

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



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

def base_url
  @base_url
end

#credentials ⇒ Object (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.1-preview/generated/azure_key_vault/key_vault_client.rb', line 18

def credentials
  @credentials
end

#generate_client_request_id ⇒ Boolean

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.1-preview/generated/azure_key_vault/key_vault_client.rb', line 33

def generate_client_request_id
  @generate_client_request_id
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



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

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
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.



2685
2686
2687
2688
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2685

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.



2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2724

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_1_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.



2705
2706
2707
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2705

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.



4307
4308
4309
4310
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 4307

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.



4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 4366

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_1_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.



4337
4338
4339
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 4337

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.



7111
7112
7113
7114
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7111

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.



7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7150

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_1_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.



7131
7132
7133
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7131

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.



7872
7873
7874
7875
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7872

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.



7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7909

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_1_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.



7891
7892
7893
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7891

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



1289
1290
1291
1292
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1289

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.



1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1338

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_1_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_1_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.



1314
1315
1316
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1314

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, key_ops: nil, key_attributes: nil, tags: nil, curve: 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’ 4096 for RSA. form of key-value pairs. JsonWebKeyCurveName. Possible values include: ‘P-256’, ‘P-384’, ‘P-521’, ‘P-256K’ 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

  • 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

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

    A hash of custom headers that

Returns:

  • (KeyBundle) —

    operation results.



3385
3386
3387
3388
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3385

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

#create_key_async(vault_base_url, key_name, kty, key_size: nil, key_ops: nil, key_attributes: nil, tags: nil, curve: 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’ 4096 for RSA. form of key-value pairs. JsonWebKeyCurveName. Possible values include: ‘P-256’, ‘P-384’, ‘P-521’, ‘P-256K’ 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

  • 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

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3452

def create_key_async(vault_base_url, key_name, kty, key_size:nil, key_ops:nil, key_attributes:nil, tags:nil, curve: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? && key_ops.nil? && key_attributes.nil? && tags.nil? && curve.nil?
    parameters.kty = kty
    parameters.key_size = key_size
    parameters.key_ops = key_ops
    parameters.keyAttributes = key_attributes
    parameters.tags = tags
    parameters.curve = curve
  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_1_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_1_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, key_ops: nil, key_attributes: nil, tags: nil, curve: 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’ 4096 for RSA. form of key-value pairs. JsonWebKeyCurveName. Possible values include: ‘P-256’, ‘P-384’, ‘P-521’, ‘P-256K’ 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

  • 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

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



3419
3420
3421
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3419

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

#decrypt(vault_base_url, key_name, key_version, algorithm, value, 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’ 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
  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (KeyOperationResult) —

    operation results.



4754
4755
4756
4757
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 4754

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

#decrypt_async(vault_base_url, key_name, key_version, algorithm, value, 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’ 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
  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 4809

def decrypt_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 = KeyOperationsParameters.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_1_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_1_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, 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’ 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
  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



4782
4783
4784
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 4782

def decrypt_with_http_info(vault_base_url, key_name, key_version, algorithm, value, custom_headers:nil)
  decrypt_async(vault_base_url, key_name, key_version, algorithm, value, 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.



246
247
248
249
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 246

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.



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 287

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_1_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.



571
572
573
574
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 571

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.



606
607
608
609
610
611
612
613
614
615
616
617
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 606

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_1_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.



589
590
591
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 589

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.



1175
1176
1177
1178
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1175

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.



1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1214

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_1_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.



1195
1196
1197
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1195

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.



2432
2433
2434
2435
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2432

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.



2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2471

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_1_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.



2452
2453
2454
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2452

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.



267
268
269
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 267

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.



3689
3690
3691
3692
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3689

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.



3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3732

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_1_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.



3711
3712
3713
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3711

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.



9164
9165
9166
9167
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9164

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.



9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9199

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_1_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.



9182
9183
9184
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9182

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.



6085
6086
6087
6088
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6085

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.



6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6124

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_1_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.



6105
6106
6107
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6105

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.



8095
8096
8097
8098
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8095

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.



8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8128

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_1_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.



8112
8113
8114
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8112

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, 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’ 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
  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (KeyOperationResult) —

    operation results.



4597
4598
4599
4600
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 4597

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

#encrypt_async(vault_base_url, key_name, key_version, algorithm, value, 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’ 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
  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 4660

def encrypt_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 = KeyOperationsParameters.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_1_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_1_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, 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’ 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
  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



4629
4630
4631
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 4629

def encrypt_with_http_info(vault_base_url, key_name, key_version, algorithm, value, custom_headers:nil)
  encrypt_async(vault_base_url, key_name, key_version, algorithm, value, 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.



2086
2087
2088
2089
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2086

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.



2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2131

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_1_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.



468
469
470
471
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 468

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.



505
506
507
508
509
510
511
512
513
514
515
516
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 505

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_1_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.



487
488
489
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 487

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.



1066
1067
1068
1069
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1066

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.



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1105

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_1_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.



1086
1087
1088
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1086

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.



675
676
677
678
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 675

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.



11237
11238
11239
11240
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11237

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.



11278
11279
11280
11281
11282
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11278

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_1_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.



11258
11259
11260
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11258

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.



716
717
718
719
720
721
722
723
724
725
726
727
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 716

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_1_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.



9790
9791
9792
9793
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9790

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.



9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9827

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_1_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.



9809
9810
9811
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9809

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.



696
697
698
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 696

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.



2325
2326
2327
2328
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2325

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.



2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2362

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_1_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.



2344
2345
2346
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2344

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.



1705
1706
1707
1708
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1705

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.



1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1746

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_1_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.



1726
1727
1728
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1726

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.



1589
1590
1591
1592
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1589

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.



11345
11346
11347
11348
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11345

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.



11388
11389
11390
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11388

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_1_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.



11367
11368
11369
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11367

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.



1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1632

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_1_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.



9892
9893
9894
9895
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9892

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.



9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9929

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_1_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.



9911
9912
9913
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9911

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.



1611
1612
1613
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1611

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.



2109
2110
2111
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2109

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.



130
131
132
133
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 130

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.



11126
11127
11128
11129
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11126

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.



11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11171

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_1_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.



11149
11150
11151
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11149

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.



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 175

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_1_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.



9688
9689
9690
9691
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9688

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.



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

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_1_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.



9707
9708
9709
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9707

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.



153
154
155
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 153

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.



3041
3042
3043
3044
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3041

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.



3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3082

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_1_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.



3062
3063
3064
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3062

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.



2919
2920
2921
2922
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2919

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.



11461
11462
11463
11464
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11461

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.



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
11552
11553
11554
11555
11556
11557
11558
11559
11560
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11512

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_1_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.



11487
11488
11489
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11487

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.



2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2970

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_1_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.



9997
9998
9999
10000
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9997

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.



10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10040

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_1_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.



10019
10020
10021
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10019

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.



2945
2946
2947
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2945

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.



5618
5619
5620
5621
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5618

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.



5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5659

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_1_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.



5639
5640
5641
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5639

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.



5500
5501
5502
5503
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5500

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.



11803
11804
11805
11806
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11803

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.



11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11850

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_1_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.



11827
11828
11829
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11827

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.



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

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_1_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.



10315
10316
10317
10318
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10315

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.



10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10358

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_1_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.



10337
10338
10339
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10337

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.



5524
5525
5526
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5524

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.



8937
8938
8939
8940
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8937

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.



8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8978

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_1_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.



8958
8959
8960
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8958

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.



8820
8821
8822
8823
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8820

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.



12555
12556
12557
12558
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 12555

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.



12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
12630
12631
12632
12633
12634
12635
12636
12637
12638
12639
12640
12641
12642
12643
12644
12645
12646
12647
12648
12649
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 12598

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_1_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.



12577
12578
12579
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 12577

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.



8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8863

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_1_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.



11020
11021
11022
11023
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11020

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.



11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11057

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_1_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.



11039
11040
11041
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11039

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.



8842
8843
8844
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8842

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.



6794
6795
6796
6797
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6794

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.



6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6831

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_1_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.



6813
6814
6815
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6813

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.



6684
6685
6686
6687
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6684

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.



12138
12139
12140
12141
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 12138

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.



12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
12190
12191
12192
12193
12194
12195
12196
12197
12198
12199
12200
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 12179

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_1_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.



12159
12160
12161
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 12159

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.



6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6725

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_1_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.



10630
10631
10632
10633
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10630

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.



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
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10667

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_1_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.



10649
10650
10651
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10649

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.



6705
6706
6707
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6705

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.



7551
7552
7553
7554
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7551

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.



7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7590

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_1_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.



7571
7572
7573
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7571

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.



7440
7441
7442
7443
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7440

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.



12343
12344
12345
12346
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 12343

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.



12384
12385
12386
12387
12388
12389
12390
12391
12392
12393
12394
12395
12396
12397
12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
12408
12409
12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 12384

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_1_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.



12364
12365
12366
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 12364

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.



7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7481

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_1_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.



10825
10826
10827
10828
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10825

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.



10862
10863
10864
10865
10866
10867
10868
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10862

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_1_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.



10844
10845
10846
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10844

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.



7461
7462
7463
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7461

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.



3949
3950
3951
3952
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3949

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.



3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3994

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_1_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.



4066
4067
4068
4069
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 4066

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.



11578
11579
11580
11581
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11578

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.



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
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11619

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_1_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.



11599
11600
11601
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11599

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.



4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 4107

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_1_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.



10104
10105
10106
10107
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10104

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.



10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10139

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_1_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.



10122
10123
10124
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10122

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.



4087
4088
4089
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 4087

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.



3972
3973
3974
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3972

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.



4182
4183
4184
4185
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 4182

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.



11689
11690
11691
11692
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11689

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.



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
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11734

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_1_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.



11712
11713
11714
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11712

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.



4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 4227

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_1_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.



10206
10207
10208
10209
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10206

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.



10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10247

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_1_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.



10227
10228
10229
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10227

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.



4205
4206
4207
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 4205

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.



9270
9271
9272
9273
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9270

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.



9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9305

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_1_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.



9288
9289
9290
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9288

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.



8708
8709
8710
8711
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8708

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.



12448
12449
12450
12451
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 12448

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.



12485
12486
12487
12488
12489
12490
12491
12492
12493
12494
12495
12496
12497
12498
12499
12500
12501
12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 12485

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_1_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.



12467
12468
12469
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 12467

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.



8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8745

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_1_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.



10924
10925
10926
10927
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10924

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.



10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10955

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_1_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.



10940
10941
10942
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10940

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.



8727
8728
8729
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8727

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.



6339
6340
6341
6342
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6339

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.



6380
6381
6382
6383
6384
6385
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6380

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_1_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.



6568
6569
6570
6571
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6568

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.



12027
12028
12029
12030
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 12027

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.



12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
12082
12083
12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 12070

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_1_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.



12049
12050
12051
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 12049

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.



6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6611

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_1_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.



10528
10529
10530
10531
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10528

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.



10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10565

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_1_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.



10547
10548
10549
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10547

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.



6590
6591
6592
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6590

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.



6360
6361
6362
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6360

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.



6453
6454
6455
6456
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6453

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.



11917
11918
11919
11920
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11917

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.



11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
12003
12004
12005
12006
12007
12008
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11960

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_1_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.



11939
11940
11941
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 11939

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.



6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6496

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_1_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.



10424
10425
10426
10427
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10424

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.



10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10463

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_1_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.



10444
10445
10446
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10444

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.



6475
6476
6477
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6475

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.



8196
8197
8198
8199
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8196

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.



8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8229

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_1_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.



8213
8214
8215
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8213

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.



7334
7335
7336
7337
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7334

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.



12242
12243
12244
12245
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 12242

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.



12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
12318
12319
12320
12321
12322
12323
12324
12325
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 12277

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_1_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.



12260
12261
12262
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 12260

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.



7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7369

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_1_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.



10729
10730
10731
10732
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10729

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.



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

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_1_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.



10745
10746
10747
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 10745

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.



7352
7353
7354
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7352

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.



1435
1436
1437
1438
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1435

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.



1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1500

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_1_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_1_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.



1468
1469
1470
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1468

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, 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. 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

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

    A hash of custom headers that

Returns:

  • (KeyBundle) —

    operation results.



3548
3549
3550
3551
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3548

def import_key(vault_base_url, key_name, key, hsm:nil, key_attributes:nil, tags:nil, custom_headers:nil)
  response = import_key_async(vault_base_url, key_name, key, hsm:hsm, key_attributes:key_attributes, tags:tags, 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, 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. 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

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3601

def import_key_async(vault_base_url, key_name, key, hsm:nil, key_attributes:nil, tags: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?
    parameters.hsm = hsm
    parameters.key = key
    parameters.keyAttributes = key_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_1_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_1_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, 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. 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

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



3575
3576
3577
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3575

def import_key_with_http_info(vault_base_url, key_name, key, hsm:nil, key_attributes:nil, tags:nil, custom_headers:nil)
  import_key_async(vault_base_url, key_name, key, hsm:hsm, key_attributes:key_attributes, tags:tags, 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.



70
71
72
73
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 70

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.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 95

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.



82
83
84
85
86
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 82

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.



2548
2549
2550
2551
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2548

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.



2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2601

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_1_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_1_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.



2575
2576
2577
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2575

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



3152
3153
3154
3155
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3152

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.



3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3193

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.



3173
3174
3175
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3173

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



5729
5730
5731
5732
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5729

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.



5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5770

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.



5750
5751
5752
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5750

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



6901
6902
6903
6904
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6901

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.



6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6942

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.



6922
6923
6924
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6922

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



7661
7662
7663
7664
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7661

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.



7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7702

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.



7682
7683
7684
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7682

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.



3256
3257
3258
3259
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3256

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.



3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3301

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_1_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.



3279
3280
3281
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3279

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.



5832
5833
5834
5835
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5832

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.



5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5875

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_1_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.



5854
5855
5856
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5854

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.



9052
9053
9054
9055
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9052

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.



9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9093

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_1_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.



9073
9074
9075
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9073

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.



7002
7003
7004
7005
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7002

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.



7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7041

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_1_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.



7022
7023
7024
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7022

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.



7763
7764
7765
7766
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7763

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.



7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7802

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_1_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.



7783
7784
7785
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7783

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.



8591
8592
8593
8594
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8591

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.



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

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_1_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_1_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.



8609
8610
8611
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8609

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.



2794
2795
2796
2797
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2794

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.



2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2833

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_1_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_1_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.



2814
2815
2816
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2814

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.



4446
4447
4448
4449
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 4446

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.



4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 4505

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_1_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_1_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.



4476
4477
4478
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 4476

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.



7219
7220
7221
7222
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7219

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.



7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7256

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_1_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_1_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.



7238
7239
7240
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7238

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_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.



7979
7980
7981
7982
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7979

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.



8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8018

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_1_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_1_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.



7999
8000
8001
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 7999

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



356
357
358
359
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 356

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.



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 393

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_1_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_1_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.



375
376
377
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 375

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.



791
792
793
794
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 791

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.



840
841
842
843
844
845
846
847
848
849
850
851
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 840

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_1_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_1_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.



816
817
818
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 816

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.



9387
9388
9389
9390
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9387

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.



9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
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
9518
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9444

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_1_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_1_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.



9416
9417
9418
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9416

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.



5950
5951
5952
5953
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5950

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.



5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5999

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_1_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_1_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.



5975
5976
5977
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5975

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.



8307
8308
8309
8310
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8307

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.



8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8360

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_1_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_1_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.



8334
8335
8336
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8334

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.



4902
4903
4904
4905
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 4902

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.



4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 4955

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_1_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_1_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.



4929
4930
4931
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 4929

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, 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’ 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
  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (KeyOperationResult) —

    operation results.



5357
5358
5359
5360
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5357

def unwrap_key(vault_base_url, key_name, key_version, algorithm, value, custom_headers:nil)
  response = unwrap_key_async(vault_base_url, key_name, key_version, algorithm, value, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#unwrap_key_async(vault_base_url, key_name, key_version, algorithm, value, 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’ 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
  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5410

def unwrap_key_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 = KeyOperationsParameters.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_1_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_1_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, 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’ 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
  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



5384
5385
5386
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5384

def unwrap_key_with_http_info(vault_base_url, key_name, key_version, algorithm, value, custom_headers:nil)
  unwrap_key_async(vault_base_url, key_name, key_version, algorithm, value, 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.



1944
1945
1946
1947
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1944

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.



1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1999

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_1_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_1_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.



931
932
933
934
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 931

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.



982
983
984
985
986
987
988
989
990
991
992
993
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 982

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_1_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_1_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.



957
958
959
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 957

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.



2203
2204
2205
2206
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2203

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.



2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2244

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_1_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_1_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.



2224
2225
2226
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 2224

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.



1817
1818
1819
1820
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1817

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.



1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1858

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_1_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_1_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.



1838
1839
1840
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1838

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.



1972
1973
1974
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 1972

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, 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. 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

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

    A hash of custom headers that

Returns:

  • (KeyBundle) —

    operation results.



3809
3810
3811
3812
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3809

def update_key(vault_base_url, key_name, key_version, key_ops:nil, key_attributes:nil, tags: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, 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, 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. 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

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3862

def update_key_async(vault_base_url, key_name, key_version, key_ops:nil, key_attributes:nil, tags: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?
    parameters.key_ops = key_ops
    parameters.keyAttributes = key_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_1_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_1_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, 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. 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

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



3836
3837
3838
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 3836

def update_key_with_http_info(vault_base_url, key_name, key_version, key_ops:nil, key_attributes:nil, tags:nil, custom_headers:nil)
  update_key_async(vault_base_url, key_name, key_version, key_ops:key_ops, key_attributes:key_attributes, tags:tags, 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.



9544
9545
9546
9547
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9544

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.



9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9601

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_1_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_1_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.



9573
9574
9575
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 9573

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.



6201
6202
6203
6204
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6201

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.



6254
6255
6256
6257
6258
6259
6260
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
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6254

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_1_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_1_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.



6228
6229
6230
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 6228

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.



8456
8457
8458
8459
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8456

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.



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
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8507

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_1_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_1_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.



8482
8483
8484
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 8482

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.



5052
5053
5054
5055
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5052

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.



5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5113

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_1_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_1_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.



5083
5084
5085
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5083

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, 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’ 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
  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (KeyOperationResult) —

    operation results.



5209
5210
5211
5212
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5209

def wrap_key(vault_base_url, key_name, key_version, algorithm, value, custom_headers:nil)
  response = wrap_key_async(vault_base_url, key_name, key_version, algorithm, value, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#wrap_key_async(vault_base_url, key_name, key_version, algorithm, value, 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’ 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
  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5264

def wrap_key_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 = KeyOperationsParameters.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_1_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_1_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, 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’ 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
  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



5237
5238
5239
 
# File 'lib/7.1-preview/generated/azure_key_vault/key_vault_client.rb', line 5237

def wrap_key_with_http_info(vault_base_url, key_name, key_version, algorithm, value, custom_headers:nil)
  wrap_key_async(vault_base_url, key_name, key_version, algorithm, value, custom_headers:custom_headers).value!
end