Class: Azure::KeyVault::Mgmt::V2019_09_01::Keys

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb

Overview

The Azure management API provides a RESTful set of web services that interact with Azure Key Vault.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Keys

Creates and initializes a new instance of the Keys class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 18

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ KeyVaultManagementClient (readonly)

Returns reference to the KeyVaultManagementClient.

Returns:



23
24
25
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 23

def client
  @client
end

Instance Method Details

#create_if_not_exist(resource_group_name, vault_name, key_name, parameters, custom_headers: nil) ⇒ Key

Creates the first version of a new key if it does not exist. If it already exists, then the existing key is returned without any write operations being performed. This API does not create subsequent versions, and does not update existing keys.

contains the specified key vault. to be created. specified key. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group which

  • vault_name (String) —

    The name of the key vault which contains the key

  • key_name (String) —

    The name of the key to be created.

  • parameters (KeyCreateParameters) —

    The parameters used to create the

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

    A hash of custom headers that

Returns:

  • (Key) —

    operation results.



43
44
45
46
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 43

def create_if_not_exist(resource_group_name, vault_name, key_name, parameters, custom_headers:nil)
  response = create_if_not_exist_async(resource_group_name, vault_name, key_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_if_not_exist_async(resource_group_name, vault_name, key_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates the first version of a new key if it does not exist. If it already exists, then the existing key is returned without any write operations being performed. This API does not create subsequent versions, and does not update existing keys.

contains the specified key vault. to be created. specified key. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group which

  • vault_name (String) —

    The name of the key vault which contains the key

  • key_name (String) —

    The name of the key to be created.

  • parameters (KeyCreateParameters) —

    The parameters used to create the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 88

def create_if_not_exist_async(resource_group_name, vault_name, key_name, parameters, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vault_name is nil' if vault_name.nil?
  fail ArgumentError, "'vault_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9-]{3,24}$'" if !vault_name.nil? && vault_name.match(Regexp.new('^^[a-zA-Z0-9-]{3,24}$$')).nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, "'key_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9-]{1,127}$'" if !key_name.nil? && key_name.match(Regexp.new('^^[a-zA-Z0-9-]{1,127}$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?


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

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

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

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/keys/{keyName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'vaultName' => vault_name,'keyName' => key_name},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(: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 MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::KeyVault::Mgmt::V2019_09_01::Models::Key.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#create_if_not_exist_with_http_info(resource_group_name, vault_name, key_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates the first version of a new key if it does not exist. If it already exists, then the existing key is returned without any write operations being performed. This API does not create subsequent versions, and does not update existing keys.

contains the specified key vault. to be created. specified key. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group which

  • vault_name (String) —

    The name of the key vault which contains the key

  • key_name (String) —

    The name of the key to be created.

  • parameters (KeyCreateParameters) —

    The parameters used to create the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



66
67
68
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 66

def create_if_not_exist_with_http_info(resource_group_name, vault_name, key_name, parameters, custom_headers:nil)
  create_if_not_exist_async(resource_group_name, vault_name, key_name, parameters, custom_headers:custom_headers).value!
end

#get(resource_group_name, vault_name, key_name, custom_headers: nil) ⇒ Key

Gets the current version of the specified key from the specified key vault.

contains the specified key vault. retrieved. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group which

  • vault_name (String) —

    The name of the vault which contains the key to be

  • key_name (String) —

    The name of the key to be retrieved.

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

    A hash of custom headers that

Returns:

  • (Key) —

    operation results.



167
168
169
170
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 167

def get(resource_group_name, vault_name, key_name, custom_headers:nil)
  response = get_async(resource_group_name, vault_name, key_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, vault_name, key_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the current version of the specified key from the specified key vault.

contains the specified key vault. retrieved. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group which

  • vault_name (String) —

    The name of the vault which contains the key to be

  • key_name (String) —

    The name of the key to be retrieved.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
250
251
252
253
254
255
256
257
258
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 202

def get_async(resource_group_name, vault_name, key_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vault_name is nil' if vault_name.nil?
  fail ArgumentError, "'vault_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9-]{3,24}$'" if !vault_name.nil? && vault_name.match(Regexp.new('^^[a-zA-Z0-9-]{3,24}$$')).nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, "'key_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9-]{1,127}$'" if !key_name.nil? && key_name.match(Regexp.new('^^[a-zA-Z0-9-]{1,127}$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/keys/{keyName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'vaultName' => vault_name,'keyName' => key_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::KeyVault::Mgmt::V2019_09_01::Models::Key.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_version(resource_group_name, vault_name, key_name, key_version, custom_headers: nil) ⇒ Key

Gets the specified version of the specified key in the specified key vault.

contains the specified key vault. version to be retrieved. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group which

  • vault_name (String) —

    The name of the vault which contains the key

  • key_name (String) —

    The name of the key version to be retrieved.

  • key_version (String) —

    The version of the key to be retrieved.

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

    A hash of custom headers that

Returns:

  • (Key) —

    operation results.



375
376
377
378
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 375

def get_version(resource_group_name, vault_name, key_name, key_version, custom_headers:nil)
  response = get_version_async(resource_group_name, vault_name, key_name, key_version, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_version_async(resource_group_name, vault_name, key_name, key_version, custom_headers: nil) ⇒ Concurrent::Promise

Gets the specified version of the specified key in the specified key vault.

contains the specified key vault. version to be retrieved. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group which

  • vault_name (String) —

    The name of the vault which contains the key

  • key_name (String) —

    The name of the key version to be retrieved.

  • key_version (String) —

    The version of the key to be retrieved.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 412

def get_version_async(resource_group_name, vault_name, key_name, key_version, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vault_name is nil' if vault_name.nil?
  fail ArgumentError, "'vault_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9-]{3,24}$'" if !vault_name.nil? && vault_name.match(Regexp.new('^^[a-zA-Z0-9-]{3,24}$$')).nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, "'key_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9-]{1,127}$'" if !key_name.nil? && key_name.match(Regexp.new('^^[a-zA-Z0-9-]{1,127}$$')).nil?
  fail ArgumentError, 'key_version is nil' if key_version.nil?
  fail ArgumentError, "'key_version' should satisfy the constraint - 'Pattern': '^[a-fA-F0-9]{32}$'" if !key_version.nil? && key_version.match(Regexp.new('^^[a-fA-F0-9]{32}$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/keys/{keyName}/versions/{keyVersion}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'vaultName' => vault_name,'keyName' => key_name,'keyVersion' => key_version},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::KeyVault::Mgmt::V2019_09_01::Models::Key.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_version_with_http_info(resource_group_name, vault_name, key_name, key_version, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the specified version of the specified key in the specified key vault.

contains the specified key vault. version to be retrieved. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group which

  • vault_name (String) —

    The name of the vault which contains the key

  • key_name (String) —

    The name of the key version to be retrieved.

  • key_version (String) —

    The version of the key to be retrieved.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



394
395
396
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 394

def get_version_with_http_info(resource_group_name, vault_name, key_name, key_version, custom_headers:nil)
  get_version_async(resource_group_name, vault_name, key_name, key_version, custom_headers:custom_headers).value!
end

#get_with_http_info(resource_group_name, vault_name, key_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the current version of the specified key from the specified key vault.

contains the specified key vault. retrieved. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group which

  • vault_name (String) —

    The name of the vault which contains the key to be

  • key_name (String) —

    The name of the key to be retrieved.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



185
186
187
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 185

def get_with_http_info(resource_group_name, vault_name, key_name, custom_headers:nil)
  get_async(resource_group_name, vault_name, key_name, custom_headers:custom_headers).value!
end

#list(resource_group_name, vault_name, custom_headers: nil) ⇒ Array<Key>

Lists the keys in the specified key vault.

contains the specified key vault. be retrieved. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group which

  • vault_name (String) —

    The name of the vault which contains the keys to

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

    A hash of custom headers that

Returns:

  • (Array<Key>) —

    operation results.



272
273
274
275
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 272

def list(resource_group_name, vault_name, custom_headers:nil)
  first_page = list_as_lazy(resource_group_name, vault_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(resource_group_name, vault_name, custom_headers: nil) ⇒ KeyListResult

Lists the keys in the specified key vault.

contains the specified key vault. be retrieved. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group which

  • vault_name (String) —

    The name of the vault which contains the keys to

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

    A hash of custom headers that

Returns:

  • (KeyListResult) —

    which provide lazy access to pages of the response.



770
771
772
773
774
775
776
777
778
779
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 770

def list_as_lazy(resource_group_name, vault_name, custom_headers:nil)
  response = list_async(resource_group_name, vault_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_async(resource_group_name, vault_name, custom_headers: nil) ⇒ Concurrent::Promise

Lists the keys in the specified key vault.

contains the specified key vault. be retrieved. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group which

  • vault_name (String) —

    The name of the vault which contains the keys to

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 305

def list_async(resource_group_name, vault_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vault_name is nil' if vault_name.nil?
  fail ArgumentError, "'vault_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9-]{3,24}$'" if !vault_name.nil? && vault_name.match(Regexp.new('^^[a-zA-Z0-9-]{3,24}$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/keys'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'vaultName' => vault_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::KeyVault::Mgmt::V2019_09_01::Models::KeyListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_next(next_page_link, custom_headers: nil) ⇒ KeyListResult

Lists the keys in the specified key 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.



588
589
590
591
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 588

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

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

Lists the keys in the specified key 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.



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

def list_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'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || @client.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 = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::KeyVault::Mgmt::V2019_09_01::Models::KeyListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the keys in the specified key 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.



603
604
605
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 603

def list_next_with_http_info(next_page_link, custom_headers:nil)
  list_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_versions(resource_group_name, vault_name, key_name, custom_headers: nil) ⇒ Array<Key>

Lists the versions of the specified key in the specified key vault.

contains the specified key vault. versions to be retrieved. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group which

  • vault_name (String) —

    The name of the vault which contains the key

  • key_name (String) —

    The name of the key versions to be retrieved.

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

    A hash of custom headers that

Returns:

  • (Array<Key>) —

    operation results.



485
486
487
488
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 485

def list_versions(resource_group_name, vault_name, key_name, custom_headers:nil)
  first_page = list_versions_as_lazy(resource_group_name, vault_name, key_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_versions_as_lazy(resource_group_name, vault_name, key_name, custom_headers: nil) ⇒ KeyListResult

Lists the versions of the specified key in the specified key vault.

contains the specified key vault. versions to be retrieved. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group which

  • vault_name (String) —

    The name of the vault which contains the key

  • key_name (String) —

    The name of the key versions to be retrieved.

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

    A hash of custom headers that

Returns:

  • (KeyListResult) —

    which provide lazy access to pages of the response.



794
795
796
797
798
799
800
801
802
803
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 794

def list_versions_as_lazy(resource_group_name, vault_name, key_name, custom_headers:nil)
  response = list_versions_async(resource_group_name, vault_name, key_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_versions_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_versions_async(resource_group_name, vault_name, key_name, custom_headers: nil) ⇒ Concurrent::Promise

Lists the versions of the specified key in the specified key vault.

contains the specified key vault. versions to be retrieved. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group which

  • vault_name (String) —

    The name of the vault which contains the key

  • key_name (String) —

    The name of the key versions to be retrieved.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 520

def list_versions_async(resource_group_name, vault_name, key_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'vault_name is nil' if vault_name.nil?
  fail ArgumentError, "'vault_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9-]{3,24}$'" if !vault_name.nil? && vault_name.match(Regexp.new('^^[a-zA-Z0-9-]{3,24}$$')).nil?
  fail ArgumentError, 'key_name is nil' if key_name.nil?
  fail ArgumentError, "'key_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9-]{1,127}$'" if !key_name.nil? && key_name.match(Regexp.new('^^[a-zA-Z0-9-]{1,127}$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/keys/{keyName}/versions'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'vaultName' => vault_name,'keyName' => key_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::KeyVault::Mgmt::V2019_09_01::Models::KeyListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_versions_next(next_page_link, custom_headers: nil) ⇒ KeyListResult

Lists the versions of the specified key in the specified key 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.



678
679
680
681
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 678

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

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

Lists the versions of the specified key in the specified key 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.



707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 707

def list_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'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || @client.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 = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::KeyVault::Mgmt::V2019_09_01::Models::KeyListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_versions_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the versions of the specified key in the specified key 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.



693
694
695
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 693

def list_versions_next_with_http_info(next_page_link, custom_headers:nil)
  list_versions_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_versions_with_http_info(resource_group_name, vault_name, key_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the versions of the specified key in the specified key vault.

contains the specified key vault. versions to be retrieved. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group which

  • vault_name (String) —

    The name of the vault which contains the key

  • key_name (String) —

    The name of the key versions to be retrieved.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



503
504
505
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 503

def list_versions_with_http_info(resource_group_name, vault_name, key_name, custom_headers:nil)
  list_versions_async(resource_group_name, vault_name, key_name, custom_headers:custom_headers).value!
end

#list_with_http_info(resource_group_name, vault_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the keys in the specified key vault.

contains the specified key vault. be retrieved. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group which

  • vault_name (String) —

    The name of the vault which contains the keys to

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



289
290
291
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/keys.rb', line 289

def list_with_http_info(resource_group_name, vault_name, custom_headers:nil)
  list_async(resource_group_name, vault_name, custom_headers:custom_headers).value!
end