azure / azure.azcollection / 2.3.0 / module / azure_rm_keyvaultsecret_info Get Azure Key Vault secret facts | "added in version" 0.1.2 of azure.azcollection" Authors: Jose Angel Munoz (@imjoseangel)azure.azcollection.azure_rm_keyvaultsecret_info (2.3.0) — module
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections: - name: azure.azcollection version: 2.3.0
Get facts of Azure Key Vault secret.
- name: Get latest version of specific secret azure_rm_keyvaultsecret_info: vault_uri: "https://myVault.vault.azure.net" name: mySecret
- name: List all versions of specific secret azure_rm_keyvaultsecret_info: vault_uri: "https://myVault.vault.azure.net" name: mySecret version: all
- name: List specific version of specific secret azure_rm_keyvaultsecret_info: vault_uri: "https://myVault.vault.azure.net" name: mySecret version: fd2682392a504455b79c90dd04a1bf46
- name: List all secrets in specific key vault azure_rm_keyvaultsecret_info: vault_uri: "https://myVault.vault.azure.net"
- name: List deleted secrets in specific key vault azure_rm_keyvaultsecret_info: vault_uri: "https://myVault.vault.azure.net" show_deleted_secret: true
name: description: - Secret name. If not set, will list all secrets in vault_uri. type: str tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. elements: str 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: - Secret version. - Set it to C(current) to show latest version of a secret. - Set it to C(all) to list all versions of a secret. - Set it to specific version to list specific version of a secret. eg. fd2682392a504455b79c90dd04a1bf46 type: str log_mode: description: - Parent argument. type: str log_path: description: - Parent argument. 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 or Managed Identity (msi). - Can also be set via the C(AZURE_CLIENT_ID) environment variable. type: str vault_uri: description: - Vault uri where the secret stored in. required: true type: str thumbprint: description: - The thumbprint of the private key specified in I(x509_certificate_path). - Use when authenticating with a Service Principal. - Required if I(x509_certificate_path) is defined. type: str version_added: 1.14.0 version_added_collection: azure.azcollection 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 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 show_deleted_secret: default: false description: - Set to I(show_delete_secret=true) to show deleted secrets. Set to I(show_deleted_secret=false) to show not deleted secrets. type: bool 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 x509_certificate_path: description: - 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. type: path version_added: 1.14.0 version_added_collection: azure.azcollection disable_instance_discovery: default: false description: - 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 C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment variable. type: bool version_added: 2.3.0 version_added_collection: azure.azcollection
secrets: contains: attributes: contains: created: description: - Creation datetime. returned: always sample: '2019-04-25T07:26:49+00:00' type: str enabled: description: - Indicate whether the secret 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 secrets in the current vault. - If it contains 'Purgeable' the secret can be permanently deleted by a privileged user, - Otherwise, only the system can purge the secret, at the end of the retention interval. returned: always sample: Recoverable+Purgeable type: str updated: description: - Update datetime. returned: always sample: '2019-04-25T07:26:49+00:00' type: str description: - Secret attributes. type: dict content_type: description: - Content type (optional) returned: always sample: mysecrettype type: str secret: description: secret value. returned: always sample: mysecretvault type: str sid: description: - Secret identifier. returned: always sample: https://myVault.vault.azure.net/flexsecret/secret1/fd2682392a504455b79c90dd04a1bf46 type: str tags: description: - Tags of the secret. returned: always sample: delete: on-exit type: dict version: description: - Secret version. returned: always sample: fd2682392a504455b79c90dd04a1bf46 type: str description: - List of secrets in Azure Key Vault. returned: always type: complex