Web Apps - List Network Features Slot

Description for Gets all network features used by the app (or deployment slot, if specified).

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view}?api-version=2023-12-01

URI Parameters

Name In Required Type Description
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\._\(\)]+[^\.]$

slot
path True

string

Name of the deployment slot. If a slot is not specified, the API will get network features for the production slot.

subscriptionId
path True

string

Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

view
path True

string

The type of view. Only "summary" is supported at this time.

api-version
query True

string

API Version

Responses

Name Type Description
200 OK

NetworkFeatures

OK.

404 Not Found

The requested view does not exist.

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.

HybridConnection

Hybrid Connection contract. This is used to configure a Hybrid Connection.

NetworkFeatures

Full view of network features for an app (presently VNET integration and Hybrid Connections).

RelayServiceConnectionEntity

Hybrid Connection for an App Service app.

RouteType

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.

VnetInfo

Virtual Network information contract.

VnetRoute

Virtual Network route contract used to pass routing information for a Virtual Network.

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.

HybridConnection

Hybrid Connection contract. This is used to configure a Hybrid Connection.

Name Type Description
id

string

Resource Id.

kind

string

Kind of resource.

name

string

Resource Name.

properties.hostname

string

The hostname of the endpoint.

properties.port

integer

The port of the endpoint.

properties.relayArmUri

string

The ARM URI to the Service Bus relay.

properties.relayName

string

The name of the Service Bus relay.

properties.sendKeyName

string

The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.

properties.sendKeyValue

string

The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned normally, use the POST /listKeys API instead.

properties.serviceBusNamespace

string

The name of the Service Bus namespace.

properties.serviceBusSuffix

string

The suffix for the service bus endpoint. By default this is .servicebus.windows.net

type

string

Resource type.

NetworkFeatures

Full view of network features for an app (presently VNET integration and Hybrid Connections).

Name Type Description
id

string

Resource Id.

kind

string

Kind of resource.

name

string

Resource Name.

properties.hybridConnections

RelayServiceConnectionEntity[]

The Hybrid Connections summary view.

properties.hybridConnectionsV2

HybridConnection[]

The Hybrid Connection V2 (Service Bus) view.

properties.virtualNetworkConnection

VnetInfo

The Virtual Network summary view.

properties.virtualNetworkName

string

The Virtual Network name.

type

string

Resource type.

RelayServiceConnectionEntity

Hybrid Connection for an App Service app.

Name Type Description
id

string

Resource Id.

kind

string

Kind of resource.

name

string

Resource Name.

properties.biztalkUri

string

properties.entityConnectionString

string

properties.entityName

string

properties.hostname

string

properties.port

integer

properties.resourceConnectionString

string

properties.resourceType

string

type

string

Resource type.

RouteType

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.

Name Type Description
DEFAULT

string

INHERITED

string

STATIC

string

VnetInfo

Virtual Network information contract.

Name Type Description
certBlob

string

A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection.

certThumbprint

string

The client certificate thumbprint.

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

resyncRequired

boolean

true if a resync is required; otherwise, false.

routes

VnetRoute[]

The routes that this Virtual Network connection uses.

vnetResourceId

string

The Virtual Network's resource ID.

VnetRoute

Virtual Network route contract used to pass routing information for a Virtual Network.

Name Type Description
id

string

Resource Id.

kind

string

Kind of resource.

name

string

Resource Name.

properties.endAddress

string

The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.

properties.routeType

RouteType

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.

properties.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.

type

string

Resource type.