HostPoolsImpl | @azure/arm-desktopvirtualization

Class containing HostPools operations.

Hierarchy

HostPoolsImpl

Implements

HostPools

Index

Constructors

constructor

Methods

Constructors

constructor

new HostPoolsImpl(client: DesktopVirtualizationAPIClient): HostPoolsImpl

- Defined in operations/hostPools.ts:39
Initialize a new instance of the class HostPools class.

Parameters
- client: DesktopVirtualizationAPIClient
  
  Reference to the service client
Returns HostPoolsImpl

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, hostPoolName: string, hostPool: HostPool, options?: HostPoolsCreateOrUpdateOptionalParams): Promise<HostPoolsCreateOrUpdateResponse>

Implementation of HostPools.createOrUpdate
- Defined in operations/hostPools.ts:168
Create or update a host pool.

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
- hostPool: HostPool
  
  Object containing HostPool definitions.
- Optional options: HostPoolsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<HostPoolsCreateOrUpdateResponse>

delete

delete(resourceGroupName: string, hostPoolName: string, options?: HostPoolsDeleteOptionalParams): Promise<void>

Implementation of HostPools.delete
- Defined in operations/hostPools.ts:186
Remove a host pool.

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

get

get(resourceGroupName: string, hostPoolName: string, options?: HostPoolsGetOptionalParams): Promise<HostPoolsGetResponse>

Implementation of HostPools.get
- Defined in operations/hostPools.ts:150
Get a host pool.

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: HostPoolsGetOptionalParams
  
  The options parameters.
Returns Promise<HostPoolsGetResponse>

list

list(options?: HostPoolsListOptionalParams): PagedAsyncIterableIterator<HostPool>

Implementation of HostPools.list
- Defined in operations/hostPools.ts:106
List hostPools in subscription.

Parameters
- Optional options: HostPoolsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<HostPool>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: HostPoolsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<HostPool>

Implementation of HostPools.listByResourceGroup
- Defined in operations/hostPools.ts:54
List hostPools.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- Optional options: HostPoolsListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<HostPool>

retrieveRegistrationToken

retrieveRegistrationToken(resourceGroupName: string, hostPoolName: string, options?: HostPoolsRetrieveRegistrationTokenOptionalParams): Promise<HostPoolsRetrieveRegistrationTokenResponse>

Implementation of HostPools.retrieveRegistrationToken
- Defined in operations/hostPools.ts:245
Registration token of the host pool.

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: HostPoolsRetrieveRegistrationTokenOptionalParams
  
  The options parameters.
Returns Promise<HostPoolsRetrieveRegistrationTokenResponse>

update

update(resourceGroupName: string, hostPoolName: string, options?: HostPoolsUpdateOptionalParams): Promise<HostPoolsUpdateResponse>

Implementation of HostPools.update
- Defined in operations/hostPools.ts:203
Update a host pool.

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: HostPoolsUpdateOptionalParams
  
  The options parameters.
Returns Promise<HostPoolsUpdateResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: DesktopVirtualizationAPIClient

Returns HostPoolsImpl

Methods

createOrUpdate

Parameters

resourceGroupName: string

hostPoolName: string

hostPool: HostPool

Optional options: HostPoolsCreateOrUpdateOptionalParams

Returns Promise<HostPoolsCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

hostPoolName: string

Optional options: HostPoolsDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

hostPoolName: string

Optional options: HostPoolsGetOptionalParams

Returns Promise<HostPoolsGetResponse>

list

Parameters

Optional options: HostPoolsListOptionalParams

Returns PagedAsyncIterableIterator<HostPool>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: HostPoolsListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<HostPool>

retrieveRegistrationToken

Parameters

resourceGroupName: string

hostPoolName: string

Optional options: HostPoolsRetrieveRegistrationTokenOptionalParams

Returns Promise<HostPoolsRetrieveRegistrationTokenResponse>

update

Parameters

resourceGroupName: string

hostPoolName: string

Optional options: HostPoolsUpdateOptionalParams

Returns Promise<HostPoolsUpdateResponse>