Package com.azure.resourcemanager.cognitiveservices.models

Interface CommitmentPlans

public interface CommitmentPlans

Resource collection API of CommitmentPlans.

Method Summary

Modifier and Type	Method	Description
CommitmentPlan.DefinitionStages.Blank	define(String name)	Begins definition for a new CommitmentPlan resource.
void	delete(String resourceGroupName, String accountName, String commitmentPlanName)	Deletes the specified commitmentPlan associated with the Cognitive Services account.
void	delete(String resourceGroupName, String accountName, String commitmentPlanName, com.azure.core.util.Context context)	Deletes the specified commitmentPlan associated with the Cognitive Services account.
void	deleteById(String id)	Deletes the specified commitmentPlan associated with the Cognitive Services account.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes the specified commitmentPlan associated with the Cognitive Services account.
CommitmentPlan	get(String resourceGroupName, String accountName, String commitmentPlanName)	Gets the specified commitmentPlans associated with the Cognitive Services account.
CommitmentPlan	getById(String id)	Gets the specified commitmentPlans associated with the Cognitive Services account.
com.azure.core.http.rest.Response<CommitmentPlan>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets the specified commitmentPlans associated with the Cognitive Services account.
com.azure.core.http.rest.Response<CommitmentPlan>	getWithResponse(String resourceGroupName, String accountName, String commitmentPlanName, com.azure.core.util.Context context)	Gets the specified commitmentPlans associated with the Cognitive Services account.
com.azure.core.http.rest.PagedIterable<CommitmentPlan>	list(String resourceGroupName, String accountName)	Gets the commitmentPlans associated with the Cognitive Services account.
com.azure.core.http.rest.PagedIterable<CommitmentPlan>	list(String resourceGroupName, String accountName, com.azure.core.util.Context context)	Gets the commitmentPlans associated with the Cognitive Services account.

Method Detail

list

com.azure.core.http.rest.PagedIterable<CommitmentPlan> list(String resourceGroupName,
                                                            String accountName)

Gets the commitmentPlans associated with the Cognitive Services account.

Parameters:

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

accountName - The name of Cognitive Services account.

Returns:

the commitmentPlans associated with the Cognitive Services account as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<CommitmentPlan> list(String resourceGroupName,
                                                            String accountName,
                                                            com.azure.core.util.Context context)

Gets the commitmentPlans associated with the Cognitive Services account.

Parameters:

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

accountName - The name of Cognitive Services account.

context - The context to associate with this operation.

Returns:

the commitmentPlans associated with the Cognitive Services account as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

get

CommitmentPlan get(String resourceGroupName,
                   String accountName,
                   String commitmentPlanName)

Gets the specified commitmentPlans associated with the Cognitive Services account.

Parameters:

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

accountName - The name of Cognitive Services account.

commitmentPlanName - The name of the commitmentPlan associated with the Cognitive Services Account.

Returns:

the specified commitmentPlans associated with the Cognitive Services account.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getWithResponse

com.azure.core.http.rest.Response<CommitmentPlan> getWithResponse(String resourceGroupName,
                                                                  String accountName,
                                                                  String commitmentPlanName,
                                                                  com.azure.core.util.Context context)

Gets the specified commitmentPlans associated with the Cognitive Services account.

Parameters:

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

accountName - The name of Cognitive Services account.

commitmentPlanName - The name of the commitmentPlan associated with the Cognitive Services Account.

context - The context to associate with this operation.

Returns:

the specified commitmentPlans associated with the Cognitive Services account along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String accountName,
            String commitmentPlanName)

Deletes the specified commitmentPlan associated with the Cognitive Services account.

Parameters:

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

accountName - The name of Cognitive Services account.

commitmentPlanName - The name of the commitmentPlan associated with the Cognitive Services Account.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String accountName,
            String commitmentPlanName,
            com.azure.core.util.Context context)

Deletes the specified commitmentPlan associated with the Cognitive Services account.

Parameters:

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

accountName - The name of Cognitive Services account.

commitmentPlanName - The name of the commitmentPlan associated with the Cognitive Services Account.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getById

CommitmentPlan getById(String id)

Gets the specified commitmentPlans associated with the Cognitive Services account.

Parameters:

id - the resource ID.

Returns:

the specified commitmentPlans associated with the Cognitive Services account along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByIdWithResponse

com.azure.core.http.rest.Response<CommitmentPlan> getByIdWithResponse(String id,
                                                                      com.azure.core.util.Context context)

Gets the specified commitmentPlans associated with the Cognitive Services account.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the specified commitmentPlans associated with the Cognitive Services account along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteById

void deleteById(String id)

Deletes the specified commitmentPlan associated with the Cognitive Services account.

Parameters:

id - the resource ID.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteByIdWithResponse

void deleteByIdWithResponse(String id,
                            com.azure.core.util.Context context)

Deletes the specified commitmentPlan associated with the Cognitive Services account.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

define

CommitmentPlan.DefinitionStages.Blank define(String name)

Begins definition for a new CommitmentPlan resource.

Parameters:

name - resource name.

Returns:

the first stage of the new CommitmentPlan definition.