Share via

Web Apps - Get Private Access Slot

Service:
App Service
API Version:
2025-05-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateAccess/virtualNetworks?api-version=2025-05-01

URI Parameters

Name In Required Type Description
name
 path True

string

The name of the web app.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
slot
 path True

string

The name of the slot for the web app.
subscriptionId
 path True

string (uuid)

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

PrivateAccess

Azure operation completed successfully.
Other Status Codes

DefaultErrorResponse

An unexpected 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
createdByType

The type of identity that created the resource.
DefaultErrorResponse

App Service error response.
DefaultErrorResponseError

Error model.
DefaultErrorResponseErrorDetailsItem

Detailed errors.
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.
systemData

Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Object

App Service error response.

Name Type Description
error

DefaultErrorResponseError

Error model.

DefaultErrorResponseError

Object

Error model.

Name Type Description
code

string

Standardized string to programmatically identify the error.
details

DefaultErrorResponseErrorDetailsItem[]

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.

DefaultErrorResponseErrorDetailsItem

Object

Detailed errors.

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.

PrivateAccess

Object

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

Name Type Description
id

string (arm-id)

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind

string

Kind of resource.
name

string

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

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateAccessSubnet

Object

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

Name Type Description
key

integer (int32)

The key (ID) of the subnet.
name

string

The name of the subnet.

PrivateAccessVirtualNetwork

Object

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

Name Type Description
key

integer (int32)

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.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).
createdBy

string

The identity that created the resource.
createdByType

createdByType

The type of identity that created the resource.
lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)
lastModifiedBy

string

The identity that last modified the resource.
lastModifiedByType

createdByType

The type of identity that last modified the resource.