Pools interface

Interface representing a Pools.

Methods

beginCreateOrUpdate(string, string, string, Pool, PoolsCreateOrUpdateOptionalParams)

Creates or updates a machine pool

beginCreateOrUpdateAndWait(string, string, string, Pool, PoolsCreateOrUpdateOptionalParams)

Creates or updates a machine pool

beginDelete(string, string, string, PoolsDeleteOptionalParams)

Deletes a machine pool

beginDeleteAndWait(string, string, string, PoolsDeleteOptionalParams)

Deletes a machine pool

beginRunHealthChecks(string, string, string, PoolsRunHealthChecksOptionalParams)

Triggers a refresh of the pool status.

beginRunHealthChecksAndWait(string, string, string, PoolsRunHealthChecksOptionalParams)

Triggers a refresh of the pool status.

beginUpdate(string, string, string, PoolUpdate, PoolsUpdateOptionalParams)

Partially updates a machine pool

beginUpdateAndWait(string, string, string, PoolUpdate, PoolsUpdateOptionalParams)

Partially updates a machine pool

get(string, string, string, PoolsGetOptionalParams)

Gets a machine pool

listByProject(string, string, PoolsListByProjectOptionalParams)

Lists pools for a project

Method Details

beginCreateOrUpdate(string, string, string, Pool, PoolsCreateOrUpdateOptionalParams)

Creates or updates a machine pool

function beginCreateOrUpdate(resourceGroupName: string, projectName: string, poolName: string, body: Pool, options?: PoolsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Pool>, 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

options
PoolsCreateOrUpdateOptionalParams

The options parameters.

Returns

beginCreateOrUpdateAndWait(string, string, string, Pool, PoolsCreateOrUpdateOptionalParams)

Creates or updates a machine pool

function beginCreateOrUpdateAndWait(resourceGroupName: string, projectName: string, poolName: string, body: Pool, options?: PoolsCreateOrUpdateOptionalParams): Promise<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

options
PoolsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Pool>

beginDelete(string, string, string, PoolsDeleteOptionalParams)

Deletes a machine pool

function beginDelete(resourceGroupName: string, projectName: string, poolName: string, options?: PoolsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<PoolsDeleteHeaders>, PoolsDeleteHeaders>>

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.

options
PoolsDeleteOptionalParams

The options parameters.

Returns

beginDeleteAndWait(string, string, string, PoolsDeleteOptionalParams)

Deletes a machine pool

function beginDeleteAndWait(resourceGroupName: string, projectName: string, poolName: string, options?: PoolsDeleteOptionalParams): Promise<PoolsDeleteHeaders>

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.

options
PoolsDeleteOptionalParams

The options parameters.

Returns

beginRunHealthChecks(string, string, string, PoolsRunHealthChecksOptionalParams)

Triggers a refresh of the pool status.

function beginRunHealthChecks(resourceGroupName: string, projectName: string, poolName: string, options?: PoolsRunHealthChecksOptionalParams): Promise<SimplePollerLike<OperationState<PoolsRunHealthChecksHeaders>, PoolsRunHealthChecksHeaders>>

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.

options
PoolsRunHealthChecksOptionalParams

The options parameters.

Returns

beginRunHealthChecksAndWait(string, string, string, PoolsRunHealthChecksOptionalParams)

Triggers a refresh of the pool status.

function beginRunHealthChecksAndWait(resourceGroupName: string, projectName: string, poolName: string, options?: PoolsRunHealthChecksOptionalParams): Promise<PoolsRunHealthChecksHeaders>

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.

options
PoolsRunHealthChecksOptionalParams

The options parameters.

Returns

beginUpdate(string, string, string, PoolUpdate, PoolsUpdateOptionalParams)

Partially updates a machine pool

function beginUpdate(resourceGroupName: string, projectName: string, poolName: string, body: PoolUpdate, options?: PoolsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Pool>, 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

options
PoolsUpdateOptionalParams

The options parameters.

Returns

beginUpdateAndWait(string, string, string, PoolUpdate, PoolsUpdateOptionalParams)

Partially updates a machine pool

function beginUpdateAndWait(resourceGroupName: string, projectName: string, poolName: string, body: PoolUpdate, options?: PoolsUpdateOptionalParams): Promise<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

options
PoolsUpdateOptionalParams

The options parameters.

Returns

Promise<Pool>

get(string, string, string, PoolsGetOptionalParams)

Gets a machine pool

function get(resourceGroupName: string, projectName: string, poolName: string, options?: PoolsGetOptionalParams): Promise<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.

options
PoolsGetOptionalParams

The options parameters.

Returns

Promise<Pool>

listByProject(string, string, PoolsListByProjectOptionalParams)

Lists pools for a project

function listByProject(resourceGroupName: string, projectName: string, options?: PoolsListByProjectOptionalParams): PagedAsyncIterableIterator<Pool, Pool[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

The name of the project.

options
PoolsListByProjectOptionalParams

The options parameters.

Returns