ansible / ansible.builtin / v2.9.17 / module / azure_rm_keyvaultkey_info Get Azure Key Vault key facts. | "added in version" 2.9 of ansible.builtin" Authors: Yunge Zhu (@yungezz) preview | supported by communityansible.builtin.azure_rm_keyvaultkey_info (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
Get facts of Azure Key Vault key.
- 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
name: description: - Key name. If not set, will list all keys in vault_uri. type: str tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. type: list secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str tenant: description: - Azure tenant ID. Use when authenticating with a Service Principal. type: str ad_user: description: - Active Directory username. Use when authenticating with an Active Directory user rather than service principal. type: str profile: description: - Security profile found in ~/.azure/credentials file. type: str version: default: current description: - Key version. - Set it to C(current) to show latest version of a key. - Set it to C(all) to list all versions of a key. - Set it to specific version to list specific version of a key. eg. fd2682392a504455b79c90dd04a1bf46 type: str password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. type: str client_id: description: - Azure client ID. Use when authenticating with a Service Principal. type: str vault_uri: description: - Vault uri where the key stored in. required: true type: str api_profile: default: latest description: - Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. type: str version_added: 0.0.1 version_added_collection: azure.azcollection auth_source: choices: - auto - cli - credential_file - env - msi default: auto description: - Controls the source of the credentials to use for authentication. - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. - When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli). - When set to C(env), the credentials will be read from the environment variables - When set to C(credential_file), it will read the profile from C(~/.azure/credentials). - When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6. type: str version_added: 0.0.1 version_added_collection: azure.azcollection subscription_id: description: - Your Azure subscription Id. type: str show_deleted_key: default: false description: - Set to true to show deleted keys. Set to False to show not deleted keys. type: bool cloud_environment: default: AzureCloud description: - For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection adfs_authority_url: description: - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. type: str version_added: 0.0.1 version_added_collection: azure.azcollection cert_validation_mode: choices: - ignore - validate description: - 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 C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection
keyvaults: contains: attributes: contains: created: description: - Creation datetime. returned: always sample: '2019-04-25T07:26:49+00:00' type: str enabled: description: - Indicate whether the key is enabled. returned: always sample: true type: str expires: description: - Expiration datetime. sample: '2019-04-25T07:26:49+00:00' type: str not_before: description: - Not before datetime. sample: '2019-04-25T07:26:49+00:00' type: str recovery_level: description: - 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 type: str updated: description: - Update datetime. returned: always sample: '2019-04-25T07:26:49+00:00' type: str description: - Key attributes. key: contains: crv: description: Elliptic curve name. type: str e: description: RSA public exponent. type: str n: description: RSA modules. type: str x: description: X component of an EC public key. type: str y: description: Y component of an EC public key. type: str description: public part of a key. kid: description: Key identifier. returned: always sample: https://myVault.vault.azure.net/keys/key1/fd2682392a504455b79c90dd04a1bf46 type: str managed: description: - True if the key's lifetime is managed by key vault. sample: true type: bool permitted_operations: description: - Permitted operations on the key returned: always sample: encrypt type: list tags: description: - Tags of the key. returned: always sample: foo type: list type: description: Key type. returned: always sample: RSA type: str version: description: Key version. returned: always sample: fd2682392a504455b79c90dd04a1bf46 type: str description: List of keys in Azure Key Vault. returned: always type: complex