azure.azcollection.azure_rm_keyvaultcertificate module – Managed keyvault certificate

Note

This module is part of the azure.azcollection collection (version 3.8.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_keyvaultcertificate.

New in azure.azcollection 3.4.0

Synopsis

  • Managed keyvault certificate.

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"

append_tags

boolean

Use to control if tags field is canonical or just appends to existing tags.

When canonical, any tags not found in the tags parameter will be removed from the object’s metadata.

Choices:

  • false

  • true ← (default)

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_data

string

Aan existing valid certificate, containing a private key, into Azure Key Vault.

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

enabled

boolean

Whether the certificate is enabled for use.

Choices:

  • false

  • true

log_mode

string

Parent argument.

log_path

string

Parent argument.

name

string / required

Certificate name.

password

string

If the private key in the passed in certificate is encrypted, it is the password used for encryption.

policy

dictionary

The management policy for the certificate.

When generating a new certificate, if no policy is set, the default policy will be used.

certificate_transparency

boolean

Indicates if the certificates generated under this policy should be published to certificate transparency logs.

Choices:

  • false

  • true

certificate_type

string

Type of certificate to be requested from the issuer provider.

content_type

string

he media type (MIME type) of the secret backing the certificate.

Choices:

  • "application/x-pkcs12" ← (default)

  • "application/x-pem-file"

enhanced_key_usage

list / elements=string

The extended ways the key of the certificate can be used.

exportable

boolean

Indicates if the private key can be exported. For valid values, see KeyType.

Choices:

  • false

  • true

issuer_name

string

Name of the referenced issuer object or reserved names. For example self and unknown.

Choices:

  • "self"

  • "unknown"

key_curve_name

string

Elliptic curve name. For valid values, see KeyCurveName.

Choices:

  • "P-256"

  • "P-384"

  • "P-521"

  • "P-256K"

key_size

integer

The key size in bits. For example 2048, 3072, or 4096 for RSA.

key_type

string

The type of key pair to be used for the certificate.

Choices:

  • "EC"

  • "EC-HSM"

  • "RSA"

  • "RSA-HSM"

  • "oct"

  • "oct-HSM"

key_usage

list / elements=string

The extended ways the key of the certificate can be used.

Choices:

  • "digitalSignature"

  • "nonRepudiation"

  • "keyEncipherment"

  • "dataEncipherment"

  • "keyAgreement"

  • "keyCertSign"

  • "cRLSign"

  • "encipherOnly"

  • "decipherOnly"

lifetime_actions

list / elements=dictionary

Actions that will be performed by Key Vault over the lifetime of a certificate.

action

string

The type of the action.

Choices:

  • "EmailContacts"

  • "AutoRenew"

days_before_expiry

integer

Days before expiry to attempt renewal.

Value should be between 1 and `validity_in_months` multiplied by 27.

If validity_in_months is 36, then value should be between 1 and 972 (36 * 27).

lifetime_percentage

integer

Percentage of lifetime at which to trigger. Value should be between 1 and 99.

reuse_key

boolean

Indicates if the same key pair will be used on certificate renewal.

Choices:

  • false

  • true

san_dns_names

list / elements=string

Subject alternative DNS names of the X509 object.

Either subject or one of the subject alternative name parameters are required for creating a certificate.

san_emails

list / elements=string

Subject alternative emails of the X509 object.

Either subject or one of the subject alternative name parameters are required for creating a certificate.

san_user_principal_names

list / elements=string

Subject alternative user principal names of the X509 object.

Either subject or one of the subject alternative name parameters are required for creating a certificate.

subject

string

The subject name of the certificate. Should be a valid X509 distinguished name.

Either subject or one of the subject alternative name parameters are required for creating a certificate.

This will be ignored when importing a certificate; the subject will be parsed from the imported certificate.

validity_in_months

integer

The duration that the certificate is valid in months.

profile

string

Security profile found in ~/.azure/credentials file.

secret

string

Azure client secret. Use when authenticating with a Service Principal.

state

string / required

State of the keyvault certificate.

Choices:

  • "generate"

  • "import"

  • "delete"

  • "purge"

  • "recover"

  • "merge"

  • "update"

subscription_id

string

Your Azure subscription Id.

tags

dictionary

Dictionary of string:string pairs to assign as metadata to the object.

Metadata tags on the object will be updated with any provided values.

To remove tags set append_tags option to false.

Currently, Azure DNS zones and Traffic Manager services also don’t allow the use of spaces in the tag.

Azure Front Door doesn’t support the use of

Azure Automation and Azure CDN only support 15 tags on resources.

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 certificate stored in.

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: Import a keyvault certificate
  azure_rm_keyvaultcertificate:
    vault_uri: https://vault{{ rpfx }}.vault.azure.net
    name: fredcerticate
    enabled: true
    password: Password@****
    cert_data: "{{ lookup('file', 'cert.pem') }}"
    state: import
    tags:
      key1: value1

- name: Generate a keyvault certificate
  azure_rm_keyvaultcertificate:
    vault_uri: https://vault{{ rpfx }}.vault.azure.net
    name: fredcerticate
    policy:
      subject: 'CN=Anhui02'
      issuer_name: self
      exportable: true
      key_type: RSA
      key_size: 2048
      san_emails:
        - [email protected]
      content_type: 'application/x-pkcs12'
      validity_in_months: 36
      lifetime_actions:
        - action: EmailContacts
          days_before_expiry: 10
    enabled: true
    state: generate


- name: Update the keyvault certificate
  azure_rm_keyvaultcertificate:
    vault_uri: https://vault{{ rpfx }}.vault.azure.net
    name: fredcerticate
    policy:
      subject: 'CN=Anhui'
      issuer_name: self
      exportable: true
      key_type: RSA
      key_size: 2048
      san_emails:
        - [email protected]
      content_type: 'application/x-pkcs12'
      validity_in_months: 36
      lifetime_actions:
        - action: EmailContacts
          days_before_expiry: 10
    enabled: true
    state: update

- name: Purge the keyvault certificate
  azure_rm_keyvaultcertificate:
    vault_uri: https://vault{{ rpfx }}.vault.azure.net
    name: fredcerticate
    state: purge

- name: Recover the keyvault certificate
  azure_rm_keyvaultcertificate:
    vault_uri: https://vault{{ rpfx }}.vault.azure.net
    name: fredcerticate
    state: recover

- name: Delete the keyvault certificate
  azure_rm_keyvaultcertificate:
    vault_uri: https://vault{{ rpfx }}.vault.azure.net
    name: fredcerticate
    state: absent

Return Values

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

Key

Description

certificates

complex

The facts of certificates in Azure Key Vault.

Returned: always

cert_data

string

CER contents of the X509 certificate.

Returned: always

Sample: "MIID*****************0pRjXE"

deleted_on

string

The time when the certificate was deleted, in UTC.

Returned: always

Sample: "2025-01-14T09\""

name

string

The name of the certificate.

Returned: always

Sample: "testcert"

policy

complex

The management policy of the deleted certificate.

Returned: always

attributes

complex

Certificate attributes.

Returned: always

created

string

Creation datetime.

Returned: always

Sample: "2025-01-14T09:41:20+00:00"

enabled

string

Indicate whether the certificate is enabled.

Returned: always

Sample: "True"

expires

string

Expiration datetime.

Returned: success

Sample: "None"

not_before

string

Not before datetime.

Returned: success

Sample: "None"

recoverable_days

integer

Reflects the deletion recovery days.

Returned: always

Sample: "None"

recovery_level

string

Reflects the deletion recovery level currently in effect for certificates in the current vault.

If it contains ‘Purgeable’ the certificate can be permanently deleted by a privileged user,

Otherwise, only the system can purge the certificate, at the end of the retention interval.

Returned: always

Sample: "None"

updated

string

Update datetime.

Returned: always

Sample: "2025-01-15T09:41:20+00:00"

certificate_transparency

boolean

Indicates if the certificates generated under this policy should be published to certificate transparency logs.

Returned: always

Sample: "None"

certificate_type

string

Type of certificate to be requested from the issuer provider.

Returned: str

Sample: "None"

content_type

string

If not specified, the media type (MIME type) of the secret backing the certificate.

Returned: always

Sample: "application/x-pkcs12"

enhanced_key_usage

list / elements=string

The extended ways the key of the certificate can be used.

Returned: always

Sample: ["1.3.6.1.5.5.7.3.1", "1.3.6.1.5.5.7.3.2"]

exportable

boolean

Indicates if the private key can be exported.

Returned: always

Sample: true

issuer_name

string

Name of the referenced issuer object or reserved names.

Returned: always

Sample: "Self"

key_curve_name

string

Elliptic curve name. For valid values, see KeyCurveName.

Returned: always

Sample: "None"

key_size

integer

The key size in bits.

Returned: always

Sample: 2048

key_type

string

The type of key pair to be used for the certificate.

Returned: always

Sample: "RSA"

key_usage

list / elements=string

List of key usages.

Returned: always

Sample: ["digitalSignature", "keyEncipherment"]

lifetime_actions

list / elements=string

Actions that will be performed by Key Vault over the lifetime of a certificate.

Returned: always

Sample: [{"action": "AutoRenew", "days_before_expiry": "None", "lifetime_percentage": 80}]

reuse_key

boolean

Indicates if the same key pair will be used on certificate renewal.

Returned: always

Sample: false

san_dns_names

string

Subject alternative DNS names of the X509 object.

Either subject or one of the subject alternative name parameters are required for creating a certificate.

Returned: always

Sample: "None"

san_emails

string

Subject alternative emails of the X509 object.

Either subject or one of the subject alternative name parameters are required for creating a certificate.

Returned: always

Sample: "None"

san_user_principal_names

string

Subject alternative user principal names of the X509 object.

Either subject or one of the subject alternative name parameters are required for creating a certificate.

Returned: always

Sample: "None"

subject

string

The subject name of the certificate.

Should be a valid X509 distinguished name.

Either subject or one of the subject alternative name parameters are required for creating a certificate.

This will be ignored when importing a certificate; the subject will be parsed from the imported certificate.

Returned: always

Sample: "CN=anhui.com"

validity_in_months

integer

The duration that the certificate is valid in months.

Returned: always

Sample: 12

properties

complex

The certificate’s properties.

Returned: always

attributes

complex

Certificate attributes.

Returned: always

created

string

Creation datetime.

Returned: always

Sample: "2025-01-14T09"

enabled

string

Indicate whether the certificate is enabled.

Returned: always

Sample: "True"

expires

string

Expiration datetime.

Returned: success

Sample: "2025-03-14T09"

not_before

string

Not before datetime.

Returned: success

Sample: "2025-02-14T09"

recovery_level

string

Reflects the deletion recovery level currently in effect for certificates in the current vault.

If it contains ‘Purgeable’ the certificate can be permanently deleted by a privileged user,

Otherwise, only the system can purge the certificate, at the end of the retention interval.

Returned: always

Sample: "Recoverable+Purgeable"

updated

string

Update datetime.

Returned: always

Sample: "2025-01-15T09"

id

string

Id of the certificate. If specified all other ‘Id’ arguments should be omitted.

Returned: always

Sample: "https://vaultrfred01.vault.azure.net/certificates/cert02/62409e6304c642f193209729b8360d2c"

tags

dictionary

List of the certificate tags.

Returned: always

Sample: {"key": "value"}

vault_id

string

ID of the Key Vault.

Returned: always

Sample: "https://vaultrfred01.vault.azure.net"

x509_thumbprint

string

The X509 Thumbprint of the Key Vault Certificate represented as a hexadecimal string.

Returned: always

Sample: "1blAnHN9ddng0qh1pYoUDY2lp1E="

recovery_id

string

The url of the recovery object, used to identify and recover the deleted certificate.

Returned: always

Sample: "https://vaultrfred01.vault.azure.net/deletedcertificates/cert02"

scheduled_purge_date

dictionary

The time when the certificate is scheduled to be purged, in UTC.

Returned: always

Sample: "2025-02-14T09\""

Authors

  • xuzhang3 (@xuzhang3)

  • Fred-sun (@Fred-sun)