CommitmentPlans interface

Package:

@azure/arm-cognitiveservices

Interface representing a CommitmentPlans.

Methods

beginCreateOrUpdateAssociation(string, string, string, CommitmentPlanAccountAssociation, CommitmentPlansCreateOrUpdateAssociationOptionalParams)	Create or update the association of the Cognitive Services commitment plan.
beginCreateOrUpdateAssociationAndWait(string, string, string, CommitmentPlanAccountAssociation, CommitmentPlansCreateOrUpdateAssociationOptionalParams)	Create or update the association of the Cognitive Services commitment plan.
beginCreateOrUpdatePlan(string, string, CommitmentPlan, CommitmentPlansCreateOrUpdatePlanOptionalParams)	Create Cognitive Services commitment plan.
beginCreateOrUpdatePlanAndWait(string, string, CommitmentPlan, CommitmentPlansCreateOrUpdatePlanOptionalParams)	Create Cognitive Services commitment plan.
beginDelete(string, string, string, CommitmentPlansDeleteOptionalParams)	Deletes the specified commitmentPlan associated with the Cognitive Services account.
beginDeleteAndWait(string, string, string, CommitmentPlansDeleteOptionalParams)	Deletes the specified commitmentPlan associated with the Cognitive Services account.
beginDeleteAssociation(string, string, string, CommitmentPlansDeleteAssociationOptionalParams)	Deletes the association of the Cognitive Services commitment plan.
beginDeleteAssociationAndWait(string, string, string, CommitmentPlansDeleteAssociationOptionalParams)	Deletes the association of the Cognitive Services commitment plan.
beginDeletePlan(string, string, CommitmentPlansDeletePlanOptionalParams)	Deletes a Cognitive Services commitment plan from the resource group.
beginDeletePlanAndWait(string, string, CommitmentPlansDeletePlanOptionalParams)	Deletes a Cognitive Services commitment plan from the resource group.
beginUpdatePlan(string, string, PatchResourceTagsAndSku, CommitmentPlansUpdatePlanOptionalParams)	Create Cognitive Services commitment plan.
beginUpdatePlanAndWait(string, string, PatchResourceTagsAndSku, CommitmentPlansUpdatePlanOptionalParams)	Create Cognitive Services commitment plan.
createOrUpdate(string, string, string, CommitmentPlan, CommitmentPlansCreateOrUpdateOptionalParams)	Update the state of specified commitmentPlans associated with the Cognitive Services account.
get(string, string, string, CommitmentPlansGetOptionalParams)	Gets the specified commitmentPlans associated with the Cognitive Services account.
getAssociation(string, string, string, CommitmentPlansGetAssociationOptionalParams)	Gets the association of the Cognitive Services commitment plan.
getPlan(string, string, CommitmentPlansGetPlanOptionalParams)	Returns a Cognitive Services commitment plan specified by the parameters.
list(string, string, CommitmentPlansListOptionalParams)	Gets the commitmentPlans associated with the Cognitive Services account.
listAssociations(string, string, CommitmentPlansListAssociationsOptionalParams)	Gets the associations of the Cognitive Services commitment plan.
listPlansByResourceGroup(string, CommitmentPlansListPlansByResourceGroupOptionalParams)	Returns all the resources of a particular type belonging to a resource group
listPlansBySubscription(CommitmentPlansListPlansBySubscriptionOptionalParams)	Returns all the resources of a particular type belonging to a subscription.

Method Details

beginCreateOrUpdateAssociation(string, string, string, CommitmentPlanAccountAssociation, CommitmentPlansCreateOrUpdateAssociationOptionalParams)

Create or update the association of the Cognitive Services commitment plan.

function beginCreateOrUpdateAssociation(resourceGroupName: string, commitmentPlanName: string, commitmentPlanAssociationName: string, association: CommitmentPlanAccountAssociation, options?: CommitmentPlansCreateOrUpdateAssociationOptionalParams): Promise<SimplePollerLike<OperationState<CommitmentPlanAccountAssociation>, CommitmentPlanAccountAssociation>>

Parameters

resourceGroupName

string

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

commitmentPlanName

string

The name of the commitmentPlan associated with the Cognitive Services Account

commitmentPlanAssociationName

string

The name of the commitment plan association with the Cognitive Services Account

association

CommitmentPlanAccountAssociation

The commitmentPlan properties.

options

CommitmentPlansCreateOrUpdateAssociationOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAssociationAndWait(string, string, string, CommitmentPlanAccountAssociation, CommitmentPlansCreateOrUpdateAssociationOptionalParams)

Create or update the association of the Cognitive Services commitment plan.

function beginCreateOrUpdateAssociationAndWait(resourceGroupName: string, commitmentPlanName: string, commitmentPlanAssociationName: string, association: CommitmentPlanAccountAssociation, options?: CommitmentPlansCreateOrUpdateAssociationOptionalParams): Promise<CommitmentPlanAccountAssociation>

Parameters

resourceGroupName

string

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

commitmentPlanName

string

The name of the commitmentPlan associated with the Cognitive Services Account

commitmentPlanAssociationName

string

The name of the commitment plan association with the Cognitive Services Account

association

CommitmentPlanAccountAssociation

The commitmentPlan properties.

options

CommitmentPlansCreateOrUpdateAssociationOptionalParams

The options parameters.

Returns

Promise<CommitmentPlanAccountAssociation>

beginCreateOrUpdatePlan(string, string, CommitmentPlan, CommitmentPlansCreateOrUpdatePlanOptionalParams)

Create Cognitive Services commitment plan.

function beginCreateOrUpdatePlan(resourceGroupName: string, commitmentPlanName: string, commitmentPlan: CommitmentPlan, options?: CommitmentPlansCreateOrUpdatePlanOptionalParams): Promise<SimplePollerLike<OperationState<CommitmentPlan>, CommitmentPlan>>

Parameters

resourceGroupName

string

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

commitmentPlanName

string

The name of the commitmentPlan associated with the Cognitive Services Account

commitmentPlan

CommitmentPlan

The parameters to provide for the created commitment plan.

options

CommitmentPlansCreateOrUpdatePlanOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdatePlanAndWait(string, string, CommitmentPlan, CommitmentPlansCreateOrUpdatePlanOptionalParams)

Create Cognitive Services commitment plan.

function beginCreateOrUpdatePlanAndWait(resourceGroupName: string, commitmentPlanName: string, commitmentPlan: CommitmentPlan, options?: CommitmentPlansCreateOrUpdatePlanOptionalParams): Promise<CommitmentPlan>

Parameters

resourceGroupName

string

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

commitmentPlanName

string

The name of the commitmentPlan associated with the Cognitive Services Account

commitmentPlan

CommitmentPlan

The parameters to provide for the created commitment plan.

options

CommitmentPlansCreateOrUpdatePlanOptionalParams

The options parameters.

Returns

Promise<CommitmentPlan>

beginDelete(string, string, string, CommitmentPlansDeleteOptionalParams)

Deletes the specified commitmentPlan associated with the Cognitive Services account.

function beginDelete(resourceGroupName: string, accountName: string, commitmentPlanName: string, options?: CommitmentPlansDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

commitmentPlanName

string

The name of the commitmentPlan associated with the Cognitive Services Account

options

CommitmentPlansDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, CommitmentPlansDeleteOptionalParams)

Deletes the specified commitmentPlan associated with the Cognitive Services account.

function beginDeleteAndWait(resourceGroupName: string, accountName: string, commitmentPlanName: string, options?: CommitmentPlansDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

commitmentPlanName

string

The name of the commitmentPlan associated with the Cognitive Services Account

options

CommitmentPlansDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginDeleteAssociation(string, string, string, CommitmentPlansDeleteAssociationOptionalParams)

Deletes the association of the Cognitive Services commitment plan.

function beginDeleteAssociation(resourceGroupName: string, commitmentPlanName: string, commitmentPlanAssociationName: string, options?: CommitmentPlansDeleteAssociationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

commitmentPlanName

string

The name of the commitmentPlan associated with the Cognitive Services Account

commitmentPlanAssociationName

string

The name of the commitment plan association with the Cognitive Services Account

options

CommitmentPlansDeleteAssociationOptionalParams

The options parameters.

Returns

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

beginDeleteAssociationAndWait(string, string, string, CommitmentPlansDeleteAssociationOptionalParams)

Deletes the association of the Cognitive Services commitment plan.

function beginDeleteAssociationAndWait(resourceGroupName: string, commitmentPlanName: string, commitmentPlanAssociationName: string, options?: CommitmentPlansDeleteAssociationOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

commitmentPlanName

string

The name of the commitmentPlan associated with the Cognitive Services Account

commitmentPlanAssociationName

string

The name of the commitment plan association with the Cognitive Services Account

options

CommitmentPlansDeleteAssociationOptionalParams

The options parameters.

Returns

Promise<void>

beginDeletePlan(string, string, CommitmentPlansDeletePlanOptionalParams)

Deletes a Cognitive Services commitment plan from the resource group.

function beginDeletePlan(resourceGroupName: string, commitmentPlanName: string, options?: CommitmentPlansDeletePlanOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

commitmentPlanName

string

The name of the commitmentPlan associated with the Cognitive Services Account

options

CommitmentPlansDeletePlanOptionalParams

The options parameters.

Returns

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

beginDeletePlanAndWait(string, string, CommitmentPlansDeletePlanOptionalParams)

Deletes a Cognitive Services commitment plan from the resource group.

function beginDeletePlanAndWait(resourceGroupName: string, commitmentPlanName: string, options?: CommitmentPlansDeletePlanOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

commitmentPlanName

string

The name of the commitmentPlan associated with the Cognitive Services Account

options

CommitmentPlansDeletePlanOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdatePlan(string, string, PatchResourceTagsAndSku, CommitmentPlansUpdatePlanOptionalParams)

Create Cognitive Services commitment plan.

function beginUpdatePlan(resourceGroupName: string, commitmentPlanName: string, commitmentPlan: PatchResourceTagsAndSku, options?: CommitmentPlansUpdatePlanOptionalParams): Promise<SimplePollerLike<OperationState<CommitmentPlan>, CommitmentPlan>>

Parameters

resourceGroupName

string

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

commitmentPlanName

string

The name of the commitmentPlan associated with the Cognitive Services Account

commitmentPlan

PatchResourceTagsAndSku

The parameters to provide for the created commitment plan.

options

CommitmentPlansUpdatePlanOptionalParams

The options parameters.

Returns

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

beginUpdatePlanAndWait(string, string, PatchResourceTagsAndSku, CommitmentPlansUpdatePlanOptionalParams)

Create Cognitive Services commitment plan.

function beginUpdatePlanAndWait(resourceGroupName: string, commitmentPlanName: string, commitmentPlan: PatchResourceTagsAndSku, options?: CommitmentPlansUpdatePlanOptionalParams): Promise<CommitmentPlan>

Parameters

resourceGroupName

string

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

commitmentPlanName

string

The name of the commitmentPlan associated with the Cognitive Services Account

commitmentPlan

PatchResourceTagsAndSku

The parameters to provide for the created commitment plan.

options

CommitmentPlansUpdatePlanOptionalParams

The options parameters.

Returns

Promise<CommitmentPlan>

createOrUpdate(string, string, string, CommitmentPlan, CommitmentPlansCreateOrUpdateOptionalParams)

Update the state of specified commitmentPlans associated with the Cognitive Services account.

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

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

commitmentPlanName

string

The name of the commitmentPlan associated with the Cognitive Services Account

commitmentPlan

CommitmentPlan

The commitmentPlan properties.

options

CommitmentPlansCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<CommitmentPlan>

get(string, string, string, CommitmentPlansGetOptionalParams)

Gets the specified commitmentPlans associated with the Cognitive Services account.

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

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

commitmentPlanName

string

The name of the commitmentPlan associated with the Cognitive Services Account

options

CommitmentPlansGetOptionalParams

The options parameters.

Returns

Promise<CommitmentPlan>

getAssociation(string, string, string, CommitmentPlansGetAssociationOptionalParams)

Gets the association of the Cognitive Services commitment plan.

function getAssociation(resourceGroupName: string, commitmentPlanName: string, commitmentPlanAssociationName: string, options?: CommitmentPlansGetAssociationOptionalParams): Promise<CommitmentPlanAccountAssociation>

Parameters

resourceGroupName

string

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

commitmentPlanName

string

The name of the commitmentPlan associated with the Cognitive Services Account

commitmentPlanAssociationName

string

The name of the commitment plan association with the Cognitive Services Account

options

CommitmentPlansGetAssociationOptionalParams

The options parameters.

Returns

Promise<CommitmentPlanAccountAssociation>

getPlan(string, string, CommitmentPlansGetPlanOptionalParams)

Returns a Cognitive Services commitment plan specified by the parameters.

function getPlan(resourceGroupName: string, commitmentPlanName: string, options?: CommitmentPlansGetPlanOptionalParams): Promise<CommitmentPlan>

Parameters

resourceGroupName

string

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

commitmentPlanName

string

The name of the commitmentPlan associated with the Cognitive Services Account

options

CommitmentPlansGetPlanOptionalParams

The options parameters.

Returns

Promise<CommitmentPlan>

list(string, string, CommitmentPlansListOptionalParams)

Gets the commitmentPlans associated with the Cognitive Services account.

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

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

options

CommitmentPlansListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CommitmentPlan, CommitmentPlan[], PageSettings>

listAssociations(string, string, CommitmentPlansListAssociationsOptionalParams)

Gets the associations of the Cognitive Services commitment plan.

function listAssociations(resourceGroupName: string, commitmentPlanName: string, options?: CommitmentPlansListAssociationsOptionalParams): PagedAsyncIterableIterator<CommitmentPlanAccountAssociation, CommitmentPlanAccountAssociation[], PageSettings>

Parameters

resourceGroupName

string

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

commitmentPlanName

string

The name of the commitmentPlan associated with the Cognitive Services Account

options

CommitmentPlansListAssociationsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CommitmentPlanAccountAssociation, CommitmentPlanAccountAssociation[], PageSettings>

listPlansByResourceGroup(string, CommitmentPlansListPlansByResourceGroupOptionalParams)

Returns all the resources of a particular type belonging to a resource group

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

Parameters

resourceGroupName

string

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

options

CommitmentPlansListPlansByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CommitmentPlan, CommitmentPlan[], PageSettings>

listPlansBySubscription(CommitmentPlansListPlansBySubscriptionOptionalParams)

Returns all the resources of a particular type belonging to a subscription.

function listPlansBySubscription(options?: CommitmentPlansListPlansBySubscriptionOptionalParams): PagedAsyncIterableIterator<CommitmentPlan, CommitmentPlan[], PageSettings>

Parameters

options

CommitmentPlansListPlansBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CommitmentPlan, CommitmentPlan[], PageSettings>