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

Note

This module is part of the azure.azcollection collection (version 3.0.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. You need further requirements to be able to use this module, see Requirements for details.

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

New in azure.azcollection 0.1.2

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

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 azure.azcollection 0.0.1

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

api_profile

string

added in azure.azcollection 0.0.1

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.

Default: "latest"

auth_source

string

added in azure.azcollection 0.0.1

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.

Choices:

  • "auto" ← (default)

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

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.

Choices:

  • "ignore"

  • "validate"

client_id

string

Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi).

Can also be set via the AZURE_CLIENT_ID environment variable.

cloud_environment

string

added in azure.azcollection 0.0.1

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.

Default: "AzureCloud"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy.

Set via credential file profile or the AZURE_DISABLE_INSTANCE_DISCOVERY environment variable.

Choices:

  • false ← (default)

  • true

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

Set to true to show deleted keys. Set to false to show not deleted keys.

Choices:

  • false ← (default)

  • true

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.

thumbprint

string

added in azure.azcollection 1.14.0

The thumbprint of the private key specified in x509_certificate_path.

Use when authenticating with a Service Principal.

Required if x509_certificate_path is defined.

vault_uri

string / required

Vault uri where the key stored in.

version

string

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.

Default: "current"

x509_certificate_path

path

added in azure.azcollection 1.14.0

Path to the X509 certificate used to create the service principal in PEM format.

The certificate must be appended to the private key.

Use when authenticating with a Service Principal.

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.

See Also

See also

Sign in with Azure CLI

How to authenticate using the az login command.

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

Description

keyvaults

complex

List of keys in Azure Key Vault.

Returned: always

attributes

dictionary

Key attributes.

Returned: success

created

string

Creation datetime.

Returned: always

Sample: "2019-04-25T07:26:49+00:00"

enabled

string

Indicate whether the key is enabled.

Returned: always

Sample: "True"

expires

string

Expiration datetime.

Returned: success

Sample: "2019-04-25T07:26:49+00:00"

not_before

string

Not before datetime.

Returned: success

Sample: "2019-04-25T07:26:49+00:00"

recovery_level

string

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.

Returned: always

Sample: "Purgable"

updated

string

Update datetime.

Returned: always

Sample: "2019-04-25T07:26:49+00:00"

key

dictionary

public part of a key.

Returned: success

crv

string

Elliptic curve name.

Returned: success

e

string

RSA public exponent.

Returned: success

n

string

RSA modules.

Returned: success

x

string

X component of an EC public key.

Returned: success

y

string

Y component of an EC public key.

Returned: success

kid

string

Key identifier.

Returned: always

Sample: "https://myVault.vault.azure.net/keys/key1/fd2682392a504455b79c90dd04a1bf46"

managed

boolean

True if the key’s lifetime is managed by key vault.

Returned: success

Sample: true

permitted_operations

list / elements=string

Permitted operations on the key.

Returned: always

Sample: ["encrypt"]

tags

list / elements=string

Tags of the key.

Returned: always

Sample: ["foo"]

type

string

Key type.

Returned: always

Sample: "RSA"

version

string

Key version.

Returned: always

Sample: "fd2682392a504455b79c90dd04a1bf46"

Authors

  • Yunge Zhu (@yungezz)