PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/?api-version=2023-01-01
Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
Servers
- https://management.azure.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | Yes |
Name of the app. |
subscriptionId |
String | Yes |
Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). |
resourceGroupName |
String | Yes |
Name of the resource group to which the resource belongs. |
vnetName |
String | Yes |
Name of an existing Virtual Network. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
Resource Id. |
name |
String | No |
Resource Name. |
properties |
Object | No |
Virtual Network information contract. |
properties.certBlob |
String | No |
A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection. |
properties.certThumbprint |
String | No |
The client certificate thumbprint. |
properties.routes[] |
Array | No |
The routes that this Virtual Network connection uses. |
properties.routes[].id |
String | No |
Resource Id. |
properties.routes[].name |
String | No |
Resource Name. |
properties.routes[].properties |
Object | No |
VnetRoute resource specific properties |
properties.routes[].properties.startAddress |
String | No |
The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. |
properties.routes[].properties.routeType |
String | No |
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. Possible values:
|
properties.routes[].properties.endAddress |
String | No |
The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. |
properties.routes[].type |
String | No |
Resource type. |
properties.routes[].kind |
String | No |
Kind of resource. |
properties.dnsServers |
String | No |
DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. |
properties.isSwift |
Boolean | No |
Flag that is used to denote if this is VNET injection |
properties.vnetResourceId |
String | No |
The Virtual Network's resource ID. |
properties.resyncRequired |
Boolean | No |
|
type |
String | No |
Resource type. |
kind |
String | No |
Kind of resource. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.