azure.azcollection.azure_rm_keyvaultkey_info – Get Azure Key Vault key facts

Note

This plugin is part of the azure.azcollection collection (version 1.10.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install azure.azcollection.

To use it in a playbook, specify: azure.azcollection.azure_rm_keyvaultkey_info.

New in version 0.1.2: of azure.azcollection

Synopsis
Requirements
Parameters
Notes
See Also
Examples
Return Values

Synopsis

Get facts of Azure Key Vault key.

Requirements

The below requirements are needed on the host that executes this module.

python >= 2.7
The host that executes this module must have the azure.azcollection collection installed via galaxy
All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection
Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters

Parameter	Choices/Defaults	Comments
ad_user string		Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url string added in 0.0.1 of azure.azcollection		Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string added in 0.0.1 of azure.azcollection	Default: "latest"	Selects an API profile to use when communicating with Azure services. Default value of `latest` is appropriate for public clouds; future values will allow use with Azure Stack.
auth_source string added in 0.0.1 of azure.azcollection	Choices: auto ← cli credential_file env msi	Controls the source of the credentials to use for authentication. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. When set to `auto` (the default) the precedence is module parameters -> `env` -> `credential_file` -> `cli`. When set to `env`, the credentials will be read from the environment variables When set to `credential_file`, it will read the profile from `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the Azure CLI profile. `subscription_id` or the environment variable `AZURE_SUBSCRIPTION_ID` can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used. When set to `msi`, the host machine must be an azure resource with an enabled MSI extension. `subscription_id` or the environment variable `AZURE_SUBSCRIPTION_ID` can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen. The `msi` was added in Ansible 2.6.
cert_validation_mode string added in 0.0.1 of azure.azcollection	Choices: ignore validate	Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing `ignore`. Can also be set via credential file profile or the `AZURE_CERT_VALIDATION` environment variable.
client_id string		Azure client ID. Use when authenticating with a Service Principal.
cloud_environment string added in 0.0.1 of azure.azcollection	Default: "AzureCloud"	For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, `AzureChinaCloud`, `AzureUSGovernment`), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the `AZURE_CLOUD_ENVIRONMENT` environment variable.
log_mode string		Parent argument.
log_path string		Parent argument.
name string		Key name. If not set, will list all keys in vault_uri.
password string		Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile string		Security profile found in ~/.azure/credentials file.
secret string		Azure client secret. Use when authenticating with a Service Principal.
show_deleted_key boolean	Choices: no ← yes	Set to `true` to show deleted keys. Set to `false` to show not deleted keys.
subscription_id string		Your Azure subscription Id.
tags list / elements=string		Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
tenant string		Azure tenant ID. Use when authenticating with a Service Principal.
vault_uri string / required		Vault uri where the key stored in.
version string	Default: "current"	Key version. Set it to `current` to show latest version of a key. Set it to `all` to list all versions of a key. Set it to specific version to list specific version of a key. eg. fd2682392a504455b79c90dd04a1bf46.

Notes

Note

For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.
Authentication is also possible using a service principal or Active Directory user.
To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

Examples

- name: Get latest version of specific key
  azure_rm_keyvaultkey_info:
    vault_uri: "https://myVault.vault.azure.net"
    name: myKey

- name: List all versions of specific key
  azure_rm_keyvaultkey_info:
    vault_uri: "https://myVault.vault.azure.net"
    name: myKey
    version: all

- name: List specific version of specific key
  azure_rm_keyvaultkey_info:
    vault_uri: "https://myVault.vault.azure.net"
    name: myKey
    version: fd2682392a504455b79c90dd04a1bf46

- name: List all keys in specific key vault
  azure_rm_keyvaultkey_info:
      vault_uri: "https://myVault.vault.azure.net"

- name: List deleted keys in specific key vault
  azure_rm_keyvaultkey_info:
      vault_uri: "https://myVault.vault.azure.net"
      show_deleted_key: True

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key			Returned	Description
keyvaults complex			always	List of keys in Azure Key Vault.
	attributes string		success	Key attributes.
		created string	always	Creation datetime. Sample: 2019-04-25T07:26:49+00:00
		enabled string	always	Indicate whether the key is enabled. Sample: True
		expires string	success	Expiration datetime. Sample: 2019-04-25T07:26:49+00:00
		not_before string	success	Not before datetime. Sample: 2019-04-25T07:26:49+00:00
		recovery_level string	always	Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains `Purgeable` the key can be permanently deleted by a privileged user. Otherwise, only the system can purge the key, at the end of the retention interval. Sample: Purgable
		updated string	always	Update datetime. Sample: 2019-04-25T07:26:49+00:00
	key string		success	public part of a key.
		crv string	success	Elliptic curve name.
		e string	success	RSA public exponent.
		n string	success	RSA modules.
		x string	success	X component of an EC public key.
		y string	success	Y component of an EC public key.
	kid string		always	Key identifier. Sample: https://myVault.vault.azure.net/keys/key1/fd2682392a504455b79c90dd04a1bf46
	managed boolean		success	`True` if the key's lifetime is managed by key vault. Sample: True
	permitted_operations list / elements=string		always	Permitted operations on the key. Sample: encrypt
	tags list / elements=string		always	Tags of the key. Sample: ['foo']
	type string		always	Key type. Sample: RSA
	version string		always	Key version. Sample: fd2682392a504455b79c90dd04a1bf46

Authors

Yunge Zhu (@yungezz)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_keyvaultkey_info_module.html