Class: Azure::KeyVault::Mgmt::V2016_10_01::Vaults

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2016-10-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/2016-10-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/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 23

def client
  @client
end

Instance Method Details

#begin_purge_deleted(vault_name, location, custom_headers: nil) ⇒ Object

Permanently deletes the specified vault. aka Purges the deleted Azure key vault.

will be added to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the soft-deleted vault.

  • location (String) —

    The location of the soft-deleted vault.

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

    A hash of custom headers that



1191
1192
1193
1194
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1191

def begin_purge_deleted(vault_name, location, custom_headers:nil)
  response = begin_purge_deleted_async(vault_name, location, custom_headers:custom_headers).value!
  nil
end

#begin_purge_deleted_async(vault_name, location, custom_headers: nil) ⇒ Concurrent::Promise

Permanently deletes the specified vault. aka Purges the deleted Azure key vault.

to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the soft-deleted vault.

  • location (String) —

    The location of the soft-deleted vault.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1222

def begin_purge_deleted_async(vault_name, location, custom_headers:nil)
  fail ArgumentError, 'vault_name is nil' if vault_name.nil?
  fail ArgumentError, 'location is nil' if location.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 = {}
  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}/providers/Microsoft.KeyVault/locations/{location}/deletedVaults/{vaultName}/purge'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'vaultName' => vault_name,'location' => location,'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(: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 || status_code == 202
      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?

    result
  end

  promise.execute
end

#begin_purge_deleted_with_http_info(vault_name, location, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Permanently deletes the specified vault. aka Purges the deleted Azure key vault.

will be added to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the soft-deleted vault.

  • location (String) —

    The location of the soft-deleted vault.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1207
1208
1209
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1207

def begin_purge_deleted_with_http_info(vault_name, location, custom_headers:nil)
  begin_purge_deleted_async(vault_name, location, custom_headers:custom_headers).value!
end

#check_name_availability(vault_name, custom_headers: nil) ⇒ CheckNameAvailabilityResult

Checks that the vault name is valid and is not already in use.

vault. will be added to the HTTP request.

Parameters:

  • vault_name (VaultCheckNameAvailabilityParameters) —

    The name of the

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

    A hash of custom headers that

Returns:

  • (CheckNameAvailabilityResult) —

    operation results.



1091
1092
1093
1094
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1091

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

#check_name_availability_async(vault_name, custom_headers: nil) ⇒ Concurrent::Promise

Checks that the vault name is valid and is not already in use.

vault. to the HTTP request.

Parameters:

  • vault_name (VaultCheckNameAvailabilityParameters) —

    The name of the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1120

def check_name_availability_async(vault_name, custom_headers: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 = {}
  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::V2016_10_01::Models::VaultCheckNameAvailabilityParameters.mapper()
  request_content = @client.serialize(request_mapper,  vault_name)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/checkNameAvailability'

  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: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.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 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::V2016_10_01::Models::CheckNameAvailabilityResult.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

#check_name_availability_with_http_info(vault_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Checks that the vault name is valid and is not already in use.

vault. will be added to the HTTP request.

Parameters:

  • vault_name (VaultCheckNameAvailabilityParameters) —

    The name of the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1106
1107
1108
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1106

def check_name_availability_with_http_info(vault_name, custom_headers:nil)
  check_name_availability_async(vault_name, custom_headers:custom_headers).value!
end

#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/2016-10-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: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
144
145
 
# File 'lib/2016-10-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, "'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?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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::V2016_10_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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.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::Mgmt::V2016_10_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::V2016_10_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/2016-10-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: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



276
277
278
279
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 276

def delete(resource_group_name, vault_name, custom_headers:nil)
  response = delete_async(resource_group_name, vault_name, custom_headers: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.



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
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 307

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 = {}
  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}'

  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.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

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



292
293
294
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 292

def delete_with_http_info(resource_group_name, vault_name, custom_headers:nil)
  delete_async(resource_group_name, vault_name, custom_headers: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.



363
364
365
366
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 363

def get(resource_group_name, vault_name, custom_headers:nil)
  response = get_async(resource_group_name, vault_name, custom_headers: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.



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

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 = {}
  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}'

  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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].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::V2016_10_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_deleted(vault_name, location, custom_headers: nil) ⇒ DeletedVault

Gets the deleted Azure key vault.

will be added to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the vault.

  • location (String) —

    The location of the deleted vault.

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

    A hash of custom headers that

Returns:

  • (DeletedVault) —

    operation results.



865
866
867
868
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 865

def get_deleted(vault_name, location, custom_headers:nil)
  response = get_deleted_async(vault_name, location, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_deleted_async(vault_name, location, custom_headers: nil) ⇒ Concurrent::Promise

Gets the deleted Azure key vault.

to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the vault.

  • location (String) —

    The location of the deleted vault.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 894

def get_deleted_async(vault_name, location, custom_headers:nil)
  fail ArgumentError, 'vault_name is nil' if vault_name.nil?
  fail ArgumentError, 'location is nil' if location.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 = {}
  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}/providers/Microsoft.KeyVault/locations/{location}/deletedVaults/{vaultName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'vaultName' => vault_name,'location' => location,'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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].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::V2016_10_01::Models::DeletedVault.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_deleted_with_http_info(vault_name, location, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the deleted Azure key vault.

will be added to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the vault.

  • location (String) —

    The location of the deleted vault.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



880
881
882
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 880

def get_deleted_with_http_info(vault_name, location, custom_headers:nil)
  get_deleted_async(vault_name, location, custom_headers:custom_headers).value!
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.



379
380
381
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 379

def get_with_http_info(resource_group_name, vault_name, custom_headers:nil)
  get_async(resource_group_name, vault_name, custom_headers: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.



998
999
1000
1001
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 998

def list(top:nil, custom_headers:nil)
  first_page = list_as_lazy(top:top, custom_headers: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



1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1711

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



1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1027

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 = {}
  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}/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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].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::V2016_10_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.



590
591
592
593
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 590

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:top, custom_headers: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.



1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1648

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:top, custom_headers: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: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.



623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 623

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 = {}
  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'

  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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].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::V2016_10_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.



1278
1279
1280
1281
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1278

def list_by_resource_group_next(next_page_link, custom_headers:nil)
  response = list_by_resource_group_next_async(next_page_link, custom_headers: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.



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
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1309

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 = {}
  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::V2016_10_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.



1294
1295
1296
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1294

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



607
608
609
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 607

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:top, custom_headers:custom_headers).value!
end

#list_by_subscription(top: nil, custom_headers: nil) ⇒ Array<Vault>

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<Vault>) —

    operation results.



687
688
689
690
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 687

def list_by_subscription(top:nil, custom_headers:nil)
  first_page = list_by_subscription_as_lazy(top:top, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_subscription_as_lazy(top: nil, custom_headers: nil) ⇒ VaultListResult

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:

  • (VaultListResult) —

    which provide lazy access to pages of the response.



1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1669

def list_by_subscription_as_lazy(top:nil, custom_headers:nil)
  response = list_by_subscription_async(top:top, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_subscription_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_subscription_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.



716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 716

def list_by_subscription_async(top:nil, custom_headers: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 = {}
  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}/providers/Microsoft.KeyVault/vaults'

  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: {'$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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].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::V2016_10_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_subscription_next(next_page_link, custom_headers: nil) ⇒ VaultListResult

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:

  • (VaultListResult) —

    operation results.



1371
1372
1373
1374
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1371

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

#list_by_subscription_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.



1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1402

def list_by_subscription_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::V2016_10_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_subscription_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.



1387
1388
1389
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1387

def list_by_subscription_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_subscription_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_subscription_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.



702
703
704
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 702

def list_by_subscription_with_http_info(top:nil, custom_headers:nil)
  list_by_subscription_async(top:top, custom_headers:custom_headers).value!
end

#list_deleted(custom_headers: nil) ⇒ Array<DeletedVault>

Gets information about the deleted vaults in a subscription.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (Array<DeletedVault>) —

    operation results.



777
778
779
780
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 777

def list_deleted(custom_headers:nil)
  first_page = list_deleted_as_lazy(custom_headers:custom_headers)
  first_page.get_all_items
end

#list_deleted_as_lazy(custom_headers: nil) ⇒ DeletedVaultListResult

Gets information about the deleted vaults in a subscription.

will be added to the HTTP request.

response.

Parameters:

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

    A hash of custom headers that

Returns:

  • (DeletedVaultListResult) —

    which provide lazy access to pages of the



1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1689

def list_deleted_as_lazy(custom_headers:nil)
  response = list_deleted_async(custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_deleted_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_deleted_async(custom_headers: nil) ⇒ Concurrent::Promise

Gets information about the deleted vaults in a subscription.

to the HTTP request.

Parameters:

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 802

def list_deleted_async(custom_headers: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 = {}
  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}/providers/Microsoft.KeyVault/deletedVaults'

  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: {'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::V2016_10_01::Models::DeletedVaultListResult.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_deleted_next(next_page_link, custom_headers: nil) ⇒ DeletedVaultListResult

Gets information about the deleted vaults in a 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:

  • (DeletedVaultListResult) —

    operation results.



1463
1464
1465
1466
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1463

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

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

Gets information about the deleted vaults in a 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.



1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1492

def list_deleted_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::V2016_10_01::Models::DeletedVaultListResult.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_deleted_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets information about the deleted vaults in a 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.



1478
1479
1480
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1478

def list_deleted_next_with_http_info(next_page_link, custom_headers:nil)
  list_deleted_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_deleted_with_http_info(custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets information about the deleted vaults in a subscription.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



790
791
792
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 790

def list_deleted_with_http_info(custom_headers:nil)
  list_deleted_async(custom_headers: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.



1554
1555
1556
1557
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1554

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

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.



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
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1585

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



1570
1571
1572
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1570

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



1013
1014
1015
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 1013

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

#purge_deleted(vault_name, location, custom_headers: nil) ⇒ Object

Permanently deletes the specified vault. aka Purges the deleted Azure key vault.

will be added to the HTTP request.

Parameters:

  • vault_name (String) —

    The name of the soft-deleted vault.

  • location (String) —

    The location of the soft-deleted vault.

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

    A hash of custom headers that



958
959
960
961
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 958

def purge_deleted(vault_name, location, custom_headers:nil)
  response = purge_deleted_async(vault_name, location, custom_headers:custom_headers).value!
  nil
end

#purge_deleted_async(vault_name, location, custom_headers: nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • vault_name (String) —

    The name of the soft-deleted vault.

  • location (String) —

    The location of the soft-deleted vault.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 972

def purge_deleted_async(vault_name, location, custom_headers:nil)
  # Send request
  promise = begin_purge_deleted_async(vault_name, location, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#update(resource_group_name, vault_name, parameters, custom_headers: nil) ⇒ Vault

Update a key vault in the specified subscription.

the server belongs. 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 (VaultPatchParameters) —

    Parameters to patch the vault

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

    A hash of custom headers that

Returns:

  • (Vault) —

    operation results.



159
160
161
162
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 159

def update(resource_group_name, vault_name, parameters, custom_headers:nil)
  response = update_async(resource_group_name, vault_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_access_policy(resource_group_name, vault_name, operation_kind, parameters, custom_headers: nil) ⇒ VaultAccessPolicyParameters

Update access policies in a key vault in the specified subscription.

the vault belongs. Possible values include: ‘add’, ‘replace’, ‘remove’ 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

  • operation_kind (AccessPolicyUpdateKind) —

    Name of the operation.

  • parameters (VaultAccessPolicyParameters) —

    Access policy to merge into

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

    A hash of custom headers that

Returns:

  • (VaultAccessPolicyParameters) —

    operation results.



464
465
466
467
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 464

def update_access_policy(resource_group_name, vault_name, operation_kind, parameters, custom_headers:nil)
  response = update_access_policy_async(resource_group_name, vault_name, operation_kind, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_access_policy_async(resource_group_name, vault_name, operation_kind, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Update access policies in a key vault in the specified subscription.

the vault belongs. Possible values include: ‘add’, ‘replace’, ‘remove’ 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

  • operation_kind (AccessPolicyUpdateKind) —

    Name of the operation.

  • parameters (VaultAccessPolicyParameters) —

    Access policy to merge into

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 503

def update_access_policy_async(resource_group_name, vault_name, operation_kind, 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, "'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, 'operation_kind is nil' if operation_kind.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 = {}
  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::V2016_10_01::Models::VaultAccessPolicyParameters.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}/accessPolicies/{operationKind}'

  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,'operationKind' => operation_kind,'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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.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::Mgmt::V2016_10_01::Models::VaultAccessPolicyParameters.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::V2016_10_01::Models::VaultAccessPolicyParameters.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

#update_access_policy_with_http_info(resource_group_name, vault_name, operation_kind, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Update access policies in a key vault in the specified subscription.

the vault belongs. Possible values include: ‘add’, ‘replace’, ‘remove’ 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

  • operation_kind (AccessPolicyUpdateKind) —

    Name of the operation.

  • parameters (VaultAccessPolicyParameters) —

    Access policy to merge into

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



484
485
486
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 484

def update_access_policy_with_http_info(resource_group_name, vault_name, operation_kind, parameters, custom_headers:nil)
  update_access_policy_async(resource_group_name, vault_name, operation_kind, parameters, custom_headers:custom_headers).value!
end

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

Update a key vault in the specified subscription.

the server belongs. 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 (VaultPatchParameters) —

    Parameters to patch the vault

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 192

def 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, "'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?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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::V2016_10_01::Models::VaultPatchParameters.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(: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 == 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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.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::Mgmt::V2016_10_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::V2016_10_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

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

Update a key vault in the specified subscription.

the server belongs. 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 (VaultPatchParameters) —

    Parameters to patch the vault

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



176
177
178
 
# File 'lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb', line 176

def update_with_http_info(resource_group_name, vault_name, parameters, custom_headers:nil)
  update_async(resource_group_name, vault_name, parameters, custom_headers:custom_headers).value!
end