azure / azure.azcollection / 2.3.0 / module / azure_rm_virtualwan Manage Azure VirtualWan instance | "added in version" 1.5.0 of azure.azcollection" Authors: Fred-Sun (@Fred-Sun)azure.azcollection.azure_rm_virtualwan (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 VirtualWan.
- name: Create a VirtualWan azure_rm_virtualwan: resource_group: myResouceGroup name: testwan disable_vpn_encryption: true allow_branch_to_branch_traffic: true allow_vnet_to_vnet_traffic: true virtual_wan_type: Standard
- name: Delete the VirtualWan azure_rm_virtualwan: resource_group: myResouceGroup name: testwan state: absent
name: description: - The name of the VirtualWAN being retrieved. 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 VirtualWan. - Use C(present) to create or update an VirtualWan 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 virtual wan location. 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 vpn_sites: description: - List of VpnSites in the VirtualWAN. elements: dict suboptions: id: description: - The vpn site resource ID. type: str type: list 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 virtual_hubs: description: - List of VirtualHubs in the VirtualWAN. elements: dict suboptions: id: description: - The virtual hub resource ID. type: str type: list resource_group: description: - The resource group name of the VirtualWan. required: true type: str subscription_id: description: - Your Azure subscription Id. type: str virtual_wan_type: choices: - Basic - Standard description: - The type of the VirtualWAN. 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 disable_vpn_encryption: description: - Vpn encryption to be disabled or not. type: bool allow_vnet_to_vnet_traffic: description: - C(True) if Vnet to Vnet traffic is allowed. 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_branch_to_branch_traffic: description: - True if branch to branch traffic is allowed. type: bool office365_local_breakout_category: choices: - Optimize - OptimizeAndAllow - All - None description: - Specifies the Office365 local breakout category. - Default value is C(None). type: str
state: contains: allow_branch_to_branch_traffic: description: - True if branch to branch traffic is allowed. returned: always sample: true type: bool allow_vnet_to_vnet_traffic: description: - True if Vnet to Vnet traffic is allowed. returned: always sample: true type: bool disable_vpn_encryption: description: - Vpn encryption to be disabled or not. returned: always sample: true type: bool etag: description: - A unique read-only string that changes whenever the resource is updated. returned: always sample: 52def36b-84b6-49aa-a825-16ba167fc559 type: str id: description: - Resource ID. returned: always sample: /subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualWans/virtual_wan_name type: str location: description: - The virtual wan resource location. returned: always sample: eastus type: str name: description: - Resource name. returned: always sample: virtualwanb57dc9555691 type: str office365_local_breakout_category: description: - The office local breakout category. returned: always sample: None type: str provisioning_state: description: - The provisioning state of the virtual WAN resource. returned: always sample: Succeeded type: str tags: description: - Resource tags. returned: always sample: key1: value1 type: dict type: description: - Resource type. returned: always sample: Microsoft.Network/virtualWans type: str virtual_hubs: contains: id: description: - The virtual hubs ID. returned: always sample: /subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualHubs/test type: str description: - List of VirtualHubs in the VirtualWAN. returned: always type: complex virtual_wan_type: description: - The type of the VirtualWAN. returned: always sample: Standard type: str vpn_sites: contains: id: description: - The vpn sites resouce ID. returned: always sample: /subscriptions/xxx-xxx/resourceGroups/resource_group/providers/Microsoft.Network/vpnSites/test1 type: str description: - List of VpnSites in the VirtualWAN. returned: always type: list description: - Current state of the virtual wan. returned: success type: complex