Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. web
  5. WebAppVnetConnection
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.web.WebAppVnetConnection

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Virtual Network information contract. API Version: 2020-12-01.

    Import

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

    $ pulumi import azure-native:web:WebAppVnetConnection myresource1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}

    Create WebAppVnetConnection Resource

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

    Constructor syntax

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

@overload
def WebAppVnetConnection(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         cert_blob: Optional[str] = None,
                         dns_servers: Optional[str] = None,
                         is_swift: Optional[bool] = None,
                         kind: Optional[str] = None,
                         vnet_name: Optional[str] = None,
                         vnet_resource_id: Optional[str] = None)
    func NewWebAppVnetConnection(ctx *Context, name string, args WebAppVnetConnectionArgs, opts ...ResourceOption) (*WebAppVnetConnection, error)
    public WebAppVnetConnection(string name, WebAppVnetConnectionArgs args, CustomResourceOptions? opts = null)
    public WebAppVnetConnection(String name, WebAppVnetConnectionArgs args)
public WebAppVnetConnection(String name, WebAppVnetConnectionArgs args, CustomResourceOptions options)

    type: azure-native:web:WebAppVnetConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args WebAppVnetConnectionArgs
    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 WebAppVnetConnectionArgs
    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 WebAppVnetConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WebAppVnetConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WebAppVnetConnectionArgs
    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 webAppVnetConnectionResource = new AzureNative.Web.WebAppVnetConnection("webAppVnetConnectionResource", new()
{
    Name = "string",
    ResourceGroupName = "string",
    CertBlob = "string",
    DnsServers = "string",
    IsSwift = false,
    Kind = "string",
    VnetName = "string",
    VnetResourceId = "string",
});

    example, err := web.NewWebAppVnetConnection(ctx, "webAppVnetConnectionResource", &web.WebAppVnetConnectionArgs{
	Name:              "string",
	ResourceGroupName: "string",
	CertBlob:          "string",
	DnsServers:        "string",
	IsSwift:           false,
	Kind:              "string",
	VnetName:          "string",
	VnetResourceId:    "string",
})

    var webAppVnetConnectionResource = new WebAppVnetConnection("webAppVnetConnectionResource", WebAppVnetConnectionArgs.builder()
    .name("string")
    .resourceGroupName("string")
    .certBlob("string")
    .dnsServers("string")
    .isSwift(false)
    .kind("string")
    .vnetName("string")
    .vnetResourceId("string")
    .build());

    web_app_vnet_connection_resource = azure_native.web.WebAppVnetConnection("webAppVnetConnectionResource",
    name=string,
    resource_group_name=string,
    cert_blob=string,
    dns_servers=string,
    is_swift=False,
    kind=string,
    vnet_name=string,
    vnet_resource_id=string)

    const webAppVnetConnectionResource = new azure_native.web.WebAppVnetConnection("webAppVnetConnectionResource", {
    name: "string",
    resourceGroupName: "string",
    certBlob: "string",
    dnsServers: "string",
    isSwift: false,
    kind: "string",
    vnetName: "string",
    vnetResourceId: "string",
});

    type: azure-native:web:WebAppVnetConnection
properties:
    certBlob: string
    dnsServers: string
    isSwift: false
    kind: string
    name: string
    resourceGroupName: string
    vnetName: string
    vnetResourceId: string

    WebAppVnetConnection 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 WebAppVnetConnection resource accepts the following input properties:

    Name string
    Name of the app.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    CertBlob string
    A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection.
    DnsServers string
    DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.
    IsSwift bool
    Flag that is used to denote if this is VNET injection
    Kind string
    Kind of resource.
    VnetName string
    Name of an existing Virtual Network.
    VnetResourceId string
    The Virtual Network's resource ID.
    Name string
    Name of the app.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    CertBlob string
    A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection.
    DnsServers string
    DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.
    IsSwift bool
    Flag that is used to denote if this is VNET injection
    Kind string
    Kind of resource.
    VnetName string
    Name of an existing Virtual Network.
    VnetResourceId string
    The Virtual Network's resource ID.
    name String
    Name of the app.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    certBlob String
    A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection.
    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
    kind String
    Kind of resource.
    vnetName String
    Name of an existing Virtual Network.
    vnetResourceId String
    The Virtual Network's resource ID.
    name string
    Name of the app.
    resourceGroupName string
    Name of the resource group to which the resource belongs.
    certBlob string
    A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection.
    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
    kind string
    Kind of resource.
    vnetName string
    Name of an existing Virtual Network.
    vnetResourceId string
    The Virtual Network's resource ID.
    name str
    Name of the app.
    resource_group_name str
    Name of the resource group to which the resource belongs.
    cert_blob str
    A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection.
    dns_servers str
    DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.
    is_swift bool
    Flag that is used to denote if this is VNET injection
    kind str
    Kind of resource.
    vnet_name str
    Name of an existing Virtual Network.
    vnet_resource_id str
    The Virtual Network's resource ID.
    name String
    Name of the app.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    certBlob String
    A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection.
    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
    kind String
    Kind of resource.
    vnetName String
    Name of an existing Virtual Network.
    vnetResourceId String
    The Virtual Network's resource ID.

    Outputs

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

    CertThumbprint string
    The client certificate thumbprint.
    Id string
    The provider-assigned unique ID for this managed resource.
    ResyncRequired bool
    true if a resync is required; otherwise, false.
    Routes List<Pulumi.AzureNative.Web.Outputs.VnetRouteResponse>
    The routes that this Virtual Network connection uses.
    Type string
    Resource type.
    CertThumbprint string
    The client certificate thumbprint.
    Id string
    The provider-assigned unique ID for this managed resource.
    ResyncRequired bool
    true if a resync is required; otherwise, false.
    Routes []VnetRouteResponse
    The routes that this Virtual Network connection uses.
    Type string
    Resource type.
    certThumbprint String
    The client certificate thumbprint.
    id String
    The provider-assigned unique ID for this managed resource.
    resyncRequired Boolean
    true if a resync is required; otherwise, false.
    routes List<VnetRouteResponse>
    The routes that this Virtual Network connection uses.
    type String
    Resource type.
    certThumbprint string
    The client certificate thumbprint.
    id string
    The provider-assigned unique ID for this managed resource.
    resyncRequired boolean
    true if a resync is required; otherwise, false.
    routes VnetRouteResponse[]
    The routes that this Virtual Network connection uses.
    type string
    Resource type.
    cert_thumbprint str
    The client certificate thumbprint.
    id str
    The provider-assigned unique ID for this managed resource.
    resync_required bool
    true if a resync is required; otherwise, false.
    routes Sequence[VnetRouteResponse]
    The routes that this Virtual Network connection uses.
    type str
    Resource type.
    certThumbprint String
    The client certificate thumbprint.
    id String
    The provider-assigned unique ID for this managed resource.
    resyncRequired Boolean
    true if a resync is required; otherwise, false.
    routes List<Property Map>
    The routes that this Virtual Network connection uses.
    type String
    Resource type.

    Supporting Types

    VnetRouteResponse, VnetRouteResponseArgs

    Id string
    Resource Id.
    Name string
    Resource Name.
    Type string
    Resource type.
    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.
    RouteType string

    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.
    Id string
    Resource Id.
    Name string
    Resource Name.
    Type string
    Resource type.
    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.
    RouteType string

    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.
    id String
    Resource Id.
    name String
    Resource Name.
    type String
    Resource type.
    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.
    routeType String

    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.
    id string
    Resource Id.
    name string
    Resource Name.
    type string
    Resource type.
    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.
    routeType string

    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.
    id str
    Resource Id.
    name str
    Resource Name.
    type str
    Resource type.
    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_type str

    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.
    id String
    Resource Id.
    name String
    Resource Name.
    type String
    Resource type.
    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.
    routeType String

    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.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native