1. Packages
  2. Azure Native v2
  3. API Docs
  4. web
  5. getWebAppVnetConnection
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.web.getWebAppVnetConnection

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Description for Gets a virtual network the app (or deployment slot) is connected to by name. Azure REST API version: 2022-09-01.

Other available API versions: 2020-10-01, 2023-01-01, 2023-12-01, 2024-04-01.

Using getWebAppVnetConnection

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 getWebAppVnetConnection(args: GetWebAppVnetConnectionArgs, opts?: InvokeOptions): Promise<GetWebAppVnetConnectionResult>
function getWebAppVnetConnectionOutput(args: GetWebAppVnetConnectionOutputArgs, opts?: InvokeOptions): Output<GetWebAppVnetConnectionResult>
Copy
def get_web_app_vnet_connection(name: Optional[str] = None,
                                resource_group_name: Optional[str] = None,
                                vnet_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetWebAppVnetConnectionResult
def get_web_app_vnet_connection_output(name: Optional[pulumi.Input[str]] = None,
                                resource_group_name: Optional[pulumi.Input[str]] = None,
                                vnet_name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetWebAppVnetConnectionResult]
Copy
func LookupWebAppVnetConnection(ctx *Context, args *LookupWebAppVnetConnectionArgs, opts ...InvokeOption) (*LookupWebAppVnetConnectionResult, error)
func LookupWebAppVnetConnectionOutput(ctx *Context, args *LookupWebAppVnetConnectionOutputArgs, opts ...InvokeOption) LookupWebAppVnetConnectionResultOutput
Copy

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

public static class GetWebAppVnetConnection 
{
    public static Task<GetWebAppVnetConnectionResult> InvokeAsync(GetWebAppVnetConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetWebAppVnetConnectionResult> Invoke(GetWebAppVnetConnectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWebAppVnetConnectionResult> getWebAppVnetConnection(GetWebAppVnetConnectionArgs args, InvokeOptions options)
public static Output<GetWebAppVnetConnectionResult> getWebAppVnetConnection(GetWebAppVnetConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:web:getWebAppVnetConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the app.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
VnetName
This property is required.
Changes to this property will trigger replacement.
string
Name of the virtual network.
Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the app.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
VnetName
This property is required.
Changes to this property will trigger replacement.
string
Name of the virtual network.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the app.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.
vnetName
This property is required.
Changes to this property will trigger replacement.
String
Name of the virtual network.
name
This property is required.
Changes to this property will trigger replacement.
string
Name of the app.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
vnetName
This property is required.
Changes to this property will trigger replacement.
string
Name of the virtual network.
name
This property is required.
Changes to this property will trigger replacement.
str
Name of the app.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the resource group to which the resource belongs.
vnet_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the virtual network.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the app.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.
vnetName
This property is required.
Changes to this property will trigger replacement.
String
Name of the virtual network.

getWebAppVnetConnection Result

The following output properties are available:

CertThumbprint string
The client certificate thumbprint.
Id string
Resource Id.
Name string
Resource Name.
ResyncRequired bool
true if a resync is required; otherwise, false.
Routes List<Pulumi.AzureNative.Web.Outputs.VnetRouteResponse>
The routes that this Virtual Network connection uses.
Type string
Resource type.
CertBlob string
A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection.
DnsServers string
DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.
IsSwift bool
Flag that is used to denote if this is VNET injection
Kind string
Kind of resource.
VnetResourceId string
The Virtual Network's resource ID.
CertThumbprint string
The client certificate thumbprint.
Id string
Resource Id.
Name string
Resource Name.
ResyncRequired bool
true if a resync is required; otherwise, false.
Routes []VnetRouteResponse
The routes that this Virtual Network connection uses.
Type string
Resource type.
CertBlob string
A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection.
DnsServers string
DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.
IsSwift bool
Flag that is used to denote if this is VNET injection
Kind string
Kind of resource.
VnetResourceId string
The Virtual Network's resource ID.
certThumbprint String
The client certificate thumbprint.
id String
Resource Id.
name String
Resource Name.
resyncRequired Boolean
true if a resync is required; otherwise, false.
routes List<VnetRouteResponse>
The routes that this Virtual Network connection uses.
type String
Resource type.
certBlob String
A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection.
dnsServers String
DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.
isSwift Boolean
Flag that is used to denote if this is VNET injection
kind String
Kind of resource.
vnetResourceId String
The Virtual Network's resource ID.
certThumbprint string
The client certificate thumbprint.
id string
Resource Id.
name string
Resource Name.
resyncRequired boolean
true if a resync is required; otherwise, false.
routes VnetRouteResponse[]
The routes that this Virtual Network connection uses.
type string
Resource type.
certBlob string
A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection.
dnsServers string
DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.
isSwift boolean
Flag that is used to denote if this is VNET injection
kind string
Kind of resource.
vnetResourceId string
The Virtual Network's resource ID.
cert_thumbprint str
The client certificate thumbprint.
id str
Resource Id.
name str
Resource Name.
resync_required bool
true if a resync is required; otherwise, false.
routes Sequence[VnetRouteResponse]
The routes that this Virtual Network connection uses.
type str
Resource type.
cert_blob str
A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection.
dns_servers str
DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.
is_swift bool
Flag that is used to denote if this is VNET injection
kind str
Kind of resource.
vnet_resource_id str
The Virtual Network's resource ID.
certThumbprint String
The client certificate thumbprint.
id String
Resource Id.
name String
Resource Name.
resyncRequired Boolean
true if a resync is required; otherwise, false.
routes List<Property Map>
The routes that this Virtual Network connection uses.
type String
Resource type.
certBlob String
A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection.
dnsServers String
DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.
isSwift Boolean
Flag that is used to denote if this is VNET injection
kind String
Kind of resource.
vnetResourceId String
The Virtual Network's resource ID.

Supporting Types

VnetRouteResponse

Id This property is required. string
Resource Id.
Name This property is required. string
Resource Name.
Type This property is required. string
Resource type.
EndAddress string
The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.
Kind string
Kind of resource.
RouteType string

The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only

These values will be used for syncing an app's routes with those from a Virtual Network.

StartAddress string
The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.
Id This property is required. string
Resource Id.
Name This property is required. string
Resource Name.
Type This property is required. string
Resource type.
EndAddress string
The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.
Kind string
Kind of resource.
RouteType string

The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only

These values will be used for syncing an app's routes with those from a Virtual Network.

StartAddress string
The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.
id This property is required. String
Resource Id.
name This property is required. String
Resource Name.
type This property is required. String
Resource type.
endAddress String
The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.
kind String
Kind of resource.
routeType String

The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only

These values will be used for syncing an app's routes with those from a Virtual Network.

startAddress String
The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.
id This property is required. string
Resource Id.
name This property is required. string
Resource Name.
type This property is required. string
Resource type.
endAddress string
The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.
kind string
Kind of resource.
routeType string

The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only

These values will be used for syncing an app's routes with those from a Virtual Network.

startAddress string
The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.
id This property is required. str
Resource Id.
name This property is required. str
Resource Name.
type This property is required. str
Resource type.
end_address str
The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.
kind str
Kind of resource.
route_type str

The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only

These values will be used for syncing an app's routes with those from a Virtual Network.

start_address str
The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.
id This property is required. String
Resource Id.
name This property is required. String
Resource Name.
type This property is required. String
Resource type.
endAddress String
The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.
kind String
Kind of resource.
routeType String

The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only

These values will be used for syncing an app's routes with those from a Virtual Network.

startAddress String
The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi