PrivateEndpointDestination Class

  • Reference

Class representing a Private Endpoint outbound rule.

Creating a PrivateEndpointDestination outbound rule object.


   from azure.ai.ml.entities import PrivateEndpointDestination

   # Example private endpoint outbound to a blob
   blobrule = PrivateEndpointDestination(
       name="blobrule",
       service_resource_id="/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/storage-name",
       subresource_target="blob",
       spark_enabled=False,
   )

   # Example private endpoint outbound to an application gateway
   appGwRule = PrivateEndpointDestination(
       name="appGwRule",
       service_resource_id="/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.Network/applicationGateways/appgw-name",  # cspell:disable-line
       subresource_target="appGwPrivateFrontendIpIPv4",
       spark_enabled=False,
       fqdns=["contoso.com", "contoso2.com"],
   )
Inheritance
azure.ai.ml.entities._workspace.networking.OutboundRule
PrivateEndpointDestination

Constructor

PrivateEndpointDestination(*, name: str, service_resource_id: str, subresource_target: str, spark_enabled: bool = False, fqdns: List[str] | None = None, **kwargs: Any)

Parameters

Name Description
name
Required
str

Name of the outbound rule.
service_resource_id
Required
str

The resource URI of the root service that supports creation of the private link.
subresource_target
Required
str

The target endpoint of the subresource of the service.
spark_enabled
Required
bool

Indicates if the private endpoint can be used for Spark jobs, default is "false".
fqdns
Required
List[str]

String list of FQDNs particular to the Private Endpoint resource creation. For application gateway Private Endpoints, this is the FQDN which will resolve to the private IP of the application gateway PE inside the workspace's managed network.

Keyword-Only Parameters

Name Description
name
Required
service_resource_id
Required
subresource_target
Required
spark_enabled
Required
fqdns
Required

Variables

Name Description
type
str

Type of the outbound rule. Set to "PrivateEndpoint" for this class.