Class: Ansible::Ruby::Modules::Azure_rm_keyvault

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Azure_rm_keyvault

Defined in:

lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_keyvault.rb

Overview

Create, update and delete instance of Key Vault.

Instance Method Summary

• #access_policies ⇒ Array<Hash>, ...

  An array of 0 to 16 identities that have access to the key vault.

• #enable_soft_delete ⇒ Symbol^?

  Property to specify whether the soft delete functionality is enabled for this key vault.

• #enabled_for_deployment ⇒ Symbol^?

  Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.

• #enabled_for_disk_encryption ⇒ Symbol^?

  Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.

• #enabled_for_template_deployment ⇒ Symbol^?

  Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.

• #location ⇒ Object^?

  Resource location.

• #recover_mode ⇒ Symbol^?

  Create vault in recovery mode.

• #resource_group ⇒ String

  The name of the Resource Group to which the server belongs.

• #sku ⇒ Hash^?

  SKU details.

• #state ⇒ :absent, ...

  Assert the state of the KeyVault.

• #vault_name ⇒ String

  Name of the vault.

• #vault_tenant ⇒ String^?

  The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#access_policies ⇒ Array<Hash>, ...

Returns An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault’s tenant ID.

Returns:

• (Array<Hash>, Hash, nil) —

  An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault’s tenant ID.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_keyvault.rb', line 31

attribute :access_policies

#enable_soft_delete ⇒ Symbol^?

Returns Property to specify whether the soft delete functionality is enabled for this key vault.

Returns:

• (Symbol, nil) —

  Property to specify whether the soft delete functionality is enabled for this key vault.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_keyvault.rb', line 47

attribute :enable_soft_delete

#enabled_for_deployment ⇒ Symbol^?

Returns Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.

Returns:

• (Symbol, nil) —

  Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_keyvault.rb', line 35

attribute :enabled_for_deployment

#enabled_for_disk_encryption ⇒ Symbol^?

Returns Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.

Returns:

• (Symbol, nil) —

  Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_keyvault.rb', line 39

attribute :enabled_for_disk_encryption

#enabled_for_template_deployment ⇒ Symbol^?

Returns Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.

Returns:

• (Symbol, nil) —

  Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_keyvault.rb', line 43

attribute :enabled_for_template_deployment

#location ⇒ Object^?

Returns Resource location. If not set, location from the resource group will be used as default.

Returns:

• (Object, nil) —

  Resource location. If not set, location from the resource group will be used as default.

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

attribute :location

#recover_mode ⇒ Symbol^?

Returns Create vault in recovery mode.

Returns:

• (Symbol, nil) —

  Create vault in recovery mode.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_keyvault.rb', line 51

attribute :recover_mode

#resource_group ⇒ String

Returns The name of the Resource Group to which the server belongs.

Returns:

• (String) —

  The name of the Resource Group to which the server belongs.

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

attribute :resource_group

#sku ⇒ Hash^?

Returns SKU details.

Returns:

• (Hash, nil) —

  SKU details

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_keyvault.rb', line 27

attribute :sku

#state ⇒ :absent, ...

Returns Assert the state of the KeyVault. Use ‘present’ to create or update an KeyVault and ‘absent’ to delete it.

Returns:

• (:absent, :present, nil) —

  Assert the state of the KeyVault. Use ‘present’ to create or update an KeyVault and ‘absent’ to delete it.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_keyvault.rb', line 55

attribute :state

#vault_name ⇒ String

Returns Name of the vault.

Returns:

• (String) —

  Name of the vault

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

attribute :vault_name

#vault_tenant ⇒ String^?

Returns The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.

Returns:

• (String, nil) —

  The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.

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

attribute :vault_tenant