azure.azcollection.azure_rm_virtualhubconnection_info module – Get VirtualHub info
Note
This module is part of the azure.azcollection collection (version 1.14.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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: azure.azcollection.azure_rm_virtualhubconnection_info.
New in azure.azcollection 1.14.0
Synopsis
Get info of VirtualHub.
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: |
|
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: |
|
Parent argument. |
|
Parent argument. |
|
The name of the VirtualHub connection. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
The resource group name of the VirtualHub. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Your Azure subscription Id. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined. |
|
The resource name of the VirtualHub. |
|
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. |
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 logincommand.
Examples
- name: Get virtual hub connection info by name
azure_rm_virtualhubconnection_info:
resource_group: myResourceGroup
virtual_hub_name: virtualHub
name: vhubname
- name: Get virtual hub connection info by resource group
azure_rm_virtualhubconnection_info:
resource_group: myResourceGroup
virtual_hub_name: virtualHub
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A list of dict results for the virtual hub connection info. Returned: always |
|
Enable hub to remote VNet transit. Returned: always Sample: |
|
Allow remote VNet to use hub’s VNet gateways. Returned: always Sample: |
|
Enable internet security and default is enabled. Returned: always Sample: |
|
A unique read-only string that changes whenever the resource is updated. Returned: always Sample: |
|
Resource ID. Returned: always Sample: |
|
Resource name. Returned: always Sample: |
|
The provisioning state of the virtual hub connection resource. Returned: always Sample: |
|
Name of ID of the remote VNet to connect to. Returned: always |
|
The ID of the remote VNet to connect to. Returned: always Sample: |
|
The routing configuration information Returned: always |
|
The resource ID of route table associated with this routing configuration. Returned: always |
|
The ID of the routetable. Returned: always Sample: |
|
Space-separated list of resource id of propagated route tables. Returned: always |
|
The list resource ID of propagated route tables. Returned: always Sample: |
|
Space-separated list of labels for propagated route tables. Returned: always Sample: |
|
The name of the Static Route that is unique within a Vnet Route. Returned: always |
|
The name of the Static Route. Returned: always |
|
Space-separated list of all address prefixes. Returned: always Sample: |
|
The name of static router. Returned: always Sample: |
|
The next hop ip address. Returned: always Sample: |