Class Endpoint

Manages a Private Endpoint.

NOTE Private Endpoint is currently in Public Preview.

Azure Private Endpoint is a network interface that connects you privately and securely to a service powered by Azure Private Link. Private Endpoint uses a private IP address from your VNet, effectively bringing the service into your VNet. The service could be an Azure service such as Azure Storage, SQL, etc. or your own Private Link Service.

Inheritance

System.Object

Resource

CustomResource

Endpoint

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.PrivateLink

Assembly: Pulumi.Azure.dll

Syntax

public class Endpoint : CustomResource

Constructors

Endpoint(String, EndpointArgs, CustomResourceOptions)

Create a Endpoint resource with the given unique name, arguments, and options.

Declaration

public Endpoint(string name, EndpointArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
EndpointArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Location

The supported Azure location where the resource exists. Changing this forces a new resource to be created.

Declaration

public Output<string> Location { get; }

Property Value

Type	Description
Output<System.String>

Name

Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

PrivateServiceConnection

A private_service_connection block as defined below.

Declaration

public Output<EndpointPrivateServiceConnection> PrivateServiceConnection { get; }

Property Value

Type	Description
Output<EndpointPrivateServiceConnection>

ResourceGroupName

Specifies the Name of the Resource Group within which the Private Endpoint should exist. Changing this forces a new resource to be created.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

SubnetId

The ID of the Subnet from which Private IP Addresses will be allocated for this Private Endpoint. Changing this forces a new resource to be created.

Declaration

public Output<string> SubnetId { get; }

Property Value

Type	Description
Output<System.String>

Tags

A mapping of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, string>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

Methods

Get(String, Input<String>, EndpointState, CustomResourceOptions)

Get an existing Endpoint resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Endpoint Get(string name, Input<string> id, EndpointState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
EndpointState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Endpoint