Share via

Pools interface

  • Reference
Package:
@azure/arm-devopsinfrastructure

Interface representing a Pools.

Methods

beginCreateOrUpdate(string, string, Pool, PoolsCreateOrUpdateOptionalParams)

Create a Pool
beginCreateOrUpdateAndWait(string, string, Pool, PoolsCreateOrUpdateOptionalParams)

Create a Pool
beginDelete(string, string, PoolsDeleteOptionalParams)

Delete a Pool
beginDeleteAndWait(string, string, PoolsDeleteOptionalParams)

Delete a Pool
beginUpdate(string, string, PoolUpdate, PoolsUpdateOptionalParams)

Update a Pool
beginUpdateAndWait(string, string, PoolUpdate, PoolsUpdateOptionalParams)

Update a Pool
get(string, string, PoolsGetOptionalParams)

Get a Pool
listByResourceGroup(string, PoolsListByResourceGroupOptionalParams)

List Pool resources by resource group
listBySubscription(PoolsListBySubscriptionOptionalParams)

List Pool resources by subscription ID

Method Details

beginCreateOrUpdate(string, string, Pool, PoolsCreateOrUpdateOptionalParams)

Create a Pool

function beginCreateOrUpdate(resourceGroupName: string, poolName: string, resource: Pool, options?: PoolsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Pool>, Pool>>

Parameters

resourceGroupName

string

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

poolName

string

Name of the pool. It needs to be globally unique.

resource
Pool

Resource create parameters.

options
PoolsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Pool>, Pool>>

beginCreateOrUpdateAndWait(string, string, Pool, PoolsCreateOrUpdateOptionalParams)

Create a Pool

function beginCreateOrUpdateAndWait(resourceGroupName: string, poolName: string, resource: Pool, options?: PoolsCreateOrUpdateOptionalParams): Promise<Pool>

Parameters

resourceGroupName

string

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

poolName

string

Name of the pool. It needs to be globally unique.

resource
Pool

Resource create parameters.

options
PoolsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Pool>

beginDelete(string, string, PoolsDeleteOptionalParams)

Delete a Pool

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

Parameters

resourceGroupName

string

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

poolName

string

Name of the pool. It needs to be globally unique.

options
PoolsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<PoolsDeleteHeaders>, PoolsDeleteHeaders>>

beginDeleteAndWait(string, string, PoolsDeleteOptionalParams)

Delete a Pool

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

Parameters

resourceGroupName

string

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

poolName

string

Name of the pool. It needs to be globally unique.

options
PoolsDeleteOptionalParams

The options parameters.

Returns

Promise<PoolsDeleteHeaders>

beginUpdate(string, string, PoolUpdate, PoolsUpdateOptionalParams)

Update a Pool

function beginUpdate(resourceGroupName: string, poolName: string, properties: PoolUpdate, options?: PoolsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Pool>, Pool>>

Parameters

resourceGroupName

string

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

poolName

string

Name of the pool. It needs to be globally unique.

properties
PoolUpdate

The resource properties to be updated.

options
PoolsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Pool>, Pool>>

beginUpdateAndWait(string, string, PoolUpdate, PoolsUpdateOptionalParams)

Update a Pool

function beginUpdateAndWait(resourceGroupName: string, poolName: string, properties: PoolUpdate, options?: PoolsUpdateOptionalParams): Promise<Pool>

Parameters

resourceGroupName

string

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

poolName

string

Name of the pool. It needs to be globally unique.

properties
PoolUpdate

The resource properties to be updated.

options
PoolsUpdateOptionalParams

The options parameters.

Returns

Promise<Pool>

get(string, string, PoolsGetOptionalParams)

Get a Pool

function get(resourceGroupName: string, poolName: string, options?: PoolsGetOptionalParams): Promise<Pool>

Parameters

resourceGroupName

string

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

poolName

string

Name of the pool. It needs to be globally unique.

options
PoolsGetOptionalParams

The options parameters.

Returns

Promise<Pool>

listByResourceGroup(string, PoolsListByResourceGroupOptionalParams)

List Pool resources by resource group

function listByResourceGroup(resourceGroupName: string, options?: PoolsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Pool, Pool[], PageSettings>

Parameters

resourceGroupName

string

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

options
PoolsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Pool, Pool[], PageSettings>

listBySubscription(PoolsListBySubscriptionOptionalParams)

List Pool resources by subscription ID

function listBySubscription(options?: PoolsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Pool, Pool[], PageSettings>

Parameters

options
PoolsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Pool, Pool[], PageSettings>