azure.azcollection.azure_rm_keyvault_info – Get Azure Key Vault 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_keyvault_info
.
New in version 0.1.2: of azure.azcollection
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 |
Comments |
---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: “latest” |
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
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 Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal. |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: “AzureCloud” |
|
Parent argument. |
|
Parent argument. |
|
The name of the key vault. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
The name of the resource group to which the key vault belongs. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Your Azure subscription Id. |
|
Limit results by providing a list of tags. Format tags as ‘key’ or ‘key:value’. |
|
Azure tenant ID. 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 Key Vault by name
azure_rm_keyvault_info:
resource_group: myResourceGroup
name: myVault
- name: List Key Vaults in specific resource group
azure_rm_keyvault_info:
resource_group: myResourceGroup
- name: List Key Vaults in current subscription
azure_rm_keyvault_info:
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of Azure Key Vaults. Returned: always |
|
List of policies. Returned: always |
|
The object if of a user, service principal or security group in AAD for the vault. Returned: always Sample: “xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx” |
|
Permissions the identity has for keys, secrets and certificates. Returned: always |
|
Permissions to secrets. Returned: always Sample: [“get”, “import”] |
|
Permissions to keys. Returned: always Sample: [“get”, “create”] |
|
Permissions to secrets. Returned: always Sample: [“list”, “set”] |
|
The AAD tenant iD that should be used for authenticating requests to the key vault. Returned: always Sample: “xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx” |
|
Property specifying whether protection against purge is enabled for this vault. Returned: always Sample: false |
|
Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. Returned: always Sample: true |
|
Whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. Returned: always Sample: false |
|
Whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. Returned: always Sample: false |
|
Whether Azure Resource Manager is permitted to retrieve secrets from the key vault. Returned: always Sample: false |
|
Resource Id of the vault. Returned: always Sample: “/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault” |
|
Location of the vault. Returned: always Sample: “eastus” |
|
Name of the vault. Returned: always Sample: “myVault” |
|
Sku of the vault. Returned: always |
|
Sku family name. Returned: always Sample: “A” |
|
Sku name. Returned: always Sample: “standard” |
|
List of tags. Returned: success Sample: [“foo”] |
|
Authors
Yunge Zhu (@yungezz)