Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Azure Native
  4. API Docs
  5. web
  6. AppServicePlanRouteForVnet
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.26.0
published on Thursday, Aug 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.web.AppServicePlanRouteForVnet

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.26.0
published on Thursday, Aug 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

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

    Uses Azure REST API version 2025-05-01. In version 2.x of the Azure Native provider, it used API version 2022-09-01.

    Other available API versions: 2016-09-01, 2018-02-01, 2019-08-01, 2020-06-01, 2020-09-01, 2020-10-01, 2020-12-01, 2021-01-01, 2021-01-15, 2021-02-01, 2021-03-01, 2022-03-01, 2022-09-01, 2023-01-01, 2023-12-01, 2024-04-01, 2024-11-01, 2025-03-01, 2026-03-01-preview, 2026-03-15, 2026-07-15. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native web [ApiVersion]. See the version guide for details.

    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}

    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.


    resource "azure-native_web_app_service_plan_route_for_vnet" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args AppServicePlanRouteForVnetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args AppServicePlanRouteForVnetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppServicePlanRouteForVnetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
});

    example, err := web.NewAppServicePlanRouteForVnet(ctx, "appServicePlanRouteForVnetResource", &web.AppServicePlanRouteForVnetArgs{
	Name:              pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	VnetName:          pulumi.String("string"),
	EndAddress:        pulumi.String("string"),
	Kind:              pulumi.String("string"),
	RouteName:         pulumi.String("string"),
	RouteType:         pulumi.String("string"),
	StartAddress:      pulumi.String("string"),
})

    resource "azure-native_web_app_service_plan_route_for_vnet" "appServicePlanRouteForVnetResource" {
  lifecycle {
    create_before_destroy = true
  }
  name                = "string"
  resource_group_name = "string"
  vnet_name           = "string"
  end_address         = "string"
  kind                = "string"
  route_name          = "string"
  route_type          = "string"
  start_address       = "string"
}

    var appServicePlanRouteForVnetResource = new AppServicePlanRouteForVnet("appServicePlanRouteForVnetResource", AppServicePlanRouteForVnetArgs.builder()
    .name("string")
    .resourceGroupName("string")
    .vnetName("string")
    .endAddress("string")
    .kind("string")
    .routeName("string")
    .routeType("string")
    .startAddress("string")
    .build());

    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")

    const appServicePlanRouteForVnetResource = new azure_native.web.AppServicePlanRouteForVnet("appServicePlanRouteForVnetResource", {
    name: "string",
    resourceGroupName: "string",
    vnetName: "string",
    endAddress: "string",
    kind: "string",
    routeName: "string",
    routeType: "string",
    startAddress: "string",
});

    type: azure-native:web:AppServicePlanRouteForVnet
properties:
    endAddress: string
    kind: string
    name: string
    resourceGroupName: string
    routeName: string
    routeType: string
    startAddress: string
    vnetName: string

    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 string
    Name of the App Service plan.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VnetName 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 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 string
    Name of the App Service plan.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VnetName 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 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 string
    Name of the App Service plan.
    resource_group_name string
    The name of the resource group. The name is case insensitive.
    vnet_name string
    Name of the Virtual Network.
    end_address 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.
    route_name string
    Name of the Virtual Network route.
    route_type 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.

    start_address 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 String
    Name of the App Service plan.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    vnetName 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 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 string
    Name of the App Service plan.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    vnetName 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 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 str
    Name of the App Service plan.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    vnet_name 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 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 String
    Name of the App Service plan.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    vnetName 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 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:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    SystemData Pulumi.AzureNative.Web.Outputs.SystemDataResponse
    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"
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    SystemData SystemDataResponse
    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"
    azure_api_version string
    The Azure API version of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    system_data object
    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"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    systemData SystemDataResponse
    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"
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    systemData SystemDataResponse
    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"
    azure_api_version str
    The Azure API version of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    systemData Property Map
    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"

    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
    "DEFAULT"
    DEFAULT
    "INHERITED"
    INHERITED
    "STATIC"
    STATIC

    SystemDataResponse, SystemDataResponseArgs

    Metadata pertaining to creation and last modification of the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    created_at string
    The timestamp of resource creation (UTC).
    created_by string
    The identity that created the resource.
    created_by_type string
    The type of identity that created the resource.
    last_modified_at string
    The timestamp of resource last modification (UTC)
    last_modified_by string
    The identity that last modified the resource.
    last_modified_by_type string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.26.0
    published on Thursday, Aug 13, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial