Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. offazure
  5. PrivateEndpointConnection
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.offazure.PrivateEndpointConnection

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

REST model used to encapsulate the user visible state of a PrivateEndpoint.

Uses Azure REST API version 2020-07-07. In version 1.x of the Azure Native provider, it used API version 2020-07-07.

Example Usage

Put privateEndpointConnection

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var privateEndpointConnection = new AzureNative.OffAzure.PrivateEndpointConnection("privateEndpointConnection", new()
    {
        PeConnectionName = "privateendpt1938mastersit9007pe.4f2f2970-0bfa-45d4-9ee1-d9f79502fc6f",
        ResourceGroupName = "ayagrawrg",
        SiteName = "privateendpt1938mastersite",
    });

});
Copy
package main

import (
	offazure "github.com/pulumi/pulumi-azure-native-sdk/offazure/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := offazure.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &offazure.PrivateEndpointConnectionArgs{
			PeConnectionName:  pulumi.String("privateendpt1938mastersit9007pe.4f2f2970-0bfa-45d4-9ee1-d9f79502fc6f"),
			ResourceGroupName: pulumi.String("ayagrawrg"),
			SiteName:          pulumi.String("privateendpt1938mastersite"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.offazure.PrivateEndpointConnection;
import com.pulumi.azurenative.offazure.PrivateEndpointConnectionArgs;
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 privateEndpointConnection = new PrivateEndpointConnection("privateEndpointConnection", PrivateEndpointConnectionArgs.builder()
            .peConnectionName("privateendpt1938mastersit9007pe.4f2f2970-0bfa-45d4-9ee1-d9f79502fc6f")
            .resourceGroupName("ayagrawrg")
            .siteName("privateendpt1938mastersite")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const privateEndpointConnection = new azure_native.offazure.PrivateEndpointConnection("privateEndpointConnection", {
    peConnectionName: "privateendpt1938mastersit9007pe.4f2f2970-0bfa-45d4-9ee1-d9f79502fc6f",
    resourceGroupName: "ayagrawrg",
    siteName: "privateendpt1938mastersite",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

private_endpoint_connection = azure_native.offazure.PrivateEndpointConnection("privateEndpointConnection",
    pe_connection_name="privateendpt1938mastersit9007pe.4f2f2970-0bfa-45d4-9ee1-d9f79502fc6f",
    resource_group_name="ayagrawrg",
    site_name="privateendpt1938mastersite")
Copy
resources:
  privateEndpointConnection:
    type: azure-native:offazure:PrivateEndpointConnection
    properties:
      peConnectionName: privateendpt1938mastersit9007pe.4f2f2970-0bfa-45d4-9ee1-d9f79502fc6f
      resourceGroupName: ayagrawrg
      siteName: privateendpt1938mastersite
Copy

Create PrivateEndpointConnection Resource

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

Constructor syntax

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

@overload
def PrivateEndpointConnection(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              resource_group_name: Optional[str] = None,
                              site_name: Optional[str] = None,
                              pe_connection_name: Optional[str] = None)
func NewPrivateEndpointConnection(ctx *Context, name string, args PrivateEndpointConnectionArgs, opts ...ResourceOption) (*PrivateEndpointConnection, error)
public PrivateEndpointConnection(string name, PrivateEndpointConnectionArgs args, CustomResourceOptions? opts = null)
public PrivateEndpointConnection(String name, PrivateEndpointConnectionArgs args)
public PrivateEndpointConnection(String name, PrivateEndpointConnectionArgs args, CustomResourceOptions options)

type: azure-native:offazure:PrivateEndpointConnection
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. PrivateEndpointConnectionArgs
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. PrivateEndpointConnectionArgs
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. PrivateEndpointConnectionArgs
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. PrivateEndpointConnectionArgs
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. PrivateEndpointConnectionArgs
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 exampleprivateEndpointConnectionResourceResourceFromOffazure = new AzureNative.OffAzure.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromOffazure", new()
{
    ResourceGroupName = "string",
    SiteName = "string",
    PeConnectionName = "string",
});
Copy
example, err := offazure.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromOffazure", &offazure.PrivateEndpointConnectionArgs{
	ResourceGroupName: pulumi.String("string"),
	SiteName:          pulumi.String("string"),
	PeConnectionName:  pulumi.String("string"),
})
Copy
var exampleprivateEndpointConnectionResourceResourceFromOffazure = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromOffazure", PrivateEndpointConnectionArgs.builder()
    .resourceGroupName("string")
    .siteName("string")
    .peConnectionName("string")
    .build());
Copy
exampleprivate_endpoint_connection_resource_resource_from_offazure = azure_native.offazure.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromOffazure",
    resource_group_name="string",
    site_name="string",
    pe_connection_name="string")
Copy
const exampleprivateEndpointConnectionResourceResourceFromOffazure = new azure_native.offazure.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromOffazure", {
    resourceGroupName: "string",
    siteName: "string",
    peConnectionName: "string",
});
Copy
type: azure-native:offazure:PrivateEndpointConnection
properties:
    peConnectionName: string
    resourceGroupName: string
    siteName: string
Copy

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

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SiteName
This property is required.
Changes to this property will trigger replacement.
string
Site name.
PeConnectionName Changes to this property will trigger replacement. string
Private link resource name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SiteName
This property is required.
Changes to this property will trigger replacement.
string
Site name.
PeConnectionName Changes to this property will trigger replacement. string
Private link resource name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
siteName
This property is required.
Changes to this property will trigger replacement.
String
Site name.
peConnectionName Changes to this property will trigger replacement. String
Private link resource name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
siteName
This property is required.
Changes to this property will trigger replacement.
string
Site name.
peConnectionName Changes to this property will trigger replacement. string
Private link resource name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
site_name
This property is required.
Changes to this property will trigger replacement.
str
Site name.
pe_connection_name Changes to this property will trigger replacement. str
Private link resource name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
siteName
This property is required.
Changes to this property will trigger replacement.
String
Site name.
peConnectionName Changes to this property will trigger replacement. String
Private link resource name.

Outputs

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

ETag string
Gets the tag for optimistic concurrency control.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Gets the name of the resource.
Properties Pulumi.AzureNative.OffAzure.Outputs.PrivateEndpointConnectionPropertiesResponse
Gets the properties of the object.
SystemData Pulumi.AzureNative.OffAzure.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
Gets the resource type.
ETag string
Gets the tag for optimistic concurrency control.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Gets the name of the resource.
Properties PrivateEndpointConnectionPropertiesResponse
Gets the properties of the object.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
Gets the resource type.
eTag String
Gets the tag for optimistic concurrency control.
id String
The provider-assigned unique ID for this managed resource.
name String
Gets the name of the resource.
properties PrivateEndpointConnectionPropertiesResponse
Gets the properties of the object.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
Gets the resource type.
eTag string
Gets the tag for optimistic concurrency control.
id string
The provider-assigned unique ID for this managed resource.
name string
Gets the name of the resource.
properties PrivateEndpointConnectionPropertiesResponse
Gets the properties of the object.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
Gets the resource type.
e_tag str
Gets the tag for optimistic concurrency control.
id str
The provider-assigned unique ID for this managed resource.
name str
Gets the name of the resource.
properties PrivateEndpointConnectionPropertiesResponse
Gets the properties of the object.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
Gets the resource type.
eTag String
Gets the tag for optimistic concurrency control.
id String
The provider-assigned unique ID for this managed resource.
name String
Gets the name of the resource.
properties Property Map
Gets the properties of the object.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
Gets the resource type.

Supporting Types

PrivateEndpointConnectionPropertiesResponse
, PrivateEndpointConnectionPropertiesResponseArgs

privateEndpoint This property is required. Property Map
provisioningState This property is required. String
privateLinkServiceConnectionState Property Map

PrivateLinkServiceConnectionStateResponse
, PrivateLinkServiceConnectionStateResponseArgs

ActionsRequired string
actions required
Description string
description string
Status string
state status
ActionsRequired string
actions required
Description string
description string
Status string
state status
actionsRequired String
actions required
description String
description string
status String
state status
actionsRequired string
actions required
description string
description string
status string
state status
actions_required str
actions required
description str
description string
status str
state status
actionsRequired String
actions required
description String
description string
status String
state status

ResourceIdResponse
, ResourceIdResponseArgs

Id This property is required. string
id name
Id This property is required. string
id name
id This property is required. String
id name
id This property is required. string
id name
id This property is required. str
id name
id This property is required. String
id name

SystemDataResponse
, SystemDataResponseArgs

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.
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.

Import

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

$ pulumi import azure-native:offazure:PrivateEndpointConnection privateendpt1938mastersit9007pe.4f2f2970-0bfa-45d4-9ee1-d9f79502fc6f /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateEndpointConnections/{peConnectionName}
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native