Package com.azure.resourcemanager.quota.models

Interface Quotas

public interface Quotas

Resource collection API of Quotas.

Method Summary

Modifier and Type	Method	Description
CurrentQuotaLimitBase.DefinitionStages.Blank	define(String name)	Begins definition for a new CurrentQuotaLimitBase resource.
CurrentQuotaLimitBase	get(String resourceName, String scope)	Get the quota limit of a resource.
CurrentQuotaLimitBase	getById(String id)	Get the quota limit of a resource.
com.azure.core.http.rest.Response<CurrentQuotaLimitBase>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get the quota limit of a resource.
com.azure.core.http.rest.Response<CurrentQuotaLimitBase>	getWithResponse(String resourceName, String scope, com.azure.core.util.Context context)	Get the quota limit of a resource.
com.azure.core.http.rest.PagedIterable<CurrentQuotaLimitBase>	list(String scope)	Get a list of current quota limits of all resources for the specified scope.
com.azure.core.http.rest.PagedIterable<CurrentQuotaLimitBase>	list(String scope, com.azure.core.util.Context context)	Get a list of current quota limits of all resources for the specified scope.

Method Detail

get

CurrentQuotaLimitBase get(String resourceName,
                          String scope)

Get the quota limit of a resource. The response can be used to determine the remaining quota to calculate a new quota limit that can be submitted with a PUT request.

Parameters:

resourceName - Resource name for a given resource provider. For example: - SKU name for Microsoft.Compute - SKU or TotalLowPriorityCores for Microsoft.MachineLearningServices For Microsoft.Network PublicIPAddresses.

scope - The target Azure resource URI. For example, `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. This is the target Azure resource URI for the List GET operation. If a `{resourceName}` is added after `/quotas`, then it's the target Azure resource URI in the GET operation for the specific resource.

Returns:

the quota limit of a resource.

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<CurrentQuotaLimitBase> getWithResponse(String resourceName,
                                                                         String scope,
                                                                         com.azure.core.util.Context context)

Get the quota limit of a resource. The response can be used to determine the remaining quota to calculate a new quota limit that can be submitted with a PUT request.

Parameters:

resourceName - Resource name for a given resource provider. For example: - SKU name for Microsoft.Compute - SKU or TotalLowPriorityCores for Microsoft.MachineLearningServices For Microsoft.Network PublicIPAddresses.

scope - The target Azure resource URI. For example, `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. This is the target Azure resource URI for the List GET operation. If a `{resourceName}` is added after `/quotas`, then it's the target Azure resource URI in the GET operation for the specific resource.

context - The context to associate with this operation.

Returns:

the quota limit of a resource.

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<CurrentQuotaLimitBase> list(String scope)

Get a list of current quota limits of all resources for the specified scope. The response from this GET operation can be leveraged to submit requests to update a quota.

Parameters:

scope - The target Azure resource URI. For example, `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. This is the target Azure resource URI for the List GET operation. If a `{resourceName}` is added after `/quotas`, then it's the target Azure resource URI in the GET operation for the specific resource.

Returns:

a list of current quota limits of all resources for the specified scope.

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<CurrentQuotaLimitBase> list(String scope,
                                                                   com.azure.core.util.Context context)

Get a list of current quota limits of all resources for the specified scope. The response from this GET operation can be leveraged to submit requests to update a quota.

Parameters:

scope - The target Azure resource URI. For example, `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. This is the target Azure resource URI for the List GET operation. If a `{resourceName}` is added after `/quotas`, then it's the target Azure resource URI in the GET operation for the specific resource.

context - The context to associate with this operation.

Returns:

a list of current quota limits of all resources for the specified scope.

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

CurrentQuotaLimitBase getById(String id)

Get the quota limit of a resource. The response can be used to determine the remaining quota to calculate a new quota limit that can be submitted with a PUT request.

Parameters:

id - the resource ID.

Returns:

the quota limit of a resource.

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<CurrentQuotaLimitBase> getByIdWithResponse(String id,
                                                                             com.azure.core.util.Context context)

Get the quota limit of a resource. The response can be used to determine the remaining quota to calculate a new quota limit that can be submitted with a PUT request.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the quota limit of a resource.

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

CurrentQuotaLimitBase.DefinitionStages.Blank define(String name)

Begins definition for a new CurrentQuotaLimitBase resource.

Parameters:

name - resource name.

Returns:

the first stage of the new CurrentQuotaLimitBase definition.