class Azure::KeyVault::Mgmt::V2016_10_01::Vaults

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

Attributes

client[R]

@return [KeyVaultManagementClient] reference to the KeyVaultManagementClient

Private Class Methods

new(client) click to toggle source

Creates and initializes a new instance of the Vaults class. @param client service class for accessing basic functionality.

# File lib/2016-10-01/generated/azure_mgmt_key_vault/vaults.rb, line 18
def initialize(client)
  @client = client
end

Private Instance Methods

begin_purge_deleted(vault_name, location, custom_headers:nil) click to toggle source

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

@param vault_name [String] The name of the soft-deleted vault. @param location [String] The location of the soft-deleted vault. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

# 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) click to toggle source

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

@param vault_name [String] The name of the soft-deleted vault. @param location [String] The location of the soft-deleted vault. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# 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) click to toggle source

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

@param vault_name [String] The name of the soft-deleted vault. @param location [String] The location of the soft-deleted vault. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# 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) click to toggle source

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

@param vault_name [VaultCheckNameAvailabilityParameters] The name of the vault. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [CheckNameAvailabilityResult] operation results.

# 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) click to toggle source

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

@param vault_name [VaultCheckNameAvailabilityParameters] The name of the vault. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# 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) click to toggle source

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

@param vault_name [VaultCheckNameAvailabilityParameters] The name of the vault. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# 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) click to toggle source

Create or update a key vault in the specified subscription.

@param resource_group_name [String] The name of the Resource Group to which the server belongs. @param vault_name [String] Name of the vault @param parameters [VaultCreateOrUpdateParameters] Parameters to create or update the vault @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Vault] operation results.

# 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) click to toggle source

Create or update a key vault in the specified subscription.

@param resource_group_name [String] The name of the Resource Group to which the server belongs. @param vault_name [String] Name of the vault @param parameters [VaultCreateOrUpdateParameters] Parameters to create or update the vault @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# 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) click to toggle source

Create or update a key vault in the specified subscription.

@param resource_group_name [String] The name of the Resource Group to which the server belongs. @param vault_name [String] Name of the vault @param parameters [VaultCreateOrUpdateParameters] Parameters to create or update the vault @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# 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) click to toggle source

Deletes the specified Azure key vault.

@param resource_group_name [String] The name of the Resource Group to which the vault belongs. @param vault_name [String] The name of the vault to delete @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

# 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) click to toggle source

Deletes the specified Azure key vault.

@param resource_group_name [String] The name of the Resource Group to which the vault belongs. @param vault_name [String] The name of the vault to delete @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# 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) click to toggle source

Deletes the specified Azure key vault.

@param resource_group_name [String] The name of the Resource Group to which the vault belongs. @param vault_name [String] The name of the vault to delete @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# 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) click to toggle source

Gets the specified Azure key vault.

@param resource_group_name [String] The name of the Resource Group to which the vault belongs. @param vault_name [String] The name of the vault. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Vault] operation results.

# 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) click to toggle source

Gets the specified Azure key vault.

@param resource_group_name [String] The name of the Resource Group to which the vault belongs. @param vault_name [String] The name of the vault. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# 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) click to toggle source

Gets the deleted Azure key vault.

@param vault_name [String] The name of the vault. @param location [String] The location of the deleted vault. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [DeletedVault] operation results.

# 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) click to toggle source

Gets the deleted Azure key vault.

@param vault_name [String] The name of the vault. @param location [String] The location of the deleted vault. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# 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) click to toggle source

Gets the deleted Azure key vault.

@param vault_name [String] The name of the vault. @param location [String] The location of the deleted vault. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# 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) click to toggle source

Gets the specified Azure key vault.

@param resource_group_name [String] The name of the Resource Group to which the vault belongs. @param vault_name [String] The name of the vault. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# 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) click to toggle source

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

@param top [Integer] Maximum number of results to return. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Array<Resource>] operation results.

# 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) click to toggle source

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

@param top [Integer] Maximum number of results to return. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [ResourceListResult] which provide lazy access to pages of the response.

# 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) click to toggle source

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

@param top [Integer] Maximum number of results to return. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# 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) click to toggle source

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

@param resource_group_name [String] The name of the Resource Group to which the vault belongs. @param top [Integer] Maximum number of results to return. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Array<Vault>] operation results.

# 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) click to toggle source

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

@param resource_group_name [String] The name of the Resource Group to which the vault belongs. @param top [Integer] Maximum number of results to return. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [VaultListResult] which provide lazy access to pages of the response.

# 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) click to toggle source

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

@param resource_group_name [String] The name of the Resource Group to which the vault belongs. @param top [Integer] Maximum number of results to return. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# 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) click to toggle source

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

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [VaultListResult] operation results.

# 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) click to toggle source

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

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# 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) click to toggle source

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

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# 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) click to toggle source

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

@param resource_group_name [String] The name of the Resource Group to which the vault belongs. @param top [Integer] Maximum number of results to return. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# 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) click to toggle source

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

@param top [Integer] Maximum number of results to return. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Array<Vault>] operation results.

# 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) click to toggle source

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

@param top [Integer] Maximum number of results to return. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [VaultListResult] which provide lazy access to pages of the response.

# 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) click to toggle source

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

@param top [Integer] Maximum number of results to return. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# 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) click to toggle source

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

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [VaultListResult] operation results.

# 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) click to toggle source

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

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# 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) click to toggle source

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

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# 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) click to toggle source

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

@param top [Integer] Maximum number of results to return. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# 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) click to toggle source

Gets information about the deleted vaults in a subscription.

@param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Array<DeletedVault>] operation results.

# 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) click to toggle source

Gets information about the deleted vaults in a subscription.

@param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [DeletedVaultListResult] which provide lazy access to pages of the response.

# 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) click to toggle source

Gets information about the deleted vaults in a subscription.

@param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# 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) click to toggle source

Gets information about the deleted vaults in a subscription.

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [DeletedVaultListResult] operation results.

# 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) click to toggle source

Gets information about the deleted vaults in a subscription.

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# 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) click to toggle source

Gets information about the deleted vaults in a subscription.

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# 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) click to toggle source

Gets information about the deleted vaults in a subscription.

@param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# 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) click to toggle source

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

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [ResourceListResult] operation results.

# 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) click to toggle source

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

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# 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) click to toggle source

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

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# 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) click to toggle source

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

@param top [Integer] Maximum number of results to return. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# 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) click to toggle source

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

@param vault_name [String] The name of the soft-deleted vault. @param location [String] The location of the soft-deleted vault. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

# 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) click to toggle source

@param vault_name [String] The name of the soft-deleted vault. @param location [String] The location of the soft-deleted vault. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] promise which provides async access to http response.

# 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) click to toggle source

Update a key vault in the specified subscription.

@param resource_group_name [String] The name of the Resource Group to which the server belongs. @param vault_name [String] Name of the vault @param parameters [VaultPatchParameters] Parameters to patch the vault @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Vault] operation results.

# 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) click to toggle source

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

@param resource_group_name [String] The name of the Resource Group to which the vault belongs. @param vault_name [String] Name of the vault @param operation_kind [AccessPolicyUpdateKind] Name of the operation. Possible values include: 'add', 'replace', 'remove' @param parameters [VaultAccessPolicyParameters] Access policy to merge into the vault @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [VaultAccessPolicyParameters] operation results.

# 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) click to toggle source

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

@param resource_group_name [String] The name of the Resource Group to which the vault belongs. @param vault_name [String] Name of the vault @param operation_kind [AccessPolicyUpdateKind] Name of the operation. Possible values include: 'add', 'replace', 'remove' @param parameters [VaultAccessPolicyParameters] Access policy to merge into the vault @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# 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) click to toggle source

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

@param resource_group_name [String] The name of the Resource Group to which the vault belongs. @param vault_name [String] Name of the vault @param operation_kind [AccessPolicyUpdateKind] Name of the operation. Possible values include: 'add', 'replace', 'remove' @param parameters [VaultAccessPolicyParameters] Access policy to merge into the vault @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# 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) click to toggle source

Update a key vault in the specified subscription.

@param resource_group_name [String] The name of the Resource Group to which the server belongs. @param vault_name [String] Name of the vault @param parameters [VaultPatchParameters] Parameters to patch the vault @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# 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) click to toggle source

Update a key vault in the specified subscription.

@param resource_group_name [String] The name of the Resource Group to which the server belongs. @param vault_name [String] Name of the vault @param parameters [VaultPatchParameters] Parameters to patch the vault @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# 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