ScalingPlans interface
Interface representing a ScalingPlans.
Methods
| create(string, string, Scaling |
Create or update a scaling plan. |
| delete(string, string, Scaling |
Remove a scaling plan. |
| get(string, string, Scaling |
Get a scaling plan. |
| list |
List scaling plan associated with hostpool. |
| list |
List scaling plans. |
| list |
List scaling plans in subscription. |
| update(string, string, Scaling |
Update a scaling plan. |
Method Details
create(string, string, ScalingPlan, ScalingPlansCreateOptionalParams)
Create or update a scaling plan.
function create(resourceGroupName: string, scalingPlanName: string, scalingPlan: ScalingPlan, options?: ScalingPlansCreateOptionalParams): Promise<ScalingPlan>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- scalingPlanName
-
string
The name of the scaling plan.
- scalingPlan
- ScalingPlan
Object containing scaling plan definitions.
- options
- ScalingPlansCreateOptionalParams
The options parameters.
Returns
Promise<ScalingPlan>
delete(string, string, ScalingPlansDeleteOptionalParams)
Remove a scaling plan.
function delete(resourceGroupName: string, scalingPlanName: string, options?: ScalingPlansDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- scalingPlanName
-
string
The name of the scaling plan.
- options
- ScalingPlansDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, ScalingPlansGetOptionalParams)
Get a scaling plan.
function get(resourceGroupName: string, scalingPlanName: string, options?: ScalingPlansGetOptionalParams): Promise<ScalingPlan>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- scalingPlanName
-
string
The name of the scaling plan.
- options
- ScalingPlansGetOptionalParams
The options parameters.
Returns
Promise<ScalingPlan>
listByHostPool(string, string, ScalingPlansListByHostPoolOptionalParams)
List scaling plan associated with hostpool.
function listByHostPool(resourceGroupName: string, hostPoolName: string, options?: ScalingPlansListByHostPoolOptionalParams): PagedAsyncIterableIterator<ScalingPlan, ScalingPlan[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- hostPoolName
-
string
The name of the host pool within the specified resource group
The options parameters.
Returns
listByResourceGroup(string, ScalingPlansListByResourceGroupOptionalParams)
List scaling plans.
function listByResourceGroup(resourceGroupName: string, options?: ScalingPlansListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ScalingPlan, ScalingPlan[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listBySubscription(ScalingPlansListBySubscriptionOptionalParams)
List scaling plans in subscription.
function listBySubscription(options?: ScalingPlansListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ScalingPlan, ScalingPlan[], PageSettings>Parameters
The options parameters.
Returns
update(string, string, ScalingPlansUpdateOptionalParams)
Update a scaling plan.
function update(resourceGroupName: string, scalingPlanName: string, options?: ScalingPlansUpdateOptionalParams): Promise<ScalingPlan>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- scalingPlanName
-
string
The name of the scaling plan.
- options
- ScalingPlansUpdateOptionalParams
The options parameters.
Returns
Promise<ScalingPlan>