PrivateEndpointProperties Class

Properties of the private endpoint.

Constructor

PrivateEndpointProperties(*args: Any, **kwargs: Any)

Variables

Name	Description
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".
ip_version_type	str or PrivateEndpointIPVersionType Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. Known values are: "IPv4", "IPv6", and "DualStack".
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.

Attributes

application_security_groups

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

application_security_groups: list['_models.ApplicationSecurityGroup'] | None

custom_dns_configs

An array of custom dns configurations.

custom_dns_configs: list['_models.CustomDnsConfigPropertiesFormat'] | None

custom_network_interface_name

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

custom_network_interface_name: str | None

ip_configurations

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

ip_configurations: list['_models.PrivateEndpointIPConfiguration'] | None

ip_version_type

Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. Known values are: "IPv4", "IPv6", and "DualStack".

ip_version_type: str | _models.PrivateEndpointIPVersionType | None

manual_private_link_service_connections

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.

manual_private_link_service_connections: list['_models.PrivateLinkServiceConnection'] | None

network_interfaces

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

network_interfaces: list['_models.NetworkInterface'] | None

private_link_service_connections

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

private_link_service_connections: list['_models.PrivateLinkServiceConnection'] | None

provisioning_state

"Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".

provisioning_state: str | _models.ProvisioningState | None

subnet

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

subnet: _models.Subnet | None