PrivateEndpoint interface

Private endpoint resource.

Extends

Properties

applicationSecurityGroups

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

billingSku

The billing sku of the private endpoint.

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.

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.

ipVersionType

Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4.

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.

privateLinkServiceConnections

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

provisioningState

The provisioning state of the private endpoint resource.

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.

tags

Resource tags.

type

Resource type.

Property Details

applicationSecurityGroups

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

applicationSecurityGroups?: ApplicationSecurityGroup[]

Property Value

billingSku

The billing sku of the private endpoint.

billingSku?: string

Property Value

string

customDnsConfigs

An array of custom dns configurations.

customDnsConfigs?: CustomDnsConfigPropertiesFormat[]

Property Value

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.

etag?: string

Property Value

string

extendedLocation

The extended location of the load balancer.

extendedLocation?: ExtendedLocation

Property Value

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

ipVersionType

Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4.

ipVersionType?: string

Property Value

string

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

networkInterfaces

An array of references to the network interfaces created for this private endpoint.

networkInterfaces?: NetworkInterface[]

Property Value

privateLinkServiceConnections

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

privateLinkServiceConnections?: PrivateLinkServiceConnection[]

Property Value

provisioningState

The provisioning state of the private endpoint resource.

provisioningState?: string

Property Value

string

subnet

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

subnet?: Subnet

Property Value

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.

name?: string

Property Value

string

Inherited From Resource.name

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From Resource.tags

type

Resource type.

type?: string

Property Value

string

Inherited From Resource.type