ansible / ansible.builtin / v2.8.19 / module / azure_rm_virtualnetwork_facts Get virtual network facts. | "added in version" 2.1 of ansible.builtin" Authors: Chris Houseknecht (@chouseknecht) <house@redhat.com>, Matt Davis (@nitzmahone) <mdavis@redhat.com> preview | supported by communityansible.builtin.azure_rm_virtualnetwork_facts (v2.8.19) — module
pip
Install with pip install ansible==2.8.19
Get facts for a specific virtual network or all virtual networks within a resource group.
- name: Get facts for one virtual network azure_rm_virtualnetwork_facts: resource_group: myResourceGroup name: secgroup001
- name: Get facts for all virtual networks azure_rm_virtualnetwork_facts: resource_group: myResourceGroup
- name: Get facts by tags azure_rm_virtualnetwork_facts: tags: - testing
name: description: - Only show results for a specific security group. tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. 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 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. 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 resource_group: description: - Limit results by resource group. Required when filtering by name. 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 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
azure_virtualnetworks: description: List of virtual network dicts. example: - etag: W/"532ba1be-ae71-40f2-9232-3b1d9cf5e37e" id: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet2001 location: eastus2 name: vnet2001 properties: addressSpace: addressPrefixes: - 10.10.0.0/16 provisioningState: Succeeded resourceGuid: a7ba285f-f7e7-4e17-992a-de4d39f28612 subnets: [] type: Microsoft.Network/virtualNetworks returned: always type: list virtualnetworks: contains: address_prefixes: description: - List of IPv4 address ranges where each is formatted using CIDR notation. sample: - 10.10.0.0/16 type: list dns_servers: description: - Custom list of DNS servers. sample: - www.azure.com type: list id: description: - Resource ID. sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet2001 type: str location: description: - Valid azure location. sample: eastus type: str name: description: - name of the virtual network. sample: foo type: str provisioning_state: description: - Provisioning state of the resource. sample: Successed type: str subnets: contains: address_prefix: description: - The address prefix for the subnet. id: description: - Resource ID. type: str name: description: - Resource Name. type: str network_security_group: description: - Existing security group id with which to associate the subnet. type: str provisioning_state: description: - provision state of the Resource. sample: Successed type: str route_table: description: - The reference of the RouteTable resource. type: str service_endpoints: description: - An array of service endpoints. type: list description: - Subnets associate to this virtual network. type: list tags: description: - Tags assigned to the resource. Dictionary of string:string pairs. sample: tag1: abc type: dict description: List of virtual network dicts with same format as azure_rm_virtualnetwork module parameters. returned: always type: list