Web Apps - Get Vnet Connection Gateway

Service:

App Service

API Version:

2024-04-01

Description for Gets an app's Virtual Network gateway.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}?api-version=2024-04-01

URI Parameters

Name	In	Required	Type	Description
gatewayName	path	True	string	Name of the gateway. Currently, the only supported string is "primary".
name	path	True	string	Name of the app.
resourceGroupName	path	True	string	Name of the resource group to which the resource belongs. Regex pattern: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
vnetName	path	True	string	Name of the Virtual Network.
api-version	query	True	string	API Version

Responses

Name	Type	Description
200 OK	VnetGateway	OK.
404 Not Found		Named gateway does not exist. Only the "primary" gateway is supported currently.
Other Status Codes	DefaultErrorResponse	App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Definitions

Name	Description
DefaultErrorResponse	App Service error response.
Details
Error	Error model.
VnetGateway	The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Error

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

VnetGateway

The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.vnetName	string	The Virtual Network name.
properties.vpnPackageUri	string	The URI where the VPN package can be downloaded.
type	string	Resource type.