1. Packages
  2. Azure Native v2
  3. API Docs
  4. web
  5. AppServicePlanRouteForVnet
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.web.AppServicePlanRouteForVnet

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Virtual Network route contract used to pass routing information for a Virtual Network. Azure REST API version: 2022-09-01. Prior API version in Azure Native 1.x: 2020-12-01.

Other available API versions: 2016-09-01, 2020-10-01, 2023-01-01, 2023-12-01, 2024-04-01.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:web:AppServicePlanRouteForVnet myresource1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName} 
Copy

Create AppServicePlanRouteForVnet Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AppServicePlanRouteForVnet(name: string, args: AppServicePlanRouteForVnetArgs, opts?: CustomResourceOptions);
@overload
def AppServicePlanRouteForVnet(resource_name: str,
                               args: AppServicePlanRouteForVnetArgs,
                               opts: Optional[ResourceOptions] = None)

@overload
def AppServicePlanRouteForVnet(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               name: Optional[str] = None,
                               resource_group_name: Optional[str] = None,
                               vnet_name: Optional[str] = None,
                               end_address: Optional[str] = None,
                               kind: Optional[str] = None,
                               route_name: Optional[str] = None,
                               route_type: Optional[Union[str, RouteType]] = None,
                               start_address: Optional[str] = None)
func NewAppServicePlanRouteForVnet(ctx *Context, name string, args AppServicePlanRouteForVnetArgs, opts ...ResourceOption) (*AppServicePlanRouteForVnet, error)
public AppServicePlanRouteForVnet(string name, AppServicePlanRouteForVnetArgs args, CustomResourceOptions? opts = null)
public AppServicePlanRouteForVnet(String name, AppServicePlanRouteForVnetArgs args)
public AppServicePlanRouteForVnet(String name, AppServicePlanRouteForVnetArgs args, CustomResourceOptions options)
type: azure-native:web:AppServicePlanRouteForVnet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AppServicePlanRouteForVnetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AppServicePlanRouteForVnetArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AppServicePlanRouteForVnetArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AppServicePlanRouteForVnetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AppServicePlanRouteForVnetArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var appServicePlanRouteForVnetResource = new AzureNative.Web.AppServicePlanRouteForVnet("appServicePlanRouteForVnetResource", new()
{
    Name = "string",
    ResourceGroupName = "string",
    VnetName = "string",
    EndAddress = "string",
    Kind = "string",
    RouteName = "string",
    RouteType = "string",
    StartAddress = "string",
});
Copy
example, err := web.NewAppServicePlanRouteForVnet(ctx, "appServicePlanRouteForVnetResource", &web.AppServicePlanRouteForVnetArgs{
	Name:              "string",
	ResourceGroupName: "string",
	VnetName:          "string",
	EndAddress:        "string",
	Kind:              "string",
	RouteName:         "string",
	RouteType:         "string",
	StartAddress:      "string",
})
Copy
var appServicePlanRouteForVnetResource = new AppServicePlanRouteForVnet("appServicePlanRouteForVnetResource", AppServicePlanRouteForVnetArgs.builder()
    .name("string")
    .resourceGroupName("string")
    .vnetName("string")
    .endAddress("string")
    .kind("string")
    .routeName("string")
    .routeType("string")
    .startAddress("string")
    .build());
Copy
app_service_plan_route_for_vnet_resource = azure_native.web.AppServicePlanRouteForVnet("appServicePlanRouteForVnetResource",
    name=string,
    resource_group_name=string,
    vnet_name=string,
    end_address=string,
    kind=string,
    route_name=string,
    route_type=string,
    start_address=string)
Copy
const appServicePlanRouteForVnetResource = new azure_native.web.AppServicePlanRouteForVnet("appServicePlanRouteForVnetResource", {
    name: "string",
    resourceGroupName: "string",
    vnetName: "string",
    endAddress: "string",
    kind: "string",
    routeName: "string",
    routeType: "string",
    startAddress: "string",
});
Copy
type: azure-native:web:AppServicePlanRouteForVnet
properties:
    endAddress: string
    kind: string
    name: string
    resourceGroupName: string
    routeName: string
    routeType: string
    startAddress: string
    vnetName: string
Copy

AppServicePlanRouteForVnet Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AppServicePlanRouteForVnet resource accepts the following input properties:

Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the App Service plan.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
VnetName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Virtual Network.
EndAddress string
The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.
Kind string
Kind of resource.
RouteName Changes to this property will trigger replacement. string
Name of the Virtual Network route.
RouteType string | Pulumi.AzureNative.Web.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.

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.
Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the App Service plan.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
VnetName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Virtual Network.
EndAddress string
The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.
Kind string
Kind of resource.
RouteName Changes to this property will trigger replacement. string
Name of the Virtual Network route.
RouteType string | 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.

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.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the App Service plan.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.
vnetName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Virtual Network.
endAddress String
The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.
kind String
Kind of resource.
routeName Changes to this property will trigger replacement. String
Name of the Virtual Network route.
routeType String | 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.

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.
name
This property is required.
Changes to this property will trigger replacement.
string
Name of the App Service plan.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
vnetName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Virtual Network.
endAddress string
The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.
kind string
Kind of resource.
routeName Changes to this property will trigger replacement. string
Name of the Virtual Network route.
routeType string | 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.

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.
name
This property is required.
Changes to this property will trigger replacement.
str
Name of the App Service plan.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the resource group to which the resource belongs.
vnet_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Virtual Network.
end_address str
The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.
kind str
Kind of resource.
route_name Changes to this property will trigger replacement. str
Name of the Virtual Network route.
route_type str | 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.

start_address str
The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the App Service plan.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.
vnetName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Virtual Network.
endAddress String
The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.
kind String
Kind of resource.
routeName Changes to this property will trigger replacement. String
Name of the Virtual Network route.
routeType String | "DEFAULT" | "INHERITED" | "STATIC"

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.

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.

Outputs

All input properties are implicitly available as output properties. Additionally, the AppServicePlanRouteForVnet resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Type string
Resource type.
Id string
The provider-assigned unique ID for this managed resource.
Type string
Resource type.
id String
The provider-assigned unique ID for this managed resource.
type String
Resource type.
id string
The provider-assigned unique ID for this managed resource.
type string
Resource type.
id str
The provider-assigned unique ID for this managed resource.
type str
Resource type.
id String
The provider-assigned unique ID for this managed resource.
type String
Resource type.

Supporting Types

RouteType
, RouteTypeArgs

DEFAULT
DEFAULT
INHERITED
INHERITED
STATIC
STATIC
RouteTypeDEFAULT
DEFAULT
RouteTypeINHERITED
INHERITED
RouteTypeSTATIC
STATIC
DEFAULT
DEFAULT
INHERITED
INHERITED
STATIC
STATIC
DEFAULT
DEFAULT
INHERITED
INHERITED
STATIC
STATIC
DEFAULT
DEFAULT
INHERITED
INHERITED
STATIC
STATIC
"DEFAULT"
DEFAULT
"INHERITED"
INHERITED
"STATIC"
STATIC

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi