Class: Azure::KeyVault::V2015_06_01::KeyVaultClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2015-06-01/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/2015-06-01/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 = '2015-06-01'
  @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/2015-06-01/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/2015-06-01/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/2015-06-01/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/2015-06-01/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/2015-06-01/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/2015-06-01/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_key(vault_base_url, key_name, custom_headers: nil) ⇒ BackupKeyResult

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

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



925
926
927
928
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 925

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.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
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
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 956

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

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



941
942
943
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 941

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

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

Creates a new certificate version. If this is the first version, the certificate resource is created.

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

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



3606
3607
3608
3609
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3606

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 version. If this is the first version, the certificate resource is created.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3651

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 = Azure::KeyVault::V2015_06_01::Models::CertificateCreateParameters.new
  unless certificate_policy.nil? && certificate_attributes.nil? && tags.nil?
    parameters.certificate_policy = certificate_policy
    parameters.certificate_attributes = 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::V2015_06_01::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::V2015_06_01::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 version. If this is the first version, the certificate resource is created.

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

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



3629
3630
3631
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3629

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, custom_headers: nil) ⇒ KeyBundle

Creates a new, named, key in the specified vault.

myvault.vault.azure.net JsonWebKeyType. Supported JsonWebKey key types (kty) for Elliptic Curve, RSA, HSM, Octet. Possible values include: ‘EC’, ‘RSA’, ‘RSA-HSM’, ‘oct’ form of key-value pairs will be added to the HTTP request.

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • key_name (String) —

    The name of the key

  • kty (JsonWebKeyType) —

    The type of key to create. Valid key types, see

  • key_size (Integer) (defaults to: nil) —

    The key size in bits. e.g. 1024 or 2048.

  • 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

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

    A hash of custom headers that

Returns:

  • (KeyBundle) —

    operation results.



131
132
133
134
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 131

def create_key(vault_base_url, key_name, kty, key_size:nil, key_ops:nil, key_attributes:nil, tags: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, 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, custom_headers: nil) ⇒ Concurrent::Promise

Creates a new, named, key in the specified vault.

myvault.vault.azure.net JsonWebKeyType. Supported JsonWebKey key types (kty) for Elliptic Curve, RSA, HSM, Octet. Possible values include: ‘EC’, ‘RSA’, ‘RSA-HSM’, ‘oct’ form of key-value pairs to the HTTP request.

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • key_name (String) —

    The name of the key

  • kty (JsonWebKeyType) —

    The type of key to create. Valid key types, see

  • key_size (Integer) (defaults to: nil) —

    The key size in bits. e.g. 1024 or 2048.

  • 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

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 178

def create_key_async(vault_base_url, key_name, kty, key_size:nil, 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_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 = Azure::KeyVault::V2015_06_01::Models::KeyCreateParameters.new
  unless kty.nil? && key_size.nil? && key_ops.nil? && key_attributes.nil? && tags.nil?
    parameters.kty = kty
    parameters.key_size = key_size
    parameters.key_ops = key_ops
    parameters.key_attributes = 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::V2015_06_01::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::V2015_06_01::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, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a new, named, key in the specified vault.

myvault.vault.azure.net JsonWebKeyType. Supported JsonWebKey key types (kty) for Elliptic Curve, RSA, HSM, Octet. Possible values include: ‘EC’, ‘RSA’, ‘RSA-HSM’, ‘oct’ form of key-value pairs will be added to the HTTP request.

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • key_name (String) —

    The name of the key

  • kty (JsonWebKeyType) —

    The type of key to create. Valid key types, see

  • key_size (Integer) (defaults to: nil) —

    The key size in bits. e.g. 1024 or 2048.

  • 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

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



155
156
157
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 155

def create_key_with_http_info(vault_base_url, key_name, kty, key_size:nil, key_ops:nil, key_attributes:nil, tags: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, 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

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

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



1261
1262
1263
1264
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1261

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

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

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



1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
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
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1300

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 = Azure::KeyVault::V2015_06_01::Models::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::V2015_06_01::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::V2015_06_01::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

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

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



1281
1282
1283
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1281

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) ⇒ CertificateBundle

Deletes a certificate from the specified vault.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • certificate_name (String) —

    The name of the certificate in the given

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

    A hash of custom headers that

Returns:

  • (CertificateBundle) —

    operation results.



2660
2661
2662
2663
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2660

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 the specified vault.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • certificate_name (String) —

    The name of the certificate in the given

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2693

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::V2015_06_01::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

#delete_certificate_contacts(vault_base_url, custom_headers: nil) ⇒ Contacts

Deletes the certificate contacts for the specified vault.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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

    A hash of custom headers that

Returns:

  • (Contacts) —

    operation results.



2953
2954
2955
2956
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2953

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 the specified vault.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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

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::V2015_06_01::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 the specified vault.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



2968
2969
2970
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2968

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.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



3502
3503
3504
3505
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3502

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.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3533

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

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



3518
3519
3520
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3518

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 certificate operation.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



4648
4649
4650
4651
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4648

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 certificate operation.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



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
4730
4731
4732
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4679

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::V2015_06_01::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 certificate operation.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



4664
4665
4666
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4664

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 the specified vault.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • certificate_name (String) —

    The name of the certificate in the given

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



2677
2678
2679
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2677

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) ⇒ KeyBundle

Deletes the specified key

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • key_name (String) —

    The name of the key

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

    A hash of custom headers that

Returns:

  • (KeyBundle) —

    operation results.



393
394
395
396
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 393

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 the specified key

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 424

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::V2015_06_01::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

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

Deletes the specified key

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



409
410
411
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 409

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_secret(vault_base_url, secret_name, custom_headers: nil) ⇒ SecretBundle

Deletes a secret from the specified vault.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • secret_name (String) —

    The name of the secret in the given vault

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

    A hash of custom headers that

Returns:

  • (SecretBundle) —

    operation results.



2030
2031
2032
2033
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2030

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 the specified vault.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • secret_name (String) —

    The name of the secret in the given vault

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2061

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::V2015_06_01::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

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

Deletes a secret from the specified vault.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • secret_name (String) —

    The name of the secret in the given vault

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



2046
2047
2048
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2046

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

#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 Azure Key Vault.

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

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



1134
1135
1136
1137
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1134

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 Azure Key Vault.

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

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



1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
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
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1175

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 = Azure::KeyVault::V2015_06_01::Models::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::V2015_06_01::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::V2015_06_01::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 Azure Key Vault.

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

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



1155
1156
1157
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1155

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 a Certificate.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • certificate_name (String) —

    The name of the certificate in the given

  • certificate_version (String) —

    The version of the certificate

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

    A hash of custom headers that

Returns:

  • (CertificateBundle) —

    operation results.



4334
4335
4336
4337
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4334

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 a Certificate.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • certificate_name (String) —

    The name of the certificate in the given

  • certificate_version (String) —

    The version 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.



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
4420
4421
4422
4423
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4369

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::V2015_06_01::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

Gets the certificate contacts for the specified vault.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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

    A hash of custom headers that

Returns:

  • (Contacts) —

    operation results.



2861
2862
2863
2864
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2861

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

Gets the certificate contacts for the specified vault.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2890

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::V2015_06_01::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

Gets the certificate contacts for the specified vault.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



2876
2877
2878
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2876

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

Gets the specified certificate issuer.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



3405
3406
3407
3408
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3405

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

Gets the specified certificate issuer.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
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
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3436

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::V2015_06_01::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

Gets the specified certificate issuer.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



3421
3422
3423
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3421

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 the specified vault.

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

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



3047
3048
3049
3050
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3047

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 the specified vault.

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

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



5993
5994
5995
5996
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5993

def get_certificate_issuers_as_lazy(vault_base_url, maxresults:nil, custom_headers:nil)
  first_page = get_certificate_issuers_as_lazy_async(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 the specified vault.

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

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



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
6069
6070
6071
6072
6073
6074
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 6026

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::V2015_06_01::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 the specified vault.

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

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



6010
6011
6012
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 6010

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 the specified vault.

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

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



3080
3081
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
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3080

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::V2015_06_01::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 the specified vault.

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.



5326
5327
5328
5329
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5326

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 the specified vault.

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.



5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5355

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::V2015_06_01::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 the specified vault.

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.



5341
5342
5343
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5341

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 the specified vault.

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

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



3064
3065
3066
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3064

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 certificate operation response.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



4551
4552
4553
4554
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4551

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 certificate operation response.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4582

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::V2015_06_01::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 certificate operation response.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



4567
4568
4569
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4567

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

Gets the policy for a certificate.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • certificate_name (String) —

    The name of the certificate in the given

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

    A hash of custom headers that

Returns:

  • (CertificatePolicy) —

    operation results.



3984
3985
3986
3987
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3984

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

Gets the policy for a certificate.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • certificate_name (String) —

    The name of the certificate in the given

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4017

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::V2015_06_01::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

Gets the policy for a certificate.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • certificate_name (String) —

    The name of the certificate in the given

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



4001
4002
4003
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4001

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.

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

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



3880
3881
3882
3883
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3880

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.

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

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



6089
6090
6091
6092
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 6089

def get_certificate_versions_as_lazy(vault_base_url, certificate_name, maxresults:nil, custom_headers:nil)
  first_page = get_certificate_versions_as_lazy_async(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.

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

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



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
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 6124

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

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

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



6107
6108
6109
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 6107

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.

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

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



3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3915

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

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.



5416
5417
5418
5419
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5416

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.

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.



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
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5445

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

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.



5431
5432
5433
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5431

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.

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

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



3898
3899
3900
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3898

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 a Certificate.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • certificate_name (String) —

    The name of the certificate in the given

  • certificate_version (String) —

    The version of the certificate

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



4352
4353
4354
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4352

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, custom_headers: nil) ⇒ Array<CertificateItem>

List certificates in the specified vault

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

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



2560
2561
2562
2563
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2560

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

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

List certificates in the specified vault

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

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



5898
5899
5900
5901
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5898

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

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

List certificates in the specified vault

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

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



5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5931

def get_certificates_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'

  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::V2015_06_01::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, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List certificates in the specified vault

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

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



5915
5916
5917
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5915

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

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

List certificates in the specified vault

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

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



2593
2594
2595
2596
2597
2598
2599
2600
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
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2593

def get_certificates_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'

  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::V2015_06_01::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 the specified vault

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.



5236
5237
5238
5239
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5236

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 the specified vault

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.



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
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5265

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::V2015_06_01::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 the specified vault

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.



5251
5252
5253
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5251

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, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List certificates in the specified vault

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

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



2577
2578
2579
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2577

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

Retrieves the public portion of a key plus its attributes

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • key_name (String) —

    The name of the key

  • key_version (String) —

    The version of the key

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

    A hash of custom headers that

Returns:

  • (KeyBundle) —

    operation results.



620
621
622
623
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 620

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

Retrieves the public portion of a key plus its attributes

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • key_name (String) —

    The name of the key

  • key_version (String) —

    The version 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.



653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 653

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::V2015_06_01::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>

List the versions of the specified key

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

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



722
723
724
725
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 722

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

List the versions of the specified key

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

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



5509
5510
5511
5512
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5509

def get_key_versions_as_lazy(vault_base_url, key_name, maxresults:nil, custom_headers:nil)
  first_page = get_key_versions_as_lazy_async(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

List the versions of the specified key

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

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



5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5544

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::V2015_06_01::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

List the versions of the specified key

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

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



5527
5528
5529
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5527

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

List the versions of the specified key

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

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



757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 757

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::V2015_06_01::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

List the versions of the specified key

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.



4876
4877
4878
4879
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4876

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

List the versions of the specified key

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.



4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4905

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::V2015_06_01::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

List the versions of the specified key

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.



4891
4892
4893
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4891

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

List the versions of the specified key

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

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



740
741
742
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 740

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

Retrieves the public portion of a key plus its attributes

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • key_name (String) —

    The name of the key

  • key_version (String) —

    The version of the key

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



637
638
639
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 637

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

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

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



826
827
828
829
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 826

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

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

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



5608
5609
5610
5611
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5608

def get_keys_as_lazy(vault_base_url, maxresults:nil, custom_headers:nil)
  first_page = get_keys_as_lazy_async(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

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

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



5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
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
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5641

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::V2015_06_01::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

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

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



5625
5626
5627
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5625

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

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

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



859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 859

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::V2015_06_01::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

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.



4966
4967
4968
4969
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4966

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

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.



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
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4995

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::V2015_06_01::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

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.



4981
4982
4983
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4981

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

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

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



843
844
845
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 843

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_secret(vault_base_url, secret_name, secret_version, custom_headers: nil) ⇒ SecretBundle

Gets a secret.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • secret_name (String) —

    The name of the secret in the given vault

  • secret_version (String) —

    The version of the secret

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

    A hash of custom headers that

Returns:

  • (SecretBundle) —

    operation results.



2254
2255
2256
2257
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2254

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

Gets a secret.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • secret_name (String) —

    The name of the secret in the given vault

  • secret_version (String) —

    The version 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.



2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2287

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::V2015_06_01::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 the versions of the specified secret

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

  • secret_name (String) —

    The name of the secret in the given vault

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



2456
2457
2458
2459
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2456

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 the versions of the specified secret

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

  • secret_name (String) —

    The name of the secret in the given vault

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



5799
5800
5801
5802
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5799

def get_secret_versions_as_lazy(vault_base_url, secret_name, maxresults:nil, custom_headers:nil)
  first_page = get_secret_versions_as_lazy_async(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 the versions of the specified secret

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

  • secret_name (String) —

    The name of the secret in the given vault

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



5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5834

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::V2015_06_01::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 the versions of the specified secret

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

  • secret_name (String) —

    The name of the secret in the given vault

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



5817
5818
5819
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5817

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 the versions of the specified secret

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

  • secret_name (String) —

    The name of the secret in the given vault

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



2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2491

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::V2015_06_01::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 the versions of the specified secret

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.



5146
5147
5148
5149
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5146

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 the versions of the specified secret

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.



5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5175

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::V2015_06_01::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 the versions of the specified secret

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.



5161
5162
5163
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5161

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 the versions of the specified secret

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

  • secret_name (String) —

    The name of the secret in the given vault

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



2474
2475
2476
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2474

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

Gets a secret.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • secret_name (String) —

    The name of the secret in the given vault

  • secret_version (String) —

    The version of the secret

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



2271
2272
2273
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2271

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 the specified vault

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

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



2355
2356
2357
2358
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2355

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 the specified vault

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

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



5703
5704
5705
5706
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5703

def get_secrets_as_lazy(vault_base_url, maxresults:nil, custom_headers:nil)
  first_page = get_secrets_as_lazy_async(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 the specified vault

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

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



5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5736

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::V2015_06_01::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 the specified vault

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

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



5720
5721
5722
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5720

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 the specified vault

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

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



2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2388

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::V2015_06_01::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 the specified vault

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.



5056
5057
5058
5059
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5056

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 the specified vault

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.



5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5085

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::V2015_06_01::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 the specified vault

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.



5071
5072
5073
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 5071

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 the specified vault

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

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



2372
2373
2374
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2372

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

#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 the specified vault

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

  • 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 base64encoded_certificate 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.



3742
3743
3744
3745
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3742

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 the specified vault

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

  • 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 base64encoded_certificate 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.



3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3795

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 = Azure::KeyVault::V2015_06_01::Models::CertificateImportParameters.new
  unless base64encoded_certificate.nil? && password.nil? && certificate_policy.nil? && certificate_attributes.nil? && tags.nil?
    parameters.base64encoded_certificate = base64encoded_certificate
    parameters.password = password
    parameters.certificate_policy = certificate_policy
    parameters.certificate_attributes = 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::V2015_06_01::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::V2015_06_01::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 the specified vault

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

  • 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 base64encoded_certificate 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.



3769
3770
3771
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3769

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 a key into the specified vault

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

  • key_name (String) —

    The name of the 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.



268
269
270
271
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 268

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 a key into the specified vault

myvault.vault.azure.net key form of key-value pairs to the HTTP request.

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • key_name (String) —

    The name of the 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.



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 311

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 = Azure::KeyVault::V2015_06_01::Models::KeyImportParameters.new
  unless hsm.nil? && key.nil? && key_attributes.nil? && tags.nil?
    parameters.hsm = hsm
    parameters.key = key
    parameters.key_attributes = 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::V2015_06_01::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::V2015_06_01::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 a key into the specified vault

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

  • key_name (String) —

    The name of the 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.



290
291
292
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 290

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/2015-06-01/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/2015-06-01/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/2015-06-01/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.

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

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



4752
4753
4754
4755
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4752

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.

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

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



4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
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
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4797

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 = Azure::KeyVault::V2015_06_01::Models::CertificateMergeParameters.new
  unless x509certificates.nil? && certificate_attributes.nil? && tags.nil?
    parameters.x509certificates = x509certificates
    parameters.certificate_attributes = 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::V2015_06_01::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::V2015_06_01::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.

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

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



4775
4776
4777
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4775

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

#restore_key(vault_base_url, key_bundle_backup, custom_headers: nil) ⇒ KeyBundle

Restores the backup key in to a vault

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



1022
1023
1024
1025
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1022

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 the backup key in to a vault

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1053

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 = Azure::KeyVault::V2015_06_01::Models::KeyRestoreParameters.new
  unless key_bundle_backup.nil?
    parameters.key_bundle_backup = 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::V2015_06_01::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::V2015_06_01::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 the backup key in to a vault

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



1038
1039
1040
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1038

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

#set_certificate_contacts(vault_base_url, contacts, custom_headers: nil) ⇒ Contacts

Sets the certificate contacts for the specified vault.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • contacts (Contacts) —

    The contacts for the vault certificates.

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

    A hash of custom headers that

Returns:

  • (Contacts) —

    operation results.



2759
2760
2761
2762
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2759

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

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • contacts (Contacts) —

    The contacts for the vault certificates.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2790

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::V2015_06_01::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::V2015_06_01::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 vault.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • contacts (Contacts) —

    The contacts for the vault certificates.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



2775
2776
2777
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2775

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.

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

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



3152
3153
3154
3155
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3152

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.

myvault.vault.azure.net issuer. as provided to the issuer. to the HTTP request.

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



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
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3195

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 = Azure::KeyVault::V2015_06_01::Models::CertificateIssuerSetParameters.new
  unless provider.nil? && credentials.nil? && organization_details.nil? && attributes.nil?
    parameter.provider = provider
    parameter.credentials = credentials
    parameter.organization_details = 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::V2015_06_01::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::V2015_06_01::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.

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

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



3174
3175
3176
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3174

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_secret(vault_base_url, secret_name, value, tags: nil, content_type: nil, secret_attributes: nil, custom_headers: nil) ⇒ SecretBundle

Sets a secret in the specified vault.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • secret_name (String) —

    The name of the secret in the given vault

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



1907
1908
1909
1910
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1907

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 the specified vault.

myvault.vault.azure.net form of key-value pairs to the HTTP request.

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • secret_name (String) —

    The name of the secret in the given vault

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



1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1948

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 = Azure::KeyVault::V2015_06_01::Models::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.secret_attributes = 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::V2015_06_01::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::V2015_06_01::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 the specified vault.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • secret_name (String) —

    The name of the secret in the given vault

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



1928
1929
1930
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1928

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

#sign(vault_base_url, key_name, key_version, algorithm, value, custom_headers: nil) ⇒ KeyOperationResult

Creates a signature from a digest using the specified key in the vault

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



1388
1389
1390
1391
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1388

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 in the vault

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’ to the HTTP request.

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1431

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 = Azure::KeyVault::V2015_06_01::Models::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::V2015_06_01::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::V2015_06_01::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 in the vault

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



1410
1411
1412
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1410

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 in the vault that has initially been used for wrapping the key.

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

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



1779
1780
1781
1782
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1779

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 in the vault that has initially been used for wrapping the key.

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

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



1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
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
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1820

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 = Azure::KeyVault::V2015_06_01::Models::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::V2015_06_01::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::V2015_06_01::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 in the vault that has initially been used for wrapping the key.

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

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



1800
1801
1802
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1800

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 attributes associated with the specified certificate

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

  • certificate_name (String) —

    The name of the certificate in the given

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



4205
4206
4207
4208
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4205

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 attributes associated with the specified certificate

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

  • certificate_name (String) —

    The name of the certificate in the given

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



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
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4252

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 = Azure::KeyVault::V2015_06_01::Models::CertificateUpdateParameters.new
  unless certificate_policy.nil? && certificate_attributes.nil? && tags.nil?
    parameters.certificate_policy = certificate_policy
    parameters.certificate_attributes = 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::V2015_06_01::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::V2015_06_01::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.

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

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



3282
3283
3284
3285
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3282

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.

myvault.vault.azure.net issuer. as provided to the issuer. to the HTTP request.

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3325

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 = Azure::KeyVault::V2015_06_01::Models::CertificateIssuerUpdateParameters.new
  unless provider.nil? && credentials.nil? && organization_details.nil? && attributes.nil?
    parameter.provider = provider
    parameter.credentials = credentials
    parameter.organization_details = 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::V2015_06_01::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::V2015_06_01::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.

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

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



3304
3305
3306
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 3304

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.

myvault.vault.azure.net requested on the certificate operation. will be added to the HTTP request.

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



4438
4439
4440
4441
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4438

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.

myvault.vault.azure.net requested on the certificate operation. to the HTTP request.

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
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
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4473

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

myvault.vault.azure.net requested on the certificate operation. will be added to the HTTP request.

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



4456
4457
4458
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4456

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 appropriate members in the certificate_policy that must be updated. Leave others as null.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



4086
4087
4088
4089
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4086

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 appropriate members in the certificate_policy that must be updated. Leave others as null.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



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
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4123

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::V2015_06_01::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::V2015_06_01::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 appropriate members in the certificate_policy that must be updated. Leave others as null.

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



4105
4106
4107
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4105

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 attributes associated with the specified certificate

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

  • certificate_name (String) —

    The name of the certificate in the given

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



4229
4230
4231
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 4229

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

Updates the Key Attributes associated with the specified key

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

  • key_name (String) —

    The name of the key

  • key_version (String) —

    The version of the key

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



496
497
498
499
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 496

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

Updates the Key Attributes associated with the specified key

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

  • key_name (String) —

    The name of the key

  • key_version (String) —

    The version of the key

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



539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 539

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 = Azure::KeyVault::V2015_06_01::Models::KeyUpdateParameters.new
  unless key_ops.nil? && key_attributes.nil? && tags.nil?
    parameters.key_ops = key_ops
    parameters.key_attributes = 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::V2015_06_01::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::V2015_06_01::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

Updates the Key Attributes associated with the specified key

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

  • key_name (String) —

    The name of the key

  • key_version (String) —

    The version of the key

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



518
519
520
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 518

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_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 the specified secret

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • secret_name (String) —

    The name of the secret in the given vault

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



2132
2133
2134
2135
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2132

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 the specified secret

myvault.vault.azure.net form of key-value pairs to the HTTP request.

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • secret_name (String) —

    The name of the secret in the given vault

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



2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2173

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 = Azure::KeyVault::V2015_06_01::Models::SecretUpdateParameters.new
  unless content_type.nil? && secret_attributes.nil? && tags.nil?
    parameters.content_type = content_type
    parameters.secret_attributes = 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::V2015_06_01::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::V2015_06_01::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 the specified secret

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

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

  • secret_name (String) —

    The name of the secret in the given vault

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



2153
2154
2155
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 2153

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

#verify(vault_base_url, key_name, key_version, algorithm, digest, signature, custom_headers: nil) ⇒ KeyVerifyResult

Verifies a signature using the specified key

myvault.vault.azure.net algorithm. For more information on possible algorithm types, see JsonWebKeySignatureAlgorithm. Possible values include: ‘PS256’, ‘PS384’, ‘PS512’, ‘RS256’, ‘RS384’, ‘RS512’, ‘RSNULL’ will be added to the HTTP request.

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



1520
1521
1522
1523
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1520

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 the specified key

myvault.vault.azure.net algorithm. For more information on possible algorithm types, see JsonWebKeySignatureAlgorithm. Possible values include: ‘PS256’, ‘PS384’, ‘PS512’, ‘RS256’, ‘RS384’, ‘RS512’, ‘RSNULL’ to the HTTP request.

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1565

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 = Azure::KeyVault::V2015_06_01::Models::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::V2015_06_01::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::V2015_06_01::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 the specified key

myvault.vault.azure.net algorithm. For more information on possible algorithm types, see JsonWebKeySignatureAlgorithm. Possible values include: ‘PS256’, ‘PS384’, ‘PS512’, ‘RS256’, ‘RS384’, ‘RS512’, ‘RSNULL’ will be added to the HTTP request.

Parameters:

  • vault_base_url (String) —

    The vault name, e.g.

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



1543
1544
1545
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1543

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 the specified key

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

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



1653
1654
1655
1656
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1653

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 the specified key

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

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



1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1692

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 = Azure::KeyVault::V2015_06_01::Models::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::V2015_06_01::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::V2015_06_01::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 the specified key

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

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



1673
1674
1675
 
# File 'lib/2015-06-01/generated/azure_key_vault/key_vault_client.rb', line 1673

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