1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getVirtualWan
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.network.getVirtualWan

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Retrieves the details of a VirtualWAN.

Uses Azure REST API version 2024-05-01.

Other available API versions: 2018-08-01, 2018-10-01, 2018-11-01, 2018-12-01, 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the version guide for details.

Using getVirtualWan

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getVirtualWan(args: GetVirtualWanArgs, opts?: InvokeOptions): Promise<GetVirtualWanResult>
function getVirtualWanOutput(args: GetVirtualWanOutputArgs, opts?: InvokeOptions): Output<GetVirtualWanResult>
Copy
def get_virtual_wan(resource_group_name: Optional[str] = None,
                    virtual_wan_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetVirtualWanResult
def get_virtual_wan_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                    virtual_wan_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetVirtualWanResult]
Copy
func LookupVirtualWan(ctx *Context, args *LookupVirtualWanArgs, opts ...InvokeOption) (*LookupVirtualWanResult, error)
func LookupVirtualWanOutput(ctx *Context, args *LookupVirtualWanOutputArgs, opts ...InvokeOption) LookupVirtualWanResultOutput
Copy

> Note: This function is named LookupVirtualWan in the Go SDK.

public static class GetVirtualWan 
{
    public static Task<GetVirtualWanResult> InvokeAsync(GetVirtualWanArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualWanResult> Invoke(GetVirtualWanInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVirtualWanResult> getVirtualWan(GetVirtualWanArgs args, InvokeOptions options)
public static Output<GetVirtualWanResult> getVirtualWan(GetVirtualWanArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getVirtualWan
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name of the VirtualWan.
VirtualWANName
This property is required.
Changes to this property will trigger replacement.
string
The name of the VirtualWAN being retrieved.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name of the VirtualWan.
VirtualWANName
This property is required.
Changes to this property will trigger replacement.
string
The name of the VirtualWAN being retrieved.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name of the VirtualWan.
virtualWANName
This property is required.
Changes to this property will trigger replacement.
String
The name of the VirtualWAN being retrieved.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name of the VirtualWan.
virtualWANName
This property is required.
Changes to this property will trigger replacement.
string
The name of the VirtualWAN being retrieved.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The resource group name of the VirtualWan.
virtual_wan_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the VirtualWAN being retrieved.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name of the VirtualWan.
virtualWANName
This property is required.
Changes to this property will trigger replacement.
String
The name of the VirtualWAN being retrieved.

getVirtualWan Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
Location string
Resource location.
Name string
Resource name.
Office365LocalBreakoutCategory string
The office local breakout category.
ProvisioningState string
The provisioning state of the virtual WAN resource.
Type string
Resource type.
VirtualHubs List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>
List of VirtualHubs in the VirtualWAN.
VpnSites List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>
List of VpnSites in the VirtualWAN.
AllowBranchToBranchTraffic bool
True if branch to branch traffic is allowed.
AllowVnetToVnetTraffic bool
True if Vnet to Vnet traffic is allowed.
DisableVpnEncryption bool
Vpn encryption to be disabled or not.
Id string
Resource ID.
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
Location string
Resource location.
Name string
Resource name.
Office365LocalBreakoutCategory string
The office local breakout category.
ProvisioningState string
The provisioning state of the virtual WAN resource.
Type string
Resource type.
VirtualHubs []SubResourceResponse
List of VirtualHubs in the VirtualWAN.
VpnSites []SubResourceResponse
List of VpnSites in the VirtualWAN.
AllowBranchToBranchTraffic bool
True if branch to branch traffic is allowed.
AllowVnetToVnetTraffic bool
True if Vnet to Vnet traffic is allowed.
DisableVpnEncryption bool
Vpn encryption to be disabled or not.
Id string
Resource ID.
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
location String
Resource location.
name String
Resource name.
office365LocalBreakoutCategory String
The office local breakout category.
provisioningState String
The provisioning state of the virtual WAN resource.
type String
Resource type.
virtualHubs List<SubResourceResponse>
List of VirtualHubs in the VirtualWAN.
vpnSites List<SubResourceResponse>
List of VpnSites in the VirtualWAN.
allowBranchToBranchTraffic Boolean
True if branch to branch traffic is allowed.
allowVnetToVnetTraffic Boolean
True if Vnet to Vnet traffic is allowed.
disableVpnEncryption Boolean
Vpn encryption to be disabled or not.
id String
Resource ID.
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
etag string
A unique read-only string that changes whenever the resource is updated.
location string
Resource location.
name string
Resource name.
office365LocalBreakoutCategory string
The office local breakout category.
provisioningState string
The provisioning state of the virtual WAN resource.
type string
Resource type.
virtualHubs SubResourceResponse[]
List of VirtualHubs in the VirtualWAN.
vpnSites SubResourceResponse[]
List of VpnSites in the VirtualWAN.
allowBranchToBranchTraffic boolean
True if branch to branch traffic is allowed.
allowVnetToVnetTraffic boolean
True if Vnet to Vnet traffic is allowed.
disableVpnEncryption boolean
Vpn encryption to be disabled or not.
id string
Resource ID.
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
etag str
A unique read-only string that changes whenever the resource is updated.
location str
Resource location.
name str
Resource name.
office365_local_breakout_category str
The office local breakout category.
provisioning_state str
The provisioning state of the virtual WAN resource.
type str
Resource type.
virtual_hubs Sequence[SubResourceResponse]
List of VirtualHubs in the VirtualWAN.
vpn_sites Sequence[SubResourceResponse]
List of VpnSites in the VirtualWAN.
allow_branch_to_branch_traffic bool
True if branch to branch traffic is allowed.
allow_vnet_to_vnet_traffic bool
True if Vnet to Vnet traffic is allowed.
disable_vpn_encryption bool
Vpn encryption to be disabled or not.
id str
Resource ID.
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
location String
Resource location.
name String
Resource name.
office365LocalBreakoutCategory String
The office local breakout category.
provisioningState String
The provisioning state of the virtual WAN resource.
type String
Resource type.
virtualHubs List<Property Map>
List of VirtualHubs in the VirtualWAN.
vpnSites List<Property Map>
List of VpnSites in the VirtualWAN.
allowBranchToBranchTraffic Boolean
True if branch to branch traffic is allowed.
allowVnetToVnetTraffic Boolean
True if Vnet to Vnet traffic is allowed.
disableVpnEncryption Boolean
Vpn encryption to be disabled or not.
id String
Resource ID.
tags Map<String>
Resource tags.

Supporting Types

SubResourceResponse

Id string
Resource ID.
Id string
Resource ID.
id String
Resource ID.
id string
Resource ID.
id str
Resource ID.
id String
Resource ID.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi