Package com.azure.resourcemanager.quota.fluent

Interface QuotasClient

public interface QuotasClient

An instance of this class provides access to all the operations defined in QuotasClient.

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CurrentQuotaLimitBaseInner>,CurrentQuotaLimitBaseInner>	beginCreateOrUpdate(String resourceName, String scope, CurrentQuotaLimitBaseInner createQuotaRequest)	Create or update the quota limit for the specified resource with the requested value.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CurrentQuotaLimitBaseInner>,CurrentQuotaLimitBaseInner>	beginCreateOrUpdate(String resourceName, String scope, CurrentQuotaLimitBaseInner createQuotaRequest, com.azure.core.util.Context context)	Create or update the quota limit for the specified resource with the requested value.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CurrentQuotaLimitBaseInner>,CurrentQuotaLimitBaseInner>	beginUpdate(String resourceName, String scope, CurrentQuotaLimitBaseInner createQuotaRequest)	Update the quota limit for a specific resource to the specified value: 1.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CurrentQuotaLimitBaseInner>,CurrentQuotaLimitBaseInner>	beginUpdate(String resourceName, String scope, CurrentQuotaLimitBaseInner createQuotaRequest, com.azure.core.util.Context context)	Update the quota limit for a specific resource to the specified value: 1.
CurrentQuotaLimitBaseInner	createOrUpdate(String resourceName, String scope, CurrentQuotaLimitBaseInner createQuotaRequest)	Create or update the quota limit for the specified resource with the requested value.
CurrentQuotaLimitBaseInner	createOrUpdate(String resourceName, String scope, CurrentQuotaLimitBaseInner createQuotaRequest, com.azure.core.util.Context context)	Create or update the quota limit for the specified resource with the requested value.
CurrentQuotaLimitBaseInner	get(String resourceName, String scope)	Get the quota limit of a resource.
QuotasGetResponse	getWithResponse(String resourceName, String scope, com.azure.core.util.Context context)	Get the quota limit of a resource.
com.azure.core.http.rest.PagedIterable<CurrentQuotaLimitBaseInner>	list(String scope)	Get a list of current quota limits of all resources for the specified scope.
com.azure.core.http.rest.PagedIterable<CurrentQuotaLimitBaseInner>	list(String scope, com.azure.core.util.Context context)	Get a list of current quota limits of all resources for the specified scope.
CurrentQuotaLimitBaseInner	update(String resourceName, String scope, CurrentQuotaLimitBaseInner createQuotaRequest)	Update the quota limit for a specific resource to the specified value: 1.
CurrentQuotaLimitBaseInner	update(String resourceName, String scope, CurrentQuotaLimitBaseInner createQuotaRequest, com.azure.core.util.Context context)	Update the quota limit for a specific resource to the specified value: 1.

Method Detail

get

CurrentQuotaLimitBaseInner 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

QuotasGetResponse 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.

beginCreateOrUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CurrentQuotaLimitBaseInner>,CurrentQuotaLimitBaseInner> beginCreateOrUpdate(String resourceName,
                                                                                                                                                                      String scope,
                                                                                                                                                                      CurrentQuotaLimitBaseInner createQuotaRequest)

Create or update the quota limit for the specified resource with the requested value. To update the quota, follow these steps: 1. Use the GET operation for quotas and usages to determine how much quota remains for the specific resource and to calculate the new quota limit. These steps are detailed in [this example](https://techcommunity.microsoft.com/t5/azure-governance-and-management/using-the-new-quota-rest-api/ba-p/2183670). 2. Use this PUT operation to update the quota limit. Please check the URI in location header for the detailed status of the 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.

createQuotaRequest - Quota request payload.

Returns:

quota limit.

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.

beginCreateOrUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CurrentQuotaLimitBaseInner>,CurrentQuotaLimitBaseInner> beginCreateOrUpdate(String resourceName,
                                                                                                                                                                      String scope,
                                                                                                                                                                      CurrentQuotaLimitBaseInner createQuotaRequest,
                                                                                                                                                                      com.azure.core.util.Context context)

Create or update the quota limit for the specified resource with the requested value. To update the quota, follow these steps: 1. Use the GET operation for quotas and usages to determine how much quota remains for the specific resource and to calculate the new quota limit. These steps are detailed in [this example](https://techcommunity.microsoft.com/t5/azure-governance-and-management/using-the-new-quota-rest-api/ba-p/2183670). 2. Use this PUT operation to update the quota limit. Please check the URI in location header for the detailed status of the 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.

createQuotaRequest - Quota request payload.

context - The context to associate with this operation.

Returns:

quota limit.

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.

createOrUpdate

CurrentQuotaLimitBaseInner createOrUpdate(String resourceName,
                                          String scope,
                                          CurrentQuotaLimitBaseInner createQuotaRequest)

Create or update the quota limit for the specified resource with the requested value. To update the quota, follow these steps: 1. Use the GET operation for quotas and usages to determine how much quota remains for the specific resource and to calculate the new quota limit. These steps are detailed in [this example](https://techcommunity.microsoft.com/t5/azure-governance-and-management/using-the-new-quota-rest-api/ba-p/2183670). 2. Use this PUT operation to update the quota limit. Please check the URI in location header for the detailed status of the 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.

createQuotaRequest - Quota request payload.

Returns:

quota limit.

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.

createOrUpdate

CurrentQuotaLimitBaseInner createOrUpdate(String resourceName,
                                          String scope,
                                          CurrentQuotaLimitBaseInner createQuotaRequest,
                                          com.azure.core.util.Context context)

Create or update the quota limit for the specified resource with the requested value. To update the quota, follow these steps: 1. Use the GET operation for quotas and usages to determine how much quota remains for the specific resource and to calculate the new quota limit. These steps are detailed in [this example](https://techcommunity.microsoft.com/t5/azure-governance-and-management/using-the-new-quota-rest-api/ba-p/2183670). 2. Use this PUT operation to update the quota limit. Please check the URI in location header for the detailed status of the 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.

createQuotaRequest - Quota request payload.

context - The context to associate with this operation.

Returns:

quota limit.

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.

beginUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CurrentQuotaLimitBaseInner>,CurrentQuotaLimitBaseInner> beginUpdate(String resourceName,
                                                                                                                                                              String scope,
                                                                                                                                                              CurrentQuotaLimitBaseInner createQuotaRequest)

Update the quota limit for a specific resource to the specified value: 1. Use the Usages-GET and Quota-GET operations to determine the remaining quota for the specific resource and to calculate the new quota limit. These steps are detailed in [this example](https://techcommunity.microsoft.com/t5/azure-governance-and-management/using-the-new-quota-rest-api/ba-p/2183670). 2. Use this PUT operation to update the quota limit. Please check the URI in location header for the detailed status of the 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.

createQuotaRequest - Quota requests payload.

Returns:

quota limit.

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.

beginUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CurrentQuotaLimitBaseInner>,CurrentQuotaLimitBaseInner> beginUpdate(String resourceName,
                                                                                                                                                              String scope,
                                                                                                                                                              CurrentQuotaLimitBaseInner createQuotaRequest,
                                                                                                                                                              com.azure.core.util.Context context)

Update the quota limit for a specific resource to the specified value: 1. Use the Usages-GET and Quota-GET operations to determine the remaining quota for the specific resource and to calculate the new quota limit. These steps are detailed in [this example](https://techcommunity.microsoft.com/t5/azure-governance-and-management/using-the-new-quota-rest-api/ba-p/2183670). 2. Use this PUT operation to update the quota limit. Please check the URI in location header for the detailed status of the 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.

createQuotaRequest - Quota requests payload.

context - The context to associate with this operation.

Returns:

quota limit.

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.

update

CurrentQuotaLimitBaseInner update(String resourceName,
                                  String scope,
                                  CurrentQuotaLimitBaseInner createQuotaRequest)

Update the quota limit for a specific resource to the specified value: 1. Use the Usages-GET and Quota-GET operations to determine the remaining quota for the specific resource and to calculate the new quota limit. These steps are detailed in [this example](https://techcommunity.microsoft.com/t5/azure-governance-and-management/using-the-new-quota-rest-api/ba-p/2183670). 2. Use this PUT operation to update the quota limit. Please check the URI in location header for the detailed status of the 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.

createQuotaRequest - Quota requests payload.

Returns:

quota limit.

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.

update

CurrentQuotaLimitBaseInner update(String resourceName,
                                  String scope,
                                  CurrentQuotaLimitBaseInner createQuotaRequest,
                                  com.azure.core.util.Context context)

Update the quota limit for a specific resource to the specified value: 1. Use the Usages-GET and Quota-GET operations to determine the remaining quota for the specific resource and to calculate the new quota limit. These steps are detailed in [this example](https://techcommunity.microsoft.com/t5/azure-governance-and-management/using-the-new-quota-rest-api/ba-p/2183670). 2. Use this PUT operation to update the quota limit. Please check the URI in location header for the detailed status of the 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.

createQuotaRequest - Quota requests payload.

context - The context to associate with this operation.

Returns:

quota limit.

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<CurrentQuotaLimitBaseInner> 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<CurrentQuotaLimitBaseInner> 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.