Share via

PrivateEndpoint Class

  • Reference

Private endpoint resource.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

PrivateEndpoint(*, id: str | None = None, location: str | None = None, tags: Dict[str, str] | None = None, extended_location: _models.ExtendedLocation | None = None, subnet: _models.Subnet | None = None, private_link_service_connections: List[_models.PrivateLinkServiceConnection] | None = None, manual_private_link_service_connections: List[_models.PrivateLinkServiceConnection] | None = None, custom_dns_configs: List[_models.CustomDnsConfigPropertiesFormat] | None = None, application_security_groups: List[_models.ApplicationSecurityGroup] | None = None, ip_configurations: List[_models.PrivateEndpointIPConfiguration] | None = None, custom_network_interface_name: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
id
str

Resource ID.

Default value: None
location
str

Resource location.

Default value: None
tags
dict[str, str]

Resource tags.

Default value: None
extended_location
ExtendedLocation

The extended location of the load balancer.

Default value: None
subnet
Subnet

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

Default value: None
private_link_service_connections
list[PrivateLinkServiceConnection]

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

Default value: None
manual_private_link_service_connections
list[PrivateLinkServiceConnection]

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.

Default value: None
custom_dns_configs
list[CustomDnsConfigPropertiesFormat]

An array of custom dns configurations.

Default value: None
application_security_groups
list[ApplicationSecurityGroup]

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

Default value: None
ip_configurations
list[PrivateEndpointIPConfiguration]

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

Default value: None
custom_network_interface_name
str

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

Default value: None

Variables

Name Description
id
str

Resource ID.
name
str

Resource name.
type
str

Resource type.
location
str

Resource location.
tags
dict[str, str]

Resource tags.
extended_location
ExtendedLocation

The extended location of the load balancer.
etag
str

A unique read-only string that changes whenever the resource is updated.
subnet
Subnet

The ID of the subnet from which the private IP will be allocated.
network_interfaces
list[NetworkInterface]

An array of references to the network interfaces created for this private endpoint.
provisioning_state
str or ProvisioningState

The provisioning state of the private endpoint resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".
private_link_service_connections
list[PrivateLinkServiceConnection]

A grouping of information about the connection to the remote resource.
manual_private_link_service_connections
list[PrivateLinkServiceConnection]

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.
custom_dns_configs
list[CustomDnsConfigPropertiesFormat]

An array of custom dns configurations.
application_security_groups
list[ApplicationSecurityGroup]

Application security groups in which the private endpoint IP configuration is included.
ip_configurations
list[PrivateEndpointIPConfiguration]

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

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