Package version:

Interface Pools

Interface representing a Pools.

Hierarchy

Pools

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait get listByProject

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, projectName: string, poolName: string, body: Pool, options?: PoolsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Pool>, Pool>>
Creates or updates a machine pool
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- projectName: string
  
  The name of the project.
- poolName: string
  
  Name of the pool.
- body: Pool
  
  Represents a machine pool
- Optional options: PoolsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<Pool>, Pool>>
- Defined in operationsInterfaces/pools.ts:59

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, projectName: string, poolName: string, body: Pool, options?: PoolsCreateOrUpdateOptionalParams): Promise<Pool>
Creates or updates a machine pool
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- projectName: string
  
  The name of the project.
- poolName: string
  
  Name of the pool.
- body: Pool
  
  Represents a machine pool
- Optional options: PoolsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<Pool>
- Defined in operationsInterfaces/pools.ts:79

beginDelete

beginDelete(resourceGroupName: string, projectName: string, poolName: string, options?: PoolsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Deletes a machine pool
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- projectName: string
  
  The name of the project.
- poolName: string
  
  Name of the pool.
- Optional options: PoolsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/pools.ts:125

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, projectName: string, poolName: string, options?: PoolsDeleteOptionalParams): Promise<void>
Deletes a machine pool
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- projectName: string
  
  The name of the project.
- poolName: string
  
  Name of the pool.
- Optional options: PoolsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/pools.ts:138

beginUpdate

beginUpdate(resourceGroupName: string, projectName: string, poolName: string, body: PoolUpdate, options?: PoolsUpdateOptionalParams): Promise<PollerLike<PollOperationState<Pool>, Pool>>
Partially updates a machine pool
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- projectName: string
  
  The name of the project.
- poolName: string
  
  Name of the pool.
- body: PoolUpdate
  
  Represents a machine pool
- Optional options: PoolsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<Pool>, Pool>>
- Defined in operationsInterfaces/pools.ts:94

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, projectName: string, poolName: string, body: PoolUpdate, options?: PoolsUpdateOptionalParams): Promise<Pool>
Partially updates a machine pool
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- projectName: string
  
  The name of the project.
- poolName: string
  
  Name of the pool.
- body: PoolUpdate
  
  Represents a machine pool
- Optional options: PoolsUpdateOptionalParams
  
  The options parameters.
Returns Promise<Pool>
- Defined in operationsInterfaces/pools.ts:111

get

get(resourceGroupName: string, projectName: string, poolName: string, options?: PoolsGetOptionalParams): Promise<Pool>
Gets a machine pool
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- projectName: string
  
  The name of the project.
- poolName: string
  
  Name of the pool.
- Optional options: PoolsGetOptionalParams
  
  The options parameters.
Returns Promise<Pool>
- Defined in operationsInterfaces/pools.ts:45

listByProject

listByProject(resourceGroupName: string, projectName: string, options?: PoolsListByProjectOptionalParams): PagedAsyncIterableIterator<Pool>
Lists pools for a project
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- projectName: string
  
  The name of the project.
- Optional options: PoolsListByProjectOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Pool>
- Defined in operationsInterfaces/pools.ts:33

Interface Pools

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

projectName: string

poolName: string

body: Pool

Optional options: PoolsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<Pool>, Pool>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

projectName: string

poolName: string

body: Pool

Optional options: PoolsCreateOrUpdateOptionalParams

Returns Promise<Pool>

beginDelete

Parameters

resourceGroupName: string

projectName: string

poolName: string

Optional options: PoolsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

projectName: string

poolName: string

Optional options: PoolsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

projectName: string

poolName: string

body: PoolUpdate

Optional options: PoolsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<Pool>, Pool>>

beginUpdateAndWait

Parameters

resourceGroupName: string

projectName: string

poolName: string

body: PoolUpdate

Optional options: PoolsUpdateOptionalParams

Returns Promise<Pool>

get

Parameters

resourceGroupName: string

projectName: string

poolName: string

Optional options: PoolsGetOptionalParams

Returns Promise<Pool>

listByProject

Parameters

resourceGroupName: string

projectName: string

Optional options: PoolsListByProjectOptionalParams

Returns PagedAsyncIterableIterator<Pool>

Settings

Member Visibility

Theme

`Optional` options: PoolsCreateOrUpdateOptionalParams

`Optional` options: PoolsCreateOrUpdateOptionalParams

`Optional` options: PoolsDeleteOptionalParams

`Optional` options: PoolsDeleteOptionalParams

`Optional` options: PoolsUpdateOptionalParams

`Optional` options: PoolsUpdateOptionalParams

`Optional` options: PoolsGetOptionalParams

`Optional` options: PoolsListByProjectOptionalParams