Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Quota

Package version

Interface representing a Quota.

Hierarchy

  • Quota

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

  • 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.
    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: string

      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: string

      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: CurrentQuotaLimitBase

      Quota request payload.

    • Optional options: QuotaCreateOrUpdateOptionalParams

      The options parameters.

    Returns Promise<PollerLike<PollOperationState<QuotaCreateOrUpdateResponse>, QuotaCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

  • 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.
    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: string

      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: string

      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: CurrentQuotaLimitBase

      Quota request payload.

    • Optional options: QuotaCreateOrUpdateOptionalParams

      The options parameters.

    Returns Promise<QuotaCreateOrUpdateResponse>

beginUpdate

  • 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.
    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: string

      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: string

      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: CurrentQuotaLimitBase

      Quota requests payload.

    • Optional options: QuotaUpdateOptionalParams

      The options parameters.

    Returns Promise<PollerLike<PollOperationState<QuotaUpdateResponse>, QuotaUpdateResponse>>

beginUpdateAndWait

  • 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.
    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: string

      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: string

      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: CurrentQuotaLimitBase

      Quota requests payload.

    • Optional options: QuotaUpdateOptionalParams

      The options parameters.

    Returns Promise<QuotaUpdateResponse>

get

  • 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: string

      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: string

      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.

    • Optional options: QuotaGetOptionalParams

      The options parameters.

    Returns Promise<QuotaGetResponse>

list

  • 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: string

      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.

    • Optional options: QuotaListOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<CurrentQuotaLimitBase>

Generated using TypeDoc