Try SpotterManage Azure VirtualHub instance
| "added in version" 1.14.0 of azure.azcollection"
Authors: Fred-Sun (@Fred-Sun), Xu Zhang (@xuzhang3)
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections:
- name: azure.azcollection
version: 2.3.0Create, update and delete instance of Azure VirtualHub.
- name: Create virtual hub connection
azure_rm_virtualhubconnection:
resource_group: myRG
vhub_name: testhub
name: Myconnection
enable_internet_security: false
allow_remote_vnet_to_use_hub_vnet_gateways: true
allow_hub_to_remote_vnet_transit: true
remote_virtual_network:
id: /subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/testvnet
routing_configuration:
propagated_route_tables:
labels:
- labels1
- labels3
ids:
- id: /subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualHubs/testhub01/hubRouteTables/testtable
vnet_routes:
static_routes:
- name: route1
address_prefixes:
- 10.1.0.0/16
- 10.2.0.0/16
next_hop_ip_address: 10.0.0.68
- name: route2
address_prefixes:
- 10.4.0.0/16
next_hop_ip_address: 10.0.0.65
- name: Delete virtual hub connection
azure_rm_virtualhubconnection:
resource_group: myRG
vhub_name: testhub
name: Myconnection
state: absent
name:
description:
- The name of the VirtualHub connection.
required: true
type: str
state:
choices:
- absent
- present
default: present
description:
- Assert the state of the VirtualHub connection.
- Use C(present) to create or update an VirtualHub connection and C(absent) to delete
it.
type: str
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 or Managed Identity
(msi).
- Can also be set via the C(AZURE_CLIENT_ID) environment variable.
type: str
vhub_name:
description:
- The VirtualHub name.
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
resource_group:
description:
- The resource group name of the VirtualHub.
required: true
type: str
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
routing_configuration:
description:
- The Routing Configuration indicating the associated and propagated route tables
on this connection.
suboptions:
propagated_route_tables:
description:
- The list of RouteTables to advertise the routes to.
suboptions:
ids:
description: -The list of resource ids of all the virtual hub RouteTables.
elements: dict
suboptions:
id:
description:
- The ID of the RouteTables.
type: str
type: list
labels:
description:
- The list of labels.
elements: str
type: list
type: dict
vnet_routes:
description:
- List of routes that control routing from VirtualHub into a virtual network connection.
suboptions:
static_routes:
description:
- List of all Static Routes.
elements: dict
suboptions:
address_prefixes:
description:
- List of all address prefixes.
elements: str
type: list
name:
description:
- The name of the StaticRoute that is unique within a VnetRoute.
type: str
next_hop_ip_address:
description:
- The ip address of the next hop.
type: str
type: list
type: dict
type: dict
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
remote_virtual_network:
description:
- ID of the remote VNet to connect to.
suboptions:
id:
description:
- The remote virtual network ID.
type: str
type: dict
enable_internet_security:
description:
- Enable internet security.
type: bool
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
allow_hub_to_remote_vnet_transit:
description:
- VirtualHub to RemoteVnet transit to enabled or not.
type: bool
allow_remote_vnet_to_use_hub_vnet_gateways:
description:
- Allow RemoteVnet to use Virtual Hub's gateways.
type: bool
state:
contains:
allow_hub_to_remote_vnet_transit:
description:
- Enable hub to remote VNet transit.
returned: always
sample: true
type: bool
allow_remote_vnet_to_use_hub_vnet_gateways:
description:
- Allow remote VNet to use hub's VNet gateways.
returned: always
sample: true
type: bool
enable_internet_security:
description:
- Enable internet security and default is enabled.
returned: always
sample: true
type: bool
etag:
description:
- A unique read-only string that changes whenever the resource is updated.
returned: always
sample: 31102041-49e7-4cac-8573-aac1e1a16793
type: str
id:
description:
- Resource ID.
returned: always
sample: /subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualHubs/vhub/hubVirtualNetworkConnections/MyConnection
type: str
name:
description:
- Resource name.
returned: always
sample: MyConnection
type: str
provisioning_state:
description:
- The provisioning state of the virtual hub connection resource.
returned: always
sample: Succeeded
type: str
remote_virtual_network:
contains:
id:
description:
- The ID of the remote VNet to connect to.
returned: always
sample: /subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/testvnet
type: str
description:
- Name of ID of the remote VNet to connect to.
returned: always
type: complex
routing_configuration:
contains:
associated_route_table:
contains:
id:
description:
- The ID of the routetable.
returned: always
sample: /subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualHubs/testhub/hubRouteTables/rt_name
type: str
description:
- The resource ID of route table associated with this routing configuration.
returned: always
type: complex
propagated_route_tables:
contains:
ids:
description:
- The list resource ID of propagated route tables.
returned: always
sample:
- id: /subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualHubs/testhub/hubRouteTables/rt_name
type: list
labels:
description:
- Space-separated list of labels for propagated route tables.
returned: always
sample:
- labels1
- labels2
type: list
description:
- Space-separated list of resource id of propagated route tables.
returned: always
type: complex
vnet_routes:
contains:
static_routes:
contains:
address_prefixes:
description:
- Space-separated list of all address prefixes.
returned: always
sample:
- 10.1.0.0/16
- 10.2.0.0/16
type: list
name:
description:
- The name of static router.
returned: always
sample: route1
type: str
next_hop_ip_address:
description:
- The next hop ip address.
returned: always
sample: 10.0.0.65
type: str
description:
- The name of the Static Route.
returned: always
type: list
description:
- The name of the Static Route that is unique within a Vnet Route.
returned: always
type: complex
description:
- The routing configuration information
returned: always
type: complex
description:
- A list of dict results for the virtual hub connection info.
returned: always
type: complex