Class: Ansible::Ruby::Modules::Azure_rm_keyvaultkey

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_keyvaultkey.rb

Overview

Create or delete a key within a given keyvault. By using Key Vault, you can encrypt keys and secrets (such as authentication keys, storage account keys, data encryption keys, .PFX files, and passwords).

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#byok_file ⇒ Object?

Returns BYOK file.

Returns:

  • (Object, nil) —

    BYOK file.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_keyvaultkey.rb', line 20

attribute :byok_file

#key_name ⇒ String

Returns Name of the keyvault key.

Returns:

  • (String) —

    Name of the keyvault key.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_keyvaultkey.rb', line 16

attribute :key_name

#keyvault_uri ⇒ String

Returns URI of the keyvault endpoint.

Returns:

  • (String) —

    URI of the keyvault endpoint.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_keyvaultkey.rb', line 12

attribute :keyvault_uri

#pem_file ⇒ Object?

Returns PEM file.

Returns:

  • (Object, nil) —

    PEM file.



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_keyvaultkey.rb', line 23

attribute :pem_file

#pem_password ⇒ Object?

Returns PEM password.

Returns:

  • (Object, nil) —

    PEM password.



26
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_keyvaultkey.rb', line 26

attribute :pem_password

#state ⇒ :absent, ...

Returns Assert the state of the key. Use ‘present’ to create a key and ‘absent’ to delete a key.

Returns:

  • (:absent, :present, nil) —

    Assert the state of the key. Use ‘present’ to create a key and ‘absent’ to delete a key.



29
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_keyvaultkey.rb', line 29

attribute :state