1. Packages
  2. Azure Native
  3. API Docs
  4. web
  5. WebAppPrivateEndpointConnection
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.51.0 published on Tuesday, Jul 23, 2024 by Pulumi

azure-native.web.WebAppPrivateEndpointConnection

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.51.0 published on Tuesday, Jul 23, 2024 by Pulumi

    Remote Private Endpoint Connection ARM resource. Azure REST API version: 2022-09-01. Prior API version in Azure Native 1.x: 2020-12-01.

    Other available API versions: 2020-10-01, 2023-01-01, 2023-12-01.

    Example Usage

    Approves or rejects a private endpoint connection for a site.

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var webAppPrivateEndpointConnection = new AzureNative.Web.WebAppPrivateEndpointConnection("webAppPrivateEndpointConnection", new()
        {
            Name = "testSite",
            PrivateEndpointConnectionName = "connection",
            PrivateLinkServiceConnectionState = new AzureNative.Web.Inputs.PrivateLinkConnectionStateArgs
            {
                ActionsRequired = "",
                Description = "Approved by admin.",
                Status = "Approved",
            },
            ResourceGroupName = "rg",
        });
    
    });
    
    package main
    
    import (
    	web "github.com/pulumi/pulumi-azure-native-sdk/web/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := web.NewWebAppPrivateEndpointConnection(ctx, "webAppPrivateEndpointConnection", &web.WebAppPrivateEndpointConnectionArgs{
    			Name:                          pulumi.String("testSite"),
    			PrivateEndpointConnectionName: pulumi.String("connection"),
    			PrivateLinkServiceConnectionState: &web.PrivateLinkConnectionStateArgs{
    				ActionsRequired: pulumi.String(""),
    				Description:     pulumi.String("Approved by admin."),
    				Status:          pulumi.String("Approved"),
    			},
    			ResourceGroupName: pulumi.String("rg"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.web.WebAppPrivateEndpointConnection;
    import com.pulumi.azurenative.web.WebAppPrivateEndpointConnectionArgs;
    import com.pulumi.azurenative.web.inputs.PrivateLinkConnectionStateArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var webAppPrivateEndpointConnection = new WebAppPrivateEndpointConnection("webAppPrivateEndpointConnection", WebAppPrivateEndpointConnectionArgs.builder()
                .name("testSite")
                .privateEndpointConnectionName("connection")
                .privateLinkServiceConnectionState(PrivateLinkConnectionStateArgs.builder()
                    .actionsRequired("")
                    .description("Approved by admin.")
                    .status("Approved")
                    .build())
                .resourceGroupName("rg")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    web_app_private_endpoint_connection = azure_native.web.WebAppPrivateEndpointConnection("webAppPrivateEndpointConnection",
        name="testSite",
        private_endpoint_connection_name="connection",
        private_link_service_connection_state={
            "actions_required": "",
            "description": "Approved by admin.",
            "status": "Approved",
        },
        resource_group_name="rg")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const webAppPrivateEndpointConnection = new azure_native.web.WebAppPrivateEndpointConnection("webAppPrivateEndpointConnection", {
        name: "testSite",
        privateEndpointConnectionName: "connection",
        privateLinkServiceConnectionState: {
            actionsRequired: "",
            description: "Approved by admin.",
            status: "Approved",
        },
        resourceGroupName: "rg",
    });
    
    resources:
      webAppPrivateEndpointConnection:
        type: azure-native:web:WebAppPrivateEndpointConnection
        properties:
          name: testSite
          privateEndpointConnectionName: connection
          privateLinkServiceConnectionState:
            actionsRequired:
            description: Approved by admin.
            status: Approved
          resourceGroupName: rg
    

    Create WebAppPrivateEndpointConnection Resource

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

    Constructor syntax

    new WebAppPrivateEndpointConnection(name: string, args: WebAppPrivateEndpointConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def WebAppPrivateEndpointConnection(resource_name: str,
                                        args: WebAppPrivateEndpointConnectionArgs,
                                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def WebAppPrivateEndpointConnection(resource_name: str,
                                        opts: Optional[ResourceOptions] = None,
                                        name: Optional[str] = None,
                                        resource_group_name: Optional[str] = None,
                                        ip_addresses: Optional[Sequence[str]] = None,
                                        kind: Optional[str] = None,
                                        private_endpoint_connection_name: Optional[str] = None,
                                        private_link_service_connection_state: Optional[PrivateLinkConnectionStateArgs] = None)
    func NewWebAppPrivateEndpointConnection(ctx *Context, name string, args WebAppPrivateEndpointConnectionArgs, opts ...ResourceOption) (*WebAppPrivateEndpointConnection, error)
    public WebAppPrivateEndpointConnection(string name, WebAppPrivateEndpointConnectionArgs args, CustomResourceOptions? opts = null)
    public WebAppPrivateEndpointConnection(String name, WebAppPrivateEndpointConnectionArgs args)
    public WebAppPrivateEndpointConnection(String name, WebAppPrivateEndpointConnectionArgs args, CustomResourceOptions options)
    
    type: azure-native:web:WebAppPrivateEndpointConnection
    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 WebAppPrivateEndpointConnectionArgs
    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 WebAppPrivateEndpointConnectionArgs
    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 WebAppPrivateEndpointConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WebAppPrivateEndpointConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WebAppPrivateEndpointConnectionArgs
    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 webAppPrivateEndpointConnectionResource = new AzureNative.Web.WebAppPrivateEndpointConnection("webAppPrivateEndpointConnectionResource", new()
    {
        Name = "string",
        ResourceGroupName = "string",
        IpAddresses = new[]
        {
            "string",
        },
        Kind = "string",
        PrivateEndpointConnectionName = "string",
        PrivateLinkServiceConnectionState = new AzureNative.Web.Inputs.PrivateLinkConnectionStateArgs
        {
            ActionsRequired = "string",
            Description = "string",
            Status = "string",
        },
    });
    
    example, err := web.NewWebAppPrivateEndpointConnection(ctx, "webAppPrivateEndpointConnectionResource", &web.WebAppPrivateEndpointConnectionArgs{
    	Name:              pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	IpAddresses: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Kind:                          pulumi.String("string"),
    	PrivateEndpointConnectionName: pulumi.String("string"),
    	PrivateLinkServiceConnectionState: &web.PrivateLinkConnectionStateArgs{
    		ActionsRequired: pulumi.String("string"),
    		Description:     pulumi.String("string"),
    		Status:          pulumi.String("string"),
    	},
    })
    
    var webAppPrivateEndpointConnectionResource = new WebAppPrivateEndpointConnection("webAppPrivateEndpointConnectionResource", WebAppPrivateEndpointConnectionArgs.builder()
        .name("string")
        .resourceGroupName("string")
        .ipAddresses("string")
        .kind("string")
        .privateEndpointConnectionName("string")
        .privateLinkServiceConnectionState(PrivateLinkConnectionStateArgs.builder()
            .actionsRequired("string")
            .description("string")
            .status("string")
            .build())
        .build());
    
    web_app_private_endpoint_connection_resource = azure_native.web.WebAppPrivateEndpointConnection("webAppPrivateEndpointConnectionResource",
        name="string",
        resource_group_name="string",
        ip_addresses=["string"],
        kind="string",
        private_endpoint_connection_name="string",
        private_link_service_connection_state={
            "actionsRequired": "string",
            "description": "string",
            "status": "string",
        })
    
    const webAppPrivateEndpointConnectionResource = new azure_native.web.WebAppPrivateEndpointConnection("webAppPrivateEndpointConnectionResource", {
        name: "string",
        resourceGroupName: "string",
        ipAddresses: ["string"],
        kind: "string",
        privateEndpointConnectionName: "string",
        privateLinkServiceConnectionState: {
            actionsRequired: "string",
            description: "string",
            status: "string",
        },
    });
    
    type: azure-native:web:WebAppPrivateEndpointConnection
    properties:
        ipAddresses:
            - string
        kind: string
        name: string
        privateEndpointConnectionName: string
        privateLinkServiceConnectionState:
            actionsRequired: string
            description: string
            status: string
        resourceGroupName: string
    

    WebAppPrivateEndpointConnection Resource Properties

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

    Inputs

    The WebAppPrivateEndpointConnection resource accepts the following input properties:

    Name string
    Name of the site.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    IpAddresses List<string>
    Private IPAddresses mapped to the remote private endpoint
    Kind string
    Kind of resource.
    PrivateEndpointConnectionName string
    PrivateLinkServiceConnectionState Pulumi.AzureNative.Web.Inputs.PrivateLinkConnectionState
    The state of a private link connection
    Name string
    Name of the site.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    IpAddresses []string
    Private IPAddresses mapped to the remote private endpoint
    Kind string
    Kind of resource.
    PrivateEndpointConnectionName string
    PrivateLinkServiceConnectionState PrivateLinkConnectionStateArgs
    The state of a private link connection
    name String
    Name of the site.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    ipAddresses List<String>
    Private IPAddresses mapped to the remote private endpoint
    kind String
    Kind of resource.
    privateEndpointConnectionName String
    privateLinkServiceConnectionState PrivateLinkConnectionState
    The state of a private link connection
    name string
    Name of the site.
    resourceGroupName string
    Name of the resource group to which the resource belongs.
    ipAddresses string[]
    Private IPAddresses mapped to the remote private endpoint
    kind string
    Kind of resource.
    privateEndpointConnectionName string
    privateLinkServiceConnectionState PrivateLinkConnectionState
    The state of a private link connection
    name str
    Name of the site.
    resource_group_name str
    Name of the resource group to which the resource belongs.
    ip_addresses Sequence[str]
    Private IPAddresses mapped to the remote private endpoint
    kind str
    Kind of resource.
    private_endpoint_connection_name str
    private_link_service_connection_state PrivateLinkConnectionStateArgs
    The state of a private link connection
    name String
    Name of the site.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    ipAddresses List<String>
    Private IPAddresses mapped to the remote private endpoint
    kind String
    Kind of resource.
    privateEndpointConnectionName String
    privateLinkServiceConnectionState Property Map
    The state of a private link connection

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    ProvisioningState string
    Type string
    Resource type.
    PrivateEndpoint Pulumi.AzureNative.Web.Outputs.ArmIdWrapperResponse
    PrivateEndpoint of a remote private endpoint connection
    Id string
    The provider-assigned unique ID for this managed resource.
    ProvisioningState string
    Type string
    Resource type.
    PrivateEndpoint ArmIdWrapperResponse
    PrivateEndpoint of a remote private endpoint connection
    id String
    The provider-assigned unique ID for this managed resource.
    provisioningState String
    type String
    Resource type.
    privateEndpoint ArmIdWrapperResponse
    PrivateEndpoint of a remote private endpoint connection
    id string
    The provider-assigned unique ID for this managed resource.
    provisioningState string
    type string
    Resource type.
    privateEndpoint ArmIdWrapperResponse
    PrivateEndpoint of a remote private endpoint connection
    id str
    The provider-assigned unique ID for this managed resource.
    provisioning_state str
    type str
    Resource type.
    private_endpoint ArmIdWrapperResponse
    PrivateEndpoint of a remote private endpoint connection
    id String
    The provider-assigned unique ID for this managed resource.
    provisioningState String
    type String
    Resource type.
    privateEndpoint Property Map
    PrivateEndpoint of a remote private endpoint connection

    Supporting Types

    ArmIdWrapperResponse, ArmIdWrapperResponseArgs

    Id string
    Id string
    id String
    id string
    id str
    id String

    PrivateLinkConnectionState, PrivateLinkConnectionStateArgs

    ActionsRequired string
    ActionsRequired for a private link connection
    Description string
    Description of a private link connection
    Status string
    Status of a private link connection
    ActionsRequired string
    ActionsRequired for a private link connection
    Description string
    Description of a private link connection
    Status string
    Status of a private link connection
    actionsRequired String
    ActionsRequired for a private link connection
    description String
    Description of a private link connection
    status String
    Status of a private link connection
    actionsRequired string
    ActionsRequired for a private link connection
    description string
    Description of a private link connection
    status string
    Status of a private link connection
    actions_required str
    ActionsRequired for a private link connection
    description str
    Description of a private link connection
    status str
    Status of a private link connection
    actionsRequired String
    ActionsRequired for a private link connection
    description String
    Description of a private link connection
    status String
    Status of a private link connection

    PrivateLinkConnectionStateResponse, PrivateLinkConnectionStateResponseArgs

    ActionsRequired string
    ActionsRequired for a private link connection
    Description string
    Description of a private link connection
    Status string
    Status of a private link connection
    ActionsRequired string
    ActionsRequired for a private link connection
    Description string
    Description of a private link connection
    Status string
    Status of a private link connection
    actionsRequired String
    ActionsRequired for a private link connection
    description String
    Description of a private link connection
    status String
    Status of a private link connection
    actionsRequired string
    ActionsRequired for a private link connection
    description string
    Description of a private link connection
    status string
    Status of a private link connection
    actions_required str
    ActionsRequired for a private link connection
    description str
    Description of a private link connection
    status str
    Status of a private link connection
    actionsRequired String
    ActionsRequired for a private link connection
    description String
    Description of a private link connection
    status String
    Status of a private link connection

    Import

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

    $ pulumi import azure-native:web:WebAppPrivateEndpointConnection connection /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections/{privateEndpointConnectionName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    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 v1 docs if using the v1 version of this package.
    Azure Native v2.51.0 published on Tuesday, Jul 23, 2024 by Pulumi