Package version:

Interface InstancePools

Interface representing a InstancePools.

Hierarchy

InstancePools

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait get list listByResourceGroup

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, instancePoolName: string, parameters: InstancePool, options?: InstancePoolsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<InstancePool>, InstancePool>>
Creates or updates an instance pool.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- instancePoolName: string
  
  The name of the instance pool to be created or updated.
- parameters: InstancePool
  
  The requested instance pool resource state.
- Optional options: InstancePoolsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<InstancePool>, InstancePool>>
- Defined in operationsInterfaces/instancePools.ts:65

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, instancePoolName: string, parameters: InstancePool, options?: InstancePoolsCreateOrUpdateOptionalParams): Promise<InstancePool>
Creates or updates an instance pool.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- instancePoolName: string
  
  The name of the instance pool to be created or updated.
- parameters: InstancePool
  
  The requested instance pool resource state.
- Optional options: InstancePoolsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<InstancePool>
- Defined in operationsInterfaces/instancePools.ts:84

beginDelete

beginDelete(resourceGroupName: string, instancePoolName: string, options?: InstancePoolsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes an instance pool
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- instancePoolName: string
  
  The name of the instance pool to be deleted
- Optional options: InstancePoolsDeleteOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/instancePools.ts:97

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, instancePoolName: string, options?: InstancePoolsDeleteOptionalParams): Promise<void>
Deletes an instance pool
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- instancePoolName: string
  
  The name of the instance pool to be deleted
- Optional options: InstancePoolsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/instancePools.ts:109

beginUpdate

beginUpdate(resourceGroupName: string, instancePoolName: string, parameters: InstancePoolUpdate, options?: InstancePoolsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<InstancePool>, InstancePool>>
Updates an instance pool.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- instancePoolName: string
  
  The name of the instance pool to be updated.
- parameters: InstancePoolUpdate
  
  The requested instance pool resource state.
- Optional options: InstancePoolsUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<InstancePool>, InstancePool>>
- Defined in operationsInterfaces/instancePools.ts:122

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, instancePoolName: string, parameters: InstancePoolUpdate, options?: InstancePoolsUpdateOptionalParams): Promise<InstancePool>
Updates an instance pool.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- instancePoolName: string
  
  The name of the instance pool to be updated.
- parameters: InstancePoolUpdate
  
  The requested instance pool resource state.
- Optional options: InstancePoolsUpdateOptionalParams
  
  The options parameters.
Returns Promise<InstancePool>
- Defined in operationsInterfaces/instancePools.ts:141

get

get(resourceGroupName: string, instancePoolName: string, options?: InstancePoolsGetOptionalParams): Promise<InstancePool>
Gets an instance pool.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- instancePoolName: string
  
  The name of the instance pool to be retrieved.
- Optional options: InstancePoolsGetOptionalParams
  
  The options parameters.
Returns Promise<InstancePool>
- Defined in operationsInterfaces/instancePools.ts:52

list

list(options?: InstancePoolsListOptionalParams): PagedAsyncIterableIterator<InstancePool>
Gets a list of all instance pools in the subscription.
Parameters
- Optional options: InstancePoolsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<InstancePool>
- Defined in operationsInterfaces/instancePools.ts:42

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: InstancePoolsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<InstancePool>
Gets a list of instance pools in the resource group
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- Optional options: InstancePoolsListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<InstancePool>
- Defined in operationsInterfaces/instancePools.ts:34

Interface InstancePools

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

instancePoolName: string

parameters: InstancePool

Optional options: InstancePoolsCreateOrUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<InstancePool>, InstancePool>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

instancePoolName: string

parameters: InstancePool

Optional options: InstancePoolsCreateOrUpdateOptionalParams

Returns Promise<InstancePool>

beginDelete

Parameters

resourceGroupName: string

instancePoolName: string

Optional options: InstancePoolsDeleteOptionalParams

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

instancePoolName: string

Optional options: InstancePoolsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

instancePoolName: string

parameters: InstancePoolUpdate

Optional options: InstancePoolsUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<InstancePool>, InstancePool>>

beginUpdateAndWait

Parameters

resourceGroupName: string

instancePoolName: string

parameters: InstancePoolUpdate

Optional options: InstancePoolsUpdateOptionalParams

Returns Promise<InstancePool>

get

Parameters

resourceGroupName: string

instancePoolName: string

Optional options: InstancePoolsGetOptionalParams

Returns Promise<InstancePool>

list

Parameters

Optional options: InstancePoolsListOptionalParams

Returns PagedAsyncIterableIterator<InstancePool>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: InstancePoolsListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<InstancePool>

Settings

Member Visibility

Theme

`Optional` options: InstancePoolsCreateOrUpdateOptionalParams

`Optional` options: InstancePoolsCreateOrUpdateOptionalParams

`Optional` options: InstancePoolsDeleteOptionalParams

`Optional` options: InstancePoolsDeleteOptionalParams

`Optional` options: InstancePoolsUpdateOptionalParams

`Optional` options: InstancePoolsUpdateOptionalParams

`Optional` options: InstancePoolsGetOptionalParams

`Optional` options: InstancePoolsListOptionalParams

`Optional` options: InstancePoolsListByResourceGroupOptionalParams