Share via

CommitmentPlans interface

  • Reference
Package:
@azure/arm-commitmentplans

Interface representing a CommitmentPlans.

Methods

createOrUpdate(string, string, CommitmentPlan, CommitmentPlansCreateOrUpdateOptionalParams)

Create a new Azure ML commitment plan resource or updates an existing one.
get(string, string, CommitmentPlansGetOptionalParams)

Retrieve an Azure ML commitment plan by its subscription, resource group and name.
list(CommitmentPlansListOptionalParams)

Retrieve all Azure ML commitment plans in a subscription.
listInResourceGroup(string, CommitmentPlansListInResourceGroupOptionalParams)

Retrieve all Azure ML commitment plans in a resource group.
patch(string, string, CommitmentPlanPatchPayload, CommitmentPlansPatchOptionalParams)

Patch an existing Azure ML commitment plan resource.
remove(string, string, CommitmentPlansRemoveOptionalParams)

Remove an existing Azure ML commitment plan.

Method Details

createOrUpdate(string, string, CommitmentPlan, CommitmentPlansCreateOrUpdateOptionalParams)

Create a new Azure ML commitment plan resource or updates an existing one.

function createOrUpdate(resourceGroupName: string, commitmentPlanName: string, createOrUpdatePayload: CommitmentPlan, options?: CommitmentPlansCreateOrUpdateOptionalParams): Promise<CommitmentPlan>

Parameters

resourceGroupName

string

The resource group name.

commitmentPlanName

string

The Azure ML commitment plan name.

createOrUpdatePayload
CommitmentPlan

The payload to create or update the Azure ML commitment plan.

options
CommitmentPlansCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<CommitmentPlan>

get(string, string, CommitmentPlansGetOptionalParams)

Retrieve an Azure ML commitment plan by its subscription, resource group and name.

function get(resourceGroupName: string, commitmentPlanName: string, options?: CommitmentPlansGetOptionalParams): Promise<CommitmentPlan>

Parameters

resourceGroupName

string

The resource group name.

commitmentPlanName

string

The Azure ML commitment plan name.

options
CommitmentPlansGetOptionalParams

The options parameters.

Returns

Promise<CommitmentPlan>

list(CommitmentPlansListOptionalParams)

Retrieve all Azure ML commitment plans in a subscription.

function list(options?: CommitmentPlansListOptionalParams): PagedAsyncIterableIterator<CommitmentPlan, CommitmentPlan[], PageSettings>

Parameters

options
CommitmentPlansListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CommitmentPlan, CommitmentPlan[], PageSettings>

listInResourceGroup(string, CommitmentPlansListInResourceGroupOptionalParams)

Retrieve all Azure ML commitment plans in a resource group.

function listInResourceGroup(resourceGroupName: string, options?: CommitmentPlansListInResourceGroupOptionalParams): PagedAsyncIterableIterator<CommitmentPlan, CommitmentPlan[], PageSettings>

Parameters

resourceGroupName

string

The resource group name.

options
CommitmentPlansListInResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CommitmentPlan, CommitmentPlan[], PageSettings>

patch(string, string, CommitmentPlanPatchPayload, CommitmentPlansPatchOptionalParams)

Patch an existing Azure ML commitment plan resource.

function patch(resourceGroupName: string, commitmentPlanName: string, patchPayload: CommitmentPlanPatchPayload, options?: CommitmentPlansPatchOptionalParams): Promise<CommitmentPlan>

Parameters

resourceGroupName

string

The resource group name.

commitmentPlanName

string

The Azure ML commitment plan name.

patchPayload
CommitmentPlanPatchPayload

The payload to use to patch the Azure ML commitment plan. Only tags and SKU may be modified on an existing commitment plan.

options
CommitmentPlansPatchOptionalParams

The options parameters.

Returns

Promise<CommitmentPlan>

remove(string, string, CommitmentPlansRemoveOptionalParams)

Remove an existing Azure ML commitment plan.

function remove(resourceGroupName: string, commitmentPlanName: string, options?: CommitmentPlansRemoveOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name.

commitmentPlanName

string

The Azure ML commitment plan name.

options
CommitmentPlansRemoveOptionalParams

The options parameters.

Returns

Promise<void>