PrivateEndPoint Class

Defines a private endpoint for managing private endpoint connections associated with an Azure ML workspace.

Initialize PrivateEndPoint.

Inheritance

builtins.object

PrivateEndPoint

Constructor

PrivateEndPoint(private_endpoint_connection_resource_id=None, private_endpoint_resource_id=None)

Parameters

private_endpoint_connection_resource_id

str

default value: None

The ARM resource ID of the private endpoint connection.

private_endpoint_resource_id

str

default value: None

The ARM resource ID of the private endpoint.

private_endpoint_connection_resource_id

str

Required

The ARM resource ID of the private endpoint connection.

private_endpoint_resource_id

str

Required

The ARM resource ID of the private endpoint.

Methods

delete	Delete the private endpoint connection to the workspace. Note This function is deprecated and please use Workspace.delete_private_endpoint_connection
get_details	Get details of the private end point.

delete

Delete the private endpoint connection to the workspace.

Note

This function is deprecated and please use Workspace.delete_private_endpoint_connection

delete(auth=None)

Parameters

auth

ServicePrincipalAuthentication or InteractiveLoginAuthentication

default value: None

The authentication object. For more details refer to https://aka.ms/aml-notebook-auth. If None, the default Azure CLI credentials will be used or the API will prompt for credentials.

Returns

None if successful; otherwise, throws an error.

Return type

None

get_details

Get details of the private end point.

get_details(auth=None)

Parameters

auth

ServicePrincipalAuthentication or InteractiveLoginAuthentication

default value: None

The authentication object. For more details refer to https://aka.ms/aml-notebook-auth. If None, the default Azure CLI credentials will be used or the API will prompt for credentials.

Returns

Private endpoint details in dictionary format.

Return type

dict[str, str]