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.

Create a Endpoint Resource

new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);

def Endpoint(resource_name, opts=None, location=None, name=None, private_dns_zone_group=None, private_service_connection=None, resource_group_name=None, subnet_id=None, tags=None, __props__=None);

func NewEndpoint(ctx *Context, name string, args EndpointArgs, opts ...ResourceOption) (*Endpoint, error)

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

name string: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Endpoint Resource Properties

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

Inputs

The Endpoint resource accepts the following input properties:

PrivateServiceConnection EndpointPrivateServiceConnectionArgs: A private_service_connection block as defined below.
ResourceGroupName string: Specifies the Name of the Resource Group within which the Private Endpoint should exist. Changing this forces a new resource to be created.
SubnetId string: 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.
Location string: The supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
PrivateDnsZoneGroup EndpointPrivateDnsZoneGroupArgs: A private_dns_zone_group block as defined below.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

PrivateServiceConnection EndpointPrivateServiceConnection: A private_service_connection block as defined below.
ResourceGroupName string: Specifies the Name of the Resource Group within which the Private Endpoint should exist. Changing this forces a new resource to be created.
SubnetId string: 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.
Location string: The supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
PrivateDnsZoneGroup EndpointPrivateDnsZoneGroup: A private_dns_zone_group block as defined below.
Tags map[string]string: A mapping of tags to assign to the resource.

privateServiceConnection EndpointPrivateServiceConnection: A private_service_connection block as defined below.
resourceGroupName string: Specifies the Name of the Resource Group within which the Private Endpoint should exist. Changing this forces a new resource to be created.
subnetId string: 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.
location string: The supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
privateDnsZoneGroup EndpointPrivateDnsZoneGroup: A private_dns_zone_group block as defined below.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

private_service_connection Dict[EndpointPrivateServiceConnection]: A private_service_connection block as defined below.
resource_group_name str: Specifies the Name of the Resource Group within which the Private Endpoint should exist. Changing this forces a new resource to be created.
subnet_id str: 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.
location str: The supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
private_dns_zone_group Dict[EndpointPrivateDnsZoneGroup]: A private_dns_zone_group block as defined below.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Outputs

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

CustomDnsConfigs List<EndpointCustomDnsConfig>
Id string: The provider-assigned unique ID for this managed resource.
PrivateDnsZoneConfigs List<EndpointPrivateDnsZoneConfig>

CustomDnsConfigs []EndpointCustomDnsConfig
Id string: The provider-assigned unique ID for this managed resource.
PrivateDnsZoneConfigs []EndpointPrivateDnsZoneConfig

customDnsConfigs EndpointCustomDnsConfig[]
id string: The provider-assigned unique ID for this managed resource.
privateDnsZoneConfigs EndpointPrivateDnsZoneConfig[]

custom_dns_configs List[EndpointCustomDnsConfig]
id str: The provider-assigned unique ID for this managed resource.
private_dns_zone_configs List[EndpointPrivateDnsZoneConfig]

Look up an Existing Endpoint Resource

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

public static get(name: string, id: Input<ID>, state?: EndpointState, opts?: CustomResourceOptions): Endpoint

static get(resource_name, id, opts=None, custom_dns_configs=None, location=None, name=None, private_dns_zone_configs=None, private_dns_zone_group=None, private_service_connection=None, resource_group_name=None, subnet_id=None, tags=None, __props__=None);

func GetEndpoint(ctx *Context, name string, id IDInput, state *EndpointState, opts ...ResourceOption) (*Endpoint, error)

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

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CustomDnsConfigs List<EndpointCustomDnsConfigArgs>
Location string: The supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
PrivateDnsZoneConfigs List<EndpointPrivateDnsZoneConfigArgs>
PrivateDnsZoneGroup EndpointPrivateDnsZoneGroupArgs: A private_dns_zone_group block as defined below.
PrivateServiceConnection EndpointPrivateServiceConnectionArgs: A private_service_connection block as defined below.
ResourceGroupName string: Specifies the Name of the Resource Group within which the Private Endpoint should exist. Changing this forces a new resource to be created.
SubnetId string: 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.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

CustomDnsConfigs []EndpointCustomDnsConfig
Location string: The supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
PrivateDnsZoneConfigs []EndpointPrivateDnsZoneConfig
PrivateDnsZoneGroup EndpointPrivateDnsZoneGroup: A private_dns_zone_group block as defined below.
PrivateServiceConnection EndpointPrivateServiceConnection: A private_service_connection block as defined below.
ResourceGroupName string: Specifies the Name of the Resource Group within which the Private Endpoint should exist. Changing this forces a new resource to be created.
SubnetId string: 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.
Tags map[string]string: A mapping of tags to assign to the resource.

customDnsConfigs EndpointCustomDnsConfig[]
location string: The supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
privateDnsZoneConfigs EndpointPrivateDnsZoneConfig[]
privateDnsZoneGroup EndpointPrivateDnsZoneGroup: A private_dns_zone_group block as defined below.
privateServiceConnection EndpointPrivateServiceConnection: A private_service_connection block as defined below.
resourceGroupName string: Specifies the Name of the Resource Group within which the Private Endpoint should exist. Changing this forces a new resource to be created.
subnetId string: 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.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

custom_dns_configs List[EndpointCustomDnsConfig]
location str: The supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
private_dns_zone_configs List[EndpointPrivateDnsZoneConfig]
private_dns_zone_group Dict[EndpointPrivateDnsZoneGroup]: A private_dns_zone_group block as defined below.
private_service_connection Dict[EndpointPrivateServiceConnection]: A private_service_connection block as defined below.
resource_group_name str: Specifies the Name of the Resource Group within which the Private Endpoint should exist. Changing this forces a new resource to be created.
subnet_id str: 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.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Supporting Types

EndpointCustomDnsConfig

See the output API doc for this type.

Fqdn string: The fully qualified domain name to the private_dns_zone.
IpAddresses List<string>: A list of all IP Addresses that map to the private_dns_zone fqdn.

Fqdn string: The fully qualified domain name to the private_dns_zone.
IpAddresses []string: A list of all IP Addresses that map to the private_dns_zone fqdn.

fqdn string: The fully qualified domain name to the private_dns_zone.
ipAddresses string[]: A list of all IP Addresses that map to the private_dns_zone fqdn.

fqdn str: The fully qualified domain name to the private_dns_zone.
ipAddresses List[str]: A list of all IP Addresses that map to the private_dns_zone fqdn.

EndpointPrivateDnsZoneConfig

See the output API doc for this type.

Id string: The ID of the Private DNS Zone Config.
Name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
PrivateDnsZoneId string: A list of IP Addresses
RecordSets List<EndpointPrivateDnsZoneConfigRecordSetArgs>: A record_sets block as defined below.

Id string: The ID of the Private DNS Zone Config.
Name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
PrivateDnsZoneId string: A list of IP Addresses
RecordSets []EndpointPrivateDnsZoneConfigRecordSet: A record_sets block as defined below.

id string: The ID of the Private DNS Zone Config.
name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
privateDnsZoneId string: A list of IP Addresses
recordSets EndpointPrivateDnsZoneConfigRecordSet[]: A record_sets block as defined below.

id str: The ID of the Private DNS Zone Config.
name str: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
privateDnsZoneId str: A list of IP Addresses
recordSets List[EndpointPrivateDnsZoneConfigRecordSet]: A record_sets block as defined below.

EndpointPrivateDnsZoneConfigRecordSet

See the output API doc for this type.

Fqdn string: The fully qualified domain name to the private_dns_zone.
IpAddresses List<string>: A list of all IP Addresses that map to the private_dns_zone fqdn.
Name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
Ttl int: The time to live for each connection to the private_dns_zone.
Type string: The type of DNS record.

Fqdn string: The fully qualified domain name to the private_dns_zone.
IpAddresses []string: A list of all IP Addresses that map to the private_dns_zone fqdn.
Name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
Ttl int: The time to live for each connection to the private_dns_zone.
Type string: The type of DNS record.

fqdn string: The fully qualified domain name to the private_dns_zone.
ipAddresses string[]: A list of all IP Addresses that map to the private_dns_zone fqdn.
name string: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
ttl number: The time to live for each connection to the private_dns_zone.
type string: The type of DNS record.

fqdn str: The fully qualified domain name to the private_dns_zone.
ipAddresses List[str]: A list of all IP Addresses that map to the private_dns_zone fqdn.
name str: Specifies the Name of the Private Endpoint. Changing this forces a new resource to be created.
ttl float: The time to live for each connection to the private_dns_zone.
type str: The type of DNS record.

EndpointPrivateDnsZoneGroup

See the input and output API doc for this type.

Name string: Specifies the Name of the Private DNS Zone Group. Changing this forces a new private_dns_zone_group resource to be created.
PrivateDnsZoneIds List<string>: Specifies the list of Private DNS Zones to include within the private_dns_zone_group.
Id string: The ID of the Private DNS Zone Config.

Name string: Specifies the Name of the Private DNS Zone Group. Changing this forces a new private_dns_zone_group resource to be created.
PrivateDnsZoneIds []string: Specifies the list of Private DNS Zones to include within the private_dns_zone_group.
Id string: The ID of the Private DNS Zone Config.

name string: Specifies the Name of the Private DNS Zone Group. Changing this forces a new private_dns_zone_group resource to be created.
privateDnsZoneIds string[]: Specifies the list of Private DNS Zones to include within the private_dns_zone_group.
id string: The ID of the Private DNS Zone Config.

name str: Specifies the Name of the Private DNS Zone Group. Changing this forces a new private_dns_zone_group resource to be created.
privateDnsZoneIds List[str]: Specifies the list of Private DNS Zones to include within the private_dns_zone_group.
id str: The ID of the Private DNS Zone Config.

EndpointPrivateServiceConnection

See the input and output API doc for this type.

IsManualConnection bool: Does the Private Endpoint require Manual Approval from the remote resource owner? Changing this forces a new resource to be created.
Name string: Specifies the Name of the Private Service Connection. Changing this forces a new resource to be created.
PrivateConnectionResourceId string: The ID of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. Changing this forces a new resource to be created.
PrivateIpAddress string: The private IP address associated with the private endpoint, note that you will have a private IP address assigned to the private endpoint even if the connection request was Rejected.
RequestMessage string: A message passed to the owner of the remote resource when the private endpoint attempts to establish the connection to the remote resource. The request message can be a maximum of 140 characters in length. Only valid if is_manual_connection is set to true.
SubresourceNames List<string>: A list of subresource names which the Private Endpoint is able to connect to. subresource_names corresponds to group_id. Changing this forces a new resource to be created.

IsManualConnection bool: Does the Private Endpoint require Manual Approval from the remote resource owner? Changing this forces a new resource to be created.
Name string: Specifies the Name of the Private Service Connection. Changing this forces a new resource to be created.
PrivateConnectionResourceId string: The ID of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. Changing this forces a new resource to be created.
PrivateIpAddress string: The private IP address associated with the private endpoint, note that you will have a private IP address assigned to the private endpoint even if the connection request was Rejected.
RequestMessage string: A message passed to the owner of the remote resource when the private endpoint attempts to establish the connection to the remote resource. The request message can be a maximum of 140 characters in length. Only valid if is_manual_connection is set to true.
SubresourceNames []string: A list of subresource names which the Private Endpoint is able to connect to. subresource_names corresponds to group_id. Changing this forces a new resource to be created.

isManualConnection boolean: Does the Private Endpoint require Manual Approval from the remote resource owner? Changing this forces a new resource to be created.
name string: Specifies the Name of the Private Service Connection. Changing this forces a new resource to be created.
privateConnectionResourceId string: The ID of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. Changing this forces a new resource to be created.
privateIpAddress string: The private IP address associated with the private endpoint, note that you will have a private IP address assigned to the private endpoint even if the connection request was Rejected.
requestMessage string: A message passed to the owner of the remote resource when the private endpoint attempts to establish the connection to the remote resource. The request message can be a maximum of 140 characters in length. Only valid if is_manual_connection is set to true.
subresourceNames string[]: A list of subresource names which the Private Endpoint is able to connect to. subresource_names corresponds to group_id. Changing this forces a new resource to be created.

isManualConnection bool: Does the Private Endpoint require Manual Approval from the remote resource owner? Changing this forces a new resource to be created.
name str: Specifies the Name of the Private Service Connection. Changing this forces a new resource to be created.
privateConnectionResourceId str: The ID of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. Changing this forces a new resource to be created.
private_ip_address str: The private IP address associated with the private endpoint, note that you will have a private IP address assigned to the private endpoint even if the connection request was Rejected.
requestMessage str: A message passed to the owner of the remote resource when the private endpoint attempts to establish the connection to the remote resource. The request message can be a maximum of 140 characters in length. Only valid if is_manual_connection is set to true.
subresourceNames List[str]: A list of subresource names which the Private Endpoint is able to connect to. subresource_names corresponds to group_id. Changing this forces a new resource to be created.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Endpoint

Create a Endpoint Resource

Endpoint Resource Properties

Inputs

Outputs

Look up an Existing Endpoint Resource

Supporting Types

EndpointCustomDnsConfig

EndpointPrivateDnsZoneConfig

EndpointPrivateDnsZoneConfigRecordSet

EndpointPrivateDnsZoneGroup

EndpointPrivateServiceConnection

Package Details

On This Page