azure / azure.azcollection / 2.3.0 / module / azure_rm_virtualhub Manage Azure VirtualHub instance | "added in version" 1.10.0 of azure.azcollection" Authors: Fred-Sun (@Fred-Sun), Haiyuan Zhang (@haiyuazhang)azure.azcollection.azure_rm_virtualhub (2.3.0) — module
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections: - name: azure.azcollection version: 2.3.0
Create, update and delete instance of Azure VirtualHub.
- name: Create a VirtualHub azure_rm_virtualhub: resource_group: myResourceGroup name: my_virtual_hub_name address_prefix: 10.2.0.0/24 sku: Standard location: eastus enable_virtual_router_route_propogation: false virtual_wan: id: /subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualWans/fredwan
- name: Delete VirtualHub azure_rm_virtualhub: resource_group: myResourceGroup name: my_virtual_hub_name location: eastus state: absent
sku: description: - The sku of this VirtualHub. type: str name: description: - The name of the VirtualHub. required: true type: str tags: description: - Dictionary of string:string pairs to assign as metadata to the object. - Metadata tags on the object will be updated with any provided values. - To remove tags set append_tags option to false. - Currently, Azure DNS zones and Traffic Manager services also don't allow the use of spaces in the tag. - Azure Front Door doesn't support the use of - Azure Automation and Azure CDN only support 15 tags on resources. type: dict state: choices: - absent - present default: present description: - Assert the state of the VirtualHub. - Use C(present) to create or update an VirtualHub 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 location: description: - The location of the VirtualHub. 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 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 append_tags: default: true description: - Use to control if tags field is canonical or just appends to existing tags. - When canonical, any tags not found in the tags parameter will be removed from the object's metadata. type: bool 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 route_table: description: - The routeTable associated with this virtual hub. suboptions: routes: description: - List of all routes. elements: dict suboptions: address_prefixes: description: - List of all addressPrefixes. elements: str type: list next_hop_ip_address: description: - NextHop ip address. type: str type: list type: dict virtual_wan: description: - The VirtualWAN to which the VirtualHub belongs. suboptions: id: description: - Resource ID. type: str type: dict vpn_gateway: description: - The VpnGateway associated with this VirtualHub. suboptions: id: description: - Resource ID. type: str type: dict address_prefix: description: - Address-prefix for this VirtualHub. type: str azure_firewall: description: - The azureFirewall associated with this VirtualHub. suboptions: id: description: - Resource ID. type: str type: dict resource_group: description: - The resource group name of the VirtualHub. required: true type: str bgp_connections: description: - List of references to Bgp Connections. elements: dict suboptions: id: description: - Resource ID. type: str type: list subscription_id: description: - Your Azure subscription Id. type: str p2_s_vpn_gateway: description: - The P2SVpnGateway associated with this VirtualHub. suboptions: id: description: - Resource ID. type: str type: dict 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 ip_configurations: description: - List of references to IpConfigurations. elements: dict suboptions: id: description: - Resource ID. type: str type: list 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 virtual_router_asn: description: - VirtualRouter ASN. type: int virtual_router_ips: description: - VirtualRouter IPs. elements: str type: list 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 express_route_gateway: description: - The expressRouteGateway associated with this VirtualHub. suboptions: id: description: - Resource ID. type: str 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 security_provider_name: description: - The Security Provider name. type: str security_partner_provider: description: - The securityPartnerProvider associated with this VirtualHub. suboptions: id: description: - Resource ID. type: str type: dict 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 virtual_hub_route_table_v2_s: description: - List of all virtual hub route table v2s associated with this VirtualHub. elements: dict suboptions: attached_connections: description: - List of all connections attached to this route table v2. elements: str type: list name: description: - The name of the resource that is unique within a resource group. - This name can be used to access the resource. type: str routes: description: - List of all routes. elements: dict suboptions: destination_type: description: - The type of destinations. type: str destinations: description: - List of all destinations. elements: str type: list next_hop_type: description: - The type of next hops. type: str next_hops: description: - NextHops ip address. elements: str type: list type: list type: list enable_virtual_router_route_propogation: description: - Flag to control route propogation for VirtualRouter hub. type: bool
state: contains: address_prefix: description: - Address-prefix for this VirtualHub. returned: always sample: 10.2.0.0/24 type: str azure_firewall: contains: id: description: - Resource ID. returned: always sample: null type: str description: - The azureFirewall associated with this VirtualHub. returned: always type: complex bgp_connections: contains: id: description: - Resource ID. returned: always sample: null type: str description: - List of references to Bgp Connections. returned: always type: list enable_virtual_router_route_propogation: description: - Flag to control route propogation for VirtualRouter hub. returned: always sample: null type: bool etag: description: - A unique read-only string that changes whenever the resource is updated. returned: always sample: cf8c0b06-d339-4155-95fd-2a363945cce4 type: str express_route_gateway: contains: id: description: - Resource ID. returned: always sample: null type: str description: - The expressRouteGateway associated with this VirtualHub. returned: always sample: null type: dict id: description: - Resource ID. returned: always sample: /subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualHubs/my_virtual_hub_name type: str ip_configurations: contains: id: description: - Resource ID. returned: always sample: null type: str description: - List of references to IpConfigurations. returned: always type: list location: description: - Resource location. returned: always sample: eastus type: str name: description: - Resource name. returned: always sample: my_virtual_hub_name type: str p2_s_vpn_gateway: contains: id: description: - Resource ID. returned: always sample: null type: str description: - The P2SVpnGateway associated with this VirtualHub. returned: always type: complex provisioning_state: description: - The provisioning state of the virtual hub resource. returned: always sample: Succeeded type: str route_table: contains: routes: contains: address_prefixes: description: - List of all addressPrefixes. returned: always sample: null type: list next_hop_ip_address: description: - NextHop ip address. returned: always sample: null type: str description: - List of all routes. returned: always type: list description: - The routeTable associated with this virtual hub. returned: always type: complex routing_state: description: - The routing state. returned: always sample: Standard type: str security_partner_provider: contains: id: description: - Resource ID. returned: always sample: null type: str description: - The securityPartnerProvider associated with this VirtualHub. returned: always type: complex security_provider_name: description: - The Security Provider name. returned: always sample: null type: str sku: description: - The sku of this VirtualHub. returned: always sample: null type: str tags: description: - Resource tags. returned: always sample: key1: value1 type: dict type: description: - Resource type. returned: always sample: Microsoft.Network/virtualHubs type: str virtual_hub_route_table_v2_s: contains: attached_connections: description: - List of all connections attached to this route table v2. returned: always sample: null type: list name: description: - The name of the resource that is unique within a resource group. - This name can be used to access the resource. returned: always sample: null type: str routes: contains: destination_type: description: - The type of destinations. returned: always sample: null type: str destinations: description: - List of all destinations. returned: always sample: null type: list next_hop_type: description: - The type of next hops. returned: always sample: null type: str next_hops: description: - NextHops ip address. returned: always sample: null type: list description: - List of all routes. returned: always type: list description: - List of all virtual hub route table v2s associated with this VirtualHub. returned: always type: complex virtual_router_asn: description: - VirtualRouter ASN. returned: always sample: null type: int virtual_router_ips: description: - VirtualRouter IPs. returned: always sample: null type: list virtual_wan: contains: id: description: - Resource ID. returned: always sample: /subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualWans/fredwan type: str description: - The VirtualWAN to which the VirtualHub belongs. returned: always type: complex vpn_gateway: contains: id: description: - Resource ID. returned: always sample: null type: str description: - The VpnGateway associated with this VirtualHub. returned: always type: complex description: - Current state of the virtual hub. returned: always type: complex