PrivateEndPoint Class
Defines a private endpoint for managing private endpoint connections associated with an Azure ML workspace.
Initialize PrivateEndPoint.
Constructor
PrivateEndPoint(private_endpoint_connection_resource_id=None, private_endpoint_resource_id=None)
Parameters
| Name | Description |
|---|---|
|
private_endpoint_connection_resource_id
|
The ARM resource ID of the private endpoint connection. Default value: None
|
|
private_endpoint_resource_id
|
The ARM resource ID of the private endpoint. Default value: None
|
|
private_endpoint_connection_resource_id
Required
|
The ARM resource ID of the private endpoint connection. |
|
private_endpoint_resource_id
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
| Name | Description |
|---|---|
|
auth
|
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. Default value: None
|
Returns
| Type | Description |
|---|---|
|
None if successful; otherwise, throws an error. |
get_details
Get details of the private end point.
get_details(auth=None)
Parameters
| Name | Description |
|---|---|
|
auth
|
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. Default value: None
|
Returns
| Type | Description |
|---|---|
|
Private endpoint details in dictionary format. |