PrivateEndpointConnections | @azure/arm-desktopvirtualization

Interface representing a PrivateEndpointConnections.

Hierarchy

PrivateEndpointConnections

Implemented by

PrivateEndpointConnectionsImpl

Index

Methods

deleteByHostPool

deleteByHostPool(resourceGroupName: string, hostPoolName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteByHostPoolOptionalParams): Promise<void>

- Defined in operationsInterfaces/privateEndpointConnections.ts:74
Remove a connection.

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
- Optional options: PrivateEndpointConnectionsDeleteByHostPoolOptionalParams
  
  The options parameters.
Returns Promise<void>

deleteByWorkspace

deleteByWorkspace(resourceGroupName: string, workspaceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteByWorkspaceOptionalParams): Promise<void>

- Defined in operationsInterfaces/privateEndpointConnections.ts:118
Remove a connection.

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
- Optional options: PrivateEndpointConnectionsDeleteByWorkspaceOptionalParams
  
  The options parameters.
Returns Promise<void>

getByHostPool

getByHostPool(resourceGroupName: string, hostPoolName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetByHostPoolOptionalParams): Promise<PrivateEndpointConnectionsGetByHostPoolResponse>

- Defined in operationsInterfaces/privateEndpointConnections.ts:60
Get a private endpoint connection.

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
- Optional options: PrivateEndpointConnectionsGetByHostPoolOptionalParams
  
  The options parameters.
Returns Promise<PrivateEndpointConnectionsGetByHostPoolResponse>

getByWorkspace

getByWorkspace(resourceGroupName: string, workspaceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetByWorkspaceOptionalParams): Promise<PrivateEndpointConnectionsGetByWorkspaceResponse>

- Defined in operationsInterfaces/privateEndpointConnections.ts:104
Get a private endpoint connection.

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
- Optional options: PrivateEndpointConnectionsGetByWorkspaceOptionalParams
  
  The options parameters.
Returns Promise<PrivateEndpointConnectionsGetByWorkspaceResponse>

listByHostPool

listByHostPool(resourceGroupName: string, hostPoolName: string, options?: PrivateEndpointConnectionsListByHostPoolOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnectionWithSystemData>

- Defined in operationsInterfaces/privateEndpointConnections.ts:36
List private endpoint connections associated with hostpool.

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
- Optional options: PrivateEndpointConnectionsListByHostPoolOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PrivateEndpointConnectionWithSystemData>

listByWorkspace

listByWorkspace(resourceGroupName: string, workspaceName: string, options?: PrivateEndpointConnectionsListByWorkspaceOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnectionWithSystemData>

- Defined in operationsInterfaces/privateEndpointConnections.ts:47
List private endpoint connections.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace
- Optional options: PrivateEndpointConnectionsListByWorkspaceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PrivateEndpointConnectionWithSystemData>

updateByHostPool

updateByHostPool(resourceGroupName: string, hostPoolName: string, privateEndpointConnectionName: string, connection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsUpdateByHostPoolOptionalParams): Promise<PrivateEndpointConnectionsUpdateByHostPoolResponse>

- Defined in operationsInterfaces/privateEndpointConnections.ts:89
Approve or reject a private endpoint connection.

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.
- Optional options: PrivateEndpointConnectionsUpdateByHostPoolOptionalParams
  
  The options parameters.
Returns Promise<PrivateEndpointConnectionsUpdateByHostPoolResponse>

updateByWorkspace

updateByWorkspace(resourceGroupName: string, workspaceName: string, privateEndpointConnectionName: string, connection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsUpdateByWorkspaceOptionalParams): Promise<PrivateEndpointConnectionsUpdateByWorkspaceResponse>

- Defined in operationsInterfaces/privateEndpointConnections.ts:133
Approve or reject a private endpoint connection.

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.
- Optional options: PrivateEndpointConnectionsUpdateByWorkspaceOptionalParams
  
  The options parameters.
Returns Promise<PrivateEndpointConnectionsUpdateByWorkspaceResponse>

Hierarchy

Implemented by

Index

Methods

Methods

deleteByHostPool

Parameters

resourceGroupName: string

hostPoolName: string

privateEndpointConnectionName: string

Optional options: PrivateEndpointConnectionsDeleteByHostPoolOptionalParams

Returns Promise<void>

deleteByWorkspace

Parameters

resourceGroupName: string

workspaceName: string

privateEndpointConnectionName: string

Optional options: PrivateEndpointConnectionsDeleteByWorkspaceOptionalParams

Returns Promise<void>

getByHostPool

Parameters

resourceGroupName: string

hostPoolName: string

privateEndpointConnectionName: string

Optional options: PrivateEndpointConnectionsGetByHostPoolOptionalParams

Returns Promise<PrivateEndpointConnectionsGetByHostPoolResponse>

getByWorkspace

Parameters

resourceGroupName: string

workspaceName: string

privateEndpointConnectionName: string

Optional options: PrivateEndpointConnectionsGetByWorkspaceOptionalParams

Returns Promise<PrivateEndpointConnectionsGetByWorkspaceResponse>

listByHostPool

Parameters

resourceGroupName: string

hostPoolName: string

Optional options: PrivateEndpointConnectionsListByHostPoolOptionalParams

Returns PagedAsyncIterableIterator<PrivateEndpointConnectionWithSystemData>

listByWorkspace

Parameters

resourceGroupName: string

workspaceName: string

Optional options: PrivateEndpointConnectionsListByWorkspaceOptionalParams

Returns PagedAsyncIterableIterator<PrivateEndpointConnectionWithSystemData>

updateByHostPool

Parameters

resourceGroupName: string

hostPoolName: string

privateEndpointConnectionName: string

connection: PrivateEndpointConnection

Optional options: PrivateEndpointConnectionsUpdateByHostPoolOptionalParams

Returns Promise<PrivateEndpointConnectionsUpdateByHostPoolResponse>

updateByWorkspace

Parameters

resourceGroupName: string

workspaceName: string

privateEndpointConnectionName: string

connection: PrivateEndpointConnection

Optional options: PrivateEndpointConnectionsUpdateByWorkspaceOptionalParams

Returns Promise<PrivateEndpointConnectionsUpdateByWorkspaceResponse>