PrivateEndpoint interface

Package:

@azure/arm-network

Private endpoint resource.

Extends

Resource

Properties

applicationSecurityGroups	Application security groups in which the private endpoint IP configuration is included.
customDnsConfigs	An array of custom dns configurations.
customNetworkInterfaceName	The custom name of the network interface attached to the private endpoint.
etag	A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.
extendedLocation	The extended location of the load balancer.
ipConfigurations	A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints.
manualPrivateLinkServiceConnections	A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.
networkInterfaces	An array of references to the network interfaces created for this private endpoint. NOTE: This property will not be serialized. It can only be populated by the server.
privateLinkServiceConnections	A grouping of information about the connection to the remote resource.
provisioningState	The provisioning state of the private endpoint resource. NOTE: This property will not be serialized. It can only be populated by the server.
subnet	The ID of the subnet from which the private IP will be allocated.

Inherited Properties

id	Resource ID.
location	Resource location.
name	Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags.
type	Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

applicationSecurityGroups

Application security groups in which the private endpoint IP configuration is included.

applicationSecurityGroups?: ApplicationSecurityGroup[]

Property Value

ApplicationSecurityGroup[]

customDnsConfigs

An array of custom dns configurations.

customDnsConfigs?: CustomDnsConfigPropertiesFormat[]

Property Value

CustomDnsConfigPropertiesFormat[]

customNetworkInterfaceName

The custom name of the network interface attached to the private endpoint.

customNetworkInterfaceName?: string

Property Value

string

etag

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

extendedLocation

The extended location of the load balancer.

extendedLocation?: ExtendedLocation

Property Value

ExtendedLocation

ipConfigurations

A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints.

ipConfigurations?: PrivateEndpointIPConfiguration[]

Property Value

PrivateEndpointIPConfiguration[]

manualPrivateLinkServiceConnections

A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.

manualPrivateLinkServiceConnections?: PrivateLinkServiceConnection[]

Property Value

PrivateLinkServiceConnection[]

networkInterfaces

An array of references to the network interfaces created for this private endpoint. NOTE: This property will not be serialized. It can only be populated by the server.

networkInterfaces?: NetworkInterface[]

Property Value

NetworkInterface[]

privateLinkServiceConnections

A grouping of information about the connection to the remote resource.

privateLinkServiceConnections?: PrivateLinkServiceConnection[]

Property Value

PrivateLinkServiceConnection[]

provisioningState

The provisioning state of the private endpoint resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

subnet

The ID of the subnet from which the private IP will be allocated.

subnet?: Subnet

Property Value

Subnet

Inherited Property Details

id

Resource ID.

id?: string

Property Value

string

Inherited From Resource.id

location

Resource location.

location?: string

Property Value

string

Inherited From Resource.location

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type