Web Apps - Put Private Access Vnet

Description for Sets data around private site access enablement and authorized Virtual Networks that can access the site.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks?api-version=2024-04-01

URI Parameters

Name In Required Type Description
name
path True

string

The name of the web 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).

api-version
query True

string

API Version

Request Body

Name Type Description
kind

string

Kind of resource.

properties.enabled

boolean

Whether private access is enabled or not.

properties.virtualNetworks

PrivateAccessVirtualNetwork[]

The Virtual Networks (and subnets) allowed to access the site privately.

Responses

Name Type Description
200 OK

PrivateAccess

OK

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.

PrivateAccess

Description of the parameters of Private Access for a Web Site.

PrivateAccessSubnet

Description of a Virtual Network subnet that is useable for private site access.

PrivateAccessVirtualNetwork

Description of a Virtual Network that is useable for private site access.

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.

PrivateAccess

Description of the parameters of Private Access for a Web Site.

Name Type Description
id

string

Resource Id.

kind

string

Kind of resource.

name

string

Resource Name.

properties.enabled

boolean

Whether private access is enabled or not.

properties.virtualNetworks

PrivateAccessVirtualNetwork[]

The Virtual Networks (and subnets) allowed to access the site privately.

type

string

Resource type.

PrivateAccessSubnet

Description of a Virtual Network subnet that is useable for private site access.

Name Type Description
key

integer

The key (ID) of the subnet.

name

string

The name of the subnet.

PrivateAccessVirtualNetwork

Description of a Virtual Network that is useable for private site access.

Name Type Description
key

integer

The key (ID) of the Virtual Network.

name

string

The name of the Virtual Network.

resourceId

string

The ARM uri of the Virtual Network

subnets

PrivateAccessSubnet[]

A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network.