PrivateEndpointConnections interface
Interface representing a PrivateEndpointConnections.
Methods
Method Details
deleteByHostPool(string, string, string, PrivateEndpointConnectionsDeleteByHostPoolOptionalParams)
Remove a connection.
function deleteByHostPool(resourceGroupName: string, hostPoolName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteByHostPoolOptionalParams): Promise<void>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- hostPoolName
-
string
The name of the host pool within the specified resource group
- privateEndpointConnectionName
-
string
The name of the private endpoint connection associated with the Azure resource.
The options parameters.
Returns
Promise<void>
deleteByWorkspace(string, string, string, PrivateEndpointConnectionsDeleteByWorkspaceOptionalParams)
Remove a connection.
function deleteByWorkspace(resourceGroupName: string, workspaceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteByWorkspaceOptionalParams): Promise<void>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace
- privateEndpointConnectionName
-
string
The name of the private endpoint connection associated with the Azure resource.
The options parameters.
Returns
Promise<void>
getByHostPool(string, string, string, PrivateEndpointConnectionsGetByHostPoolOptionalParams)
Get a private endpoint connection.
function getByHostPool(resourceGroupName: string, hostPoolName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetByHostPoolOptionalParams): Promise<PrivateEndpointConnectionWithSystemData>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- hostPoolName
-
string
The name of the host pool within the specified resource group
- privateEndpointConnectionName
-
string
The name of the private endpoint connection associated with the Azure resource.
The options parameters.
Returns
getByWorkspace(string, string, string, PrivateEndpointConnectionsGetByWorkspaceOptionalParams)
Get a private endpoint connection.
function getByWorkspace(resourceGroupName: string, workspaceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetByWorkspaceOptionalParams): Promise<PrivateEndpointConnectionWithSystemData>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace
- privateEndpointConnectionName
-
string
The name of the private endpoint connection associated with the Azure resource.
The options parameters.
Returns
listByHostPool(string, string, PrivateEndpointConnectionsListByHostPoolOptionalParams)
List private endpoint connections associated with hostpool.
function listByHostPool(resourceGroupName: string, hostPoolName: string, options?: PrivateEndpointConnectionsListByHostPoolOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnectionWithSystemData, PrivateEndpointConnectionWithSystemData[], PageSettings>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- hostPoolName
-
string
The name of the host pool within the specified resource group
The options parameters.
Returns
listByWorkspace(string, string, PrivateEndpointConnectionsListByWorkspaceOptionalParams)
List private endpoint connections.
function listByWorkspace(resourceGroupName: string, workspaceName: string, options?: PrivateEndpointConnectionsListByWorkspaceOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnectionWithSystemData, PrivateEndpointConnectionWithSystemData[], PageSettings>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace
The options parameters.
Returns
updateByHostPool(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsUpdateByHostPoolOptionalParams)
Approve or reject a private endpoint connection.
function updateByHostPool(resourceGroupName: string, hostPoolName: string, privateEndpointConnectionName: string, connection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsUpdateByHostPoolOptionalParams): Promise<PrivateEndpointConnectionWithSystemData>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- hostPoolName
-
string
The name of the host pool within the specified resource group
- privateEndpointConnectionName
-
string
The name of the private endpoint connection associated with the Azure resource.
- connection
- PrivateEndpointConnection
Object containing the updated connection.
The options parameters.
Returns
updateByWorkspace(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsUpdateByWorkspaceOptionalParams)
Approve or reject a private endpoint connection.
function updateByWorkspace(resourceGroupName: string, workspaceName: string, privateEndpointConnectionName: string, connection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsUpdateByWorkspaceOptionalParams): Promise<PrivateEndpointConnectionWithSystemData>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace
- privateEndpointConnectionName
-
string
The name of the private endpoint connection associated with the Azure resource.
- connection
- PrivateEndpointConnection
Object containing the updated connection.
The options parameters.