PrivateEndpoint interface
Private endpoint resource.
- Extends
Properties
| application |
Application security groups in which the private endpoint IP configuration is included. |
| billing |
The billing sku of the private endpoint. |
| custom |
An array of custom dns configurations. |
| custom |
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. |
| extended |
The extended location of the load balancer. |
| ip |
A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. |
| ip |
Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. |
| manual |
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. |
| network |
An array of references to the network interfaces created for this private endpoint. |
| private |
A grouping of information about the connection to the remote resource. |
| provisioning |
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
location
name
tags
Resource tags.
tags?: Record<string, string>
Property Value
Record<string, string>
Inherited From Resource.tags