InstancePools interface
Interface representing a InstancePools.
Methods
| begin |
Creates or updates an instance pool. |
| begin |
Creates or updates an instance pool. |
| begin |
Deletes an instance pool |
| begin |
Deletes an instance pool |
| begin |
Updates an instance pool. |
| begin |
Updates an instance pool. |
| get(string, string, Instance |
Gets an instance pool. |
| list(Instance |
Gets a list of all instance pools in the subscription. |
| list |
Gets a list of instance pools in the resource group |
Method Details
beginCreateOrUpdate(string, string, InstancePool, InstancePoolsCreateOrUpdateOptionalParams)
Creates or updates an instance pool.
function beginCreateOrUpdate(resourceGroupName: string, instancePoolName: string, parameters: InstancePool, options?: InstancePoolsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<InstancePool>, InstancePool>>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.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<InstancePool>, InstancePool>>
beginCreateOrUpdateAndWait(string, string, InstancePool, InstancePoolsCreateOrUpdateOptionalParams)
Creates or updates an instance pool.
function beginCreateOrUpdateAndWait(resourceGroupName: string, instancePoolName: string, parameters: InstancePool, options?: InstancePoolsCreateOrUpdateOptionalParams): Promise<InstancePool>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.
The options parameters.
Returns
Promise<InstancePool>
beginDelete(string, string, InstancePoolsDeleteOptionalParams)
Deletes an instance pool
function beginDelete(resourceGroupName: string, instancePoolName: string, options?: InstancePoolsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, InstancePoolsDeleteOptionalParams)
Deletes an instance pool
function beginDeleteAndWait(resourceGroupName: string, instancePoolName: string, options?: InstancePoolsDeleteOptionalParams): Promise<void>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
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, InstancePoolUpdate, InstancePoolsUpdateOptionalParams)
Updates an instance pool.
function beginUpdate(resourceGroupName: string, instancePoolName: string, parameters: InstancePoolUpdate, options?: InstancePoolsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<InstancePool>, InstancePool>>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.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<InstancePool>, InstancePool>>
beginUpdateAndWait(string, string, InstancePoolUpdate, InstancePoolsUpdateOptionalParams)
Updates an instance pool.
function beginUpdateAndWait(resourceGroupName: string, instancePoolName: string, parameters: InstancePoolUpdate, options?: InstancePoolsUpdateOptionalParams): Promise<InstancePool>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.
The options parameters.
Returns
Promise<InstancePool>
get(string, string, InstancePoolsGetOptionalParams)
Gets an instance pool.
function get(resourceGroupName: string, instancePoolName: string, options?: InstancePoolsGetOptionalParams): Promise<InstancePool>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.
- options
- InstancePoolsGetOptionalParams
The options parameters.
Returns
Promise<InstancePool>
list(InstancePoolsListOptionalParams)
Gets a list of all instance pools in the subscription.
function list(options?: InstancePoolsListOptionalParams): PagedAsyncIterableIterator<InstancePool, InstancePool[], PageSettings>Parameters
- options
- InstancePoolsListOptionalParams
The options parameters.
Returns
listByResourceGroup(string, InstancePoolsListByResourceGroupOptionalParams)
Gets a list of instance pools in the resource group
function listByResourceGroup(resourceGroupName: string, options?: InstancePoolsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<InstancePool, InstancePool[], PageSettings>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.
The options parameters.