Try SpotterGet Azure Deployment facts
Authors: Zim Kalinowski (@zikalino)
preview | supported by community
Install with ansible-galaxy collection install community.azure:==0.1.0
collections:
- name: community.azure
version: 0.1.0Get facts of Azure Deployment.
- name: Get instance of Deployment
azure_rm_deployment_info:
resource_group: myResourceGroup
name: myDeployment
name:
description:
- The name of the deployment.
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
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
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: '2.5'
version_added_collection: azure.azcollection
auth_source:
choices:
- auto
- cli
- credential_file
- env
- msi
description:
- Controls the source of the credentials to use for authentication.
- If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and
default to C(auto) if variable is not defined.
- C(auto) will follow the default precedence of module parameters -> environment variables
-> default profile in credential file C(~/.azure/credentials).
- When set to C(cli), the credentials will be sources from the default Azure CLI profile.
- Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
- 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: '2.5'
version_added_collection: azure.azcollection
resource_group:
description:
- The name of the resource group.
required: true
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: '2.4'
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: '2.6'
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: '2.5'
version_added_collection: azure.azcollection
deployments:
contains:
id:
description:
- The identifier of the resource.
returned: always
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/myDeployment
type: str
name:
description:
- Deployment name.
returned: always
sample: myDeployment
output_resources:
contains:
depends_on:
description:
- List of resource ids.
returned: always
sample:
- /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGropup/providers/Microsoft.Network/virtualNet
works/myVirtualNetwork
type: list
id:
description:
- Resource id.
returned: always
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkI
nterfaces/myNetworkInterface
type: str
name:
description:
- Resource name.
returned: always
sample: myNetworkInterface
type: str
type:
description:
- Resource type.
returned: always
sample: Microsoft.Network/networkInterfaces
type: str
description:
- List of resources.
returned: always
type: complex
outputs:
description:
- Dictionary containing deployment outputs.
returned: always
parameters:
description:
- Dictionary containing deployment parameters.
returned: always
type: complex
provisioning_state:
description:
- Provisioning state of the deployment.
returned: always
sample: Succeeded
resource_group:
description:
- Resource group name.
returned: always
sample: myResourceGroup
template_link:
description:
- Link to the template.
returned: always
sample: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/d01a5c06f4f1bc03a049ca17bbbd6e06d62657b3/101-vm-simple-linux/
azuredeploy.json
description:
- A list of dictionaries containing facts for deployments.
returned: always
type: complex