Class: Azure::KeyVault::Mgmt::V2015_06_01::Vaults

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.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) ⇒ Vaults

Creates and initializes a new instance of the Vaults class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.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/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 23

def client
  @client
end

Instance Method Details

#create_or_update(resource_group_name, vault_name, parameters, custom_headers = nil) ⇒ Vault

Create or update a key vault in the specified subscription.

the server belongs. update the vault will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Resource Group to which

  • vault_name (String) —

    Name of the vault

  • parameters (VaultCreateOrUpdateParameters) —

    Parameters to create or

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

    A hash of custom headers that

Returns:

  • (Vault) —

    operation results.



38
39
40
41
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 38

def create_or_update(resource_group_name, vault_name, parameters, custom_headers = nil)
  response = create_or_update_async(resource_group_name, vault_name, parameters, custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, vault_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

Create or update a key vault in the specified subscription.

the server belongs. update the vault to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Resource Group to which

  • vault_name (String) —

    Name of the vault

  • parameters (VaultCreateOrUpdateParameters) —

    Parameters to create or

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 73

def create_or_update_async(resource_group_name, vault_name, parameters, custom_headers = 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, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}

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

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

  # Serialize Request
  request_mapper = Azure::KeyVault::Mgmt::V2015_06_01::Models::VaultCreateOrUpdateParameters.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}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vaultName' => vault_name,'subscriptionId' => @client.subscription_id},
      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 == 201 || 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?
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::KeyVault::Mgmt::V2015_06_01::Models::Vault.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
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::KeyVault::Mgmt::V2015_06_01::Models::Vault.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_or_update_with_http_info(resource_group_name, vault_name, parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Create or update a key vault in the specified subscription.

the server belongs. update the vault will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Resource Group to which

  • vault_name (String) —

    Name of the vault

  • parameters (VaultCreateOrUpdateParameters) —

    Parameters to create or

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



56
57
58
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 56

def create_or_update_with_http_info(resource_group_name, vault_name, parameters, custom_headers = nil)
  create_or_update_async(resource_group_name, vault_name, parameters, custom_headers).value!
end

#delete(resource_group_name, vault_name, custom_headers = nil) ⇒ Object

Deletes the specified Azure key vault.

the vault belongs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Resource Group to which

  • vault_name (String) —

    The name of the vault to delete

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

    A hash of custom headers that



155
156
157
158
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 155

def delete(resource_group_name, vault_name, custom_headers = nil)
  response = delete_async(resource_group_name, vault_name, custom_headers).value!
  nil
end

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

Deletes the specified Azure key vault.

the vault belongs. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Resource Group to which

  • vault_name (String) —

    The name of the vault to delete

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 186

def delete_async(resource_group_name, vault_name, custom_headers = 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, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}

  # 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}'

  request_url = @base_url || @client.base_url

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

  promise.execute
end

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

Deletes the specified Azure key vault.

the vault belongs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Resource Group to which

  • vault_name (String) —

    The name of the vault to delete

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



171
172
173
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 171

def delete_with_http_info(resource_group_name, vault_name, custom_headers = nil)
  delete_async(resource_group_name, vault_name, custom_headers).value!
end

#get(resource_group_name, vault_name, custom_headers = nil) ⇒ Vault

Gets the specified Azure key vault.

the vault belongs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Resource Group to which

  • vault_name (String) —

    The name of the vault.

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

    A hash of custom headers that

Returns:

  • (Vault) —

    operation results.



239
240
241
242
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 239

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

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

Gets the specified Azure key vault.

the vault belongs. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Resource Group to which

  • vault_name (String) —

    The name of the vault.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 270

def get_async(resource_group_name, vault_name, custom_headers = 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, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}

  # 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}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'vaultName' => vault_name,'subscriptionId' => @client.subscription_id},
      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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::KeyVault::Mgmt::V2015_06_01::Models::Vault.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_with_http_info(resource_group_name, vault_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the specified Azure key vault.

the vault belongs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Resource Group to which

  • vault_name (String) —

    The name of the vault.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



255
256
257
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 255

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

#list(top = nil, custom_headers = nil) ⇒ Array<Resource>

The List operation gets information about the vaults associated with the subscription.

will be added to the HTTP request.

Parameters:

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

    Maximum number of results to return.

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

    A hash of custom headers that

Returns:

  • (Array<Resource>) —

    operation results.



428
429
430
431
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 428

def list(top = nil, custom_headers = nil)
  first_page = list_as_lazy(top, custom_headers)
  first_page.get_all_items
end

#list_as_lazy(top = nil, custom_headers = nil) ⇒ ResourceListResult

The List operation gets information about the vaults associated with the subscription.

will be added to the HTTP request.

response.

Parameters:

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

    Maximum number of results to return.

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

    A hash of custom headers that

Returns:

  • (ResourceListResult) —

    which provide lazy access to pages of the



722
723
724
725
726
727
728
729
730
731
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 722

def list_as_lazy(top = nil, custom_headers = nil)
  response = list_async(top, 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)
    end
    page
  end
end

#list_async(top = nil, custom_headers = nil) ⇒ Concurrent::Promise

The List operation gets information about the vaults associated with the subscription.

to the HTTP request.

Parameters:

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

    Maximum number of results to return.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 457

def list_async(top = nil, custom_headers = nil)
  filter = 'resourceType eq \'Microsoft.KeyVault/vaults\''
  api_version = '2015-11-01'
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}

  # 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}/resources'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id},
      query_params: {'$filter' => filter,'$top' => top,'api-version' => 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::KeyVault::Mgmt::V2015_06_01::Models::ResourceListResult.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_by_resource_group(resource_group_name, top = nil, custom_headers = nil) ⇒ Array<Vault>

The List operation gets information about the vaults associated with the subscription and within the specified resource group.

the vault belongs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Resource Group to which

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

    Maximum number of results to return.

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

    A hash of custom headers that

Returns:

  • (Array<Vault>) —

    operation results.



334
335
336
337
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 334

def list_by_resource_group(resource_group_name, top = nil, custom_headers = nil)
  first_page = list_by_resource_group_as_lazy(resource_group_name, top, custom_headers)
  first_page.get_all_items
end

#list_by_resource_group_as_lazy(resource_group_name, top = nil, custom_headers = nil) ⇒ VaultListResult

The List operation gets information about the vaults associated with the subscription and within the specified resource group.

the vault belongs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Resource Group to which

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

    Maximum number of results to return.

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

    A hash of custom headers that

Returns:

  • (VaultListResult) —

    which provide lazy access to pages of the response.



700
701
702
703
704
705
706
707
708
709
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 700

def list_by_resource_group_as_lazy(resource_group_name, top = nil, custom_headers = nil)
  response = list_by_resource_group_async(resource_group_name, top, custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_resource_group_next_async(next_page_link, custom_headers)
    end
    page
  end
end

#list_by_resource_group_async(resource_group_name, top = nil, custom_headers = nil) ⇒ Concurrent::Promise

The List operation gets information about the vaults associated with the subscription and within the specified resource group.

the vault belongs. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Resource Group to which

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

    Maximum number of results to return.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 367

def list_by_resource_group_async(resource_group_name, top = nil, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}

  # 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'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'subscriptionId' => @client.subscription_id},
      query_params: {'$top' => top,'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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::KeyVault::Mgmt::V2015_06_01::Models::VaultListResult.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_by_resource_group_next(next_page_link, custom_headers = nil) ⇒ VaultListResult

The List operation gets information about the vaults associated with the subscription and within the specified resource group.

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:

  • (VaultListResult) —

    operation results.



519
520
521
522
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 519

def list_by_resource_group_next(next_page_link, custom_headers = nil)
  response = list_by_resource_group_next_async(next_page_link, custom_headers).value!
  response.body unless response.nil?
end

#list_by_resource_group_next_async(next_page_link, custom_headers = nil) ⇒ Concurrent::Promise

The List operation gets information about the vaults associated with the subscription and within the specified resource group.

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.



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
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 550

def list_by_resource_group_next_async(next_page_link, custom_headers = nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


  request_headers = {}

  # 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::KeyVault::Mgmt::V2015_06_01::Models::VaultListResult.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_by_resource_group_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The List operation gets information about the vaults associated with the subscription and within the specified resource group.

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.



535
536
537
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 535

def list_by_resource_group_next_with_http_info(next_page_link, custom_headers = nil)
  list_by_resource_group_next_async(next_page_link, custom_headers).value!
end

#list_by_resource_group_with_http_info(resource_group_name, top = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The List operation gets information about the vaults associated with the subscription and within the specified resource group.

the vault belongs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the Resource Group to which

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

    Maximum number of results to return.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



351
352
353
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 351

def list_by_resource_group_with_http_info(resource_group_name, top = nil, custom_headers = nil)
  list_by_resource_group_async(resource_group_name, top, custom_headers).value!
end

#list_next(next_page_link, custom_headers = nil) ⇒ ResourceListResult

The List operation gets information about the vaults associated with the subscription.

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:

  • (ResourceListResult) —

    operation results.



609
610
611
612
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 609

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

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

The List operation gets information about the vaults associated with the subscription.

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.



640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 640

def list_next_async(next_page_link, custom_headers = nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


  request_headers = {}

  # 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::KeyVault::Mgmt::V2015_06_01::Models::ResourceListResult.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

The List operation gets information about the vaults associated with the subscription.

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.



625
626
627
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 625

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

#list_with_http_info(top = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The List operation gets information about the vaults associated with the subscription.

will be added to the HTTP request.

Parameters:

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

    Maximum number of results to return.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



443
444
445
 
# File 'lib/2015-06-01/generated/azure_mgmt_key_vault/vaults.rb', line 443

def list_with_http_info(top = nil, custom_headers = nil)
  list_async(top, custom_headers).value!
end