@azure/arm-quota package

Classes

AzureQuotaExtensionAPI

Interfaces

AllocatedQuotaToSubscriptionList

Quota allocated to subscriptions

AllocatedToSubscription

SubscriptionIds and quota allocated to subscriptions from the GroupQuota.

AzureQuotaExtensionAPIOptionalParams

Optional parameters.

CommonResourceProperties

Resource properties.

CreateGenericQuotaRequestParameters

Quota change requests information.

CurrentQuotaLimitBase

Quota limit.

CurrentUsagesBase

Resource usage.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

ExceptionResponse

Error.

GroupQuotaDetails

Group Quota details.

GroupQuotaDetailsName

Name of the resource provided by the resource provider. This property is already included in the request URI, so it is a readonly property returned in the response.

GroupQuotaLimit

Group Quota limit.

GroupQuotaLimitList

List of Group Quota Limit details.

GroupQuotaLimitListProperties
GroupQuotaLimitProperties

Group Quota properties for the specified resource.

GroupQuotaLimits

Interface representing a GroupQuotaLimits.

GroupQuotaLimitsListOptionalParams

Optional parameters.

GroupQuotaLimitsRequest

Interface representing a GroupQuotaLimitsRequest.

GroupQuotaLimitsRequestGetOptionalParams

Optional parameters.

GroupQuotaLimitsRequestListNextOptionalParams

Optional parameters.

GroupQuotaLimitsRequestListOptionalParams

Optional parameters.

GroupQuotaLimitsRequestUpdateHeaders

Defines headers for GroupQuotaLimitsRequest_update operation.

GroupQuotaLimitsRequestUpdateOptionalParams

Optional parameters.

GroupQuotaList

List of Group Quotas at MG level.

GroupQuotaRequestBase

The new GroupQuota limit requested.

GroupQuotaRequestBaseProperties
GroupQuotaRequestBasePropertiesName

Name of the resource provided by the resource provider. This property is already included in the request URI, so it is a readonly property returned in the response.

GroupQuotaSubscriptionAllocation

Interface representing a GroupQuotaSubscriptionAllocation.

GroupQuotaSubscriptionAllocationListOptionalParams

Optional parameters.

GroupQuotaSubscriptionAllocationRequest

Interface representing a GroupQuotaSubscriptionAllocationRequest.

GroupQuotaSubscriptionAllocationRequestGetOptionalParams

Optional parameters.

GroupQuotaSubscriptionAllocationRequestListNextOptionalParams

Optional parameters.

GroupQuotaSubscriptionAllocationRequestListOptionalParams

Optional parameters.

GroupQuotaSubscriptionAllocationRequestUpdateHeaders

Defines headers for GroupQuotaSubscriptionAllocationRequest_update operation.

GroupQuotaSubscriptionAllocationRequestUpdateOptionalParams

Optional parameters.

GroupQuotaSubscriptionId

This represents a Azure subscriptionId that is associated with a GroupQuotasEntity.

GroupQuotaSubscriptionIdList

List of GroupQuotaSubscriptionIds

GroupQuotaSubscriptionIdProperties
GroupQuotaSubscriptionRequestStatus

The new quota limit request status.

GroupQuotaSubscriptionRequestStatusList

List of GroupQuotaSubscriptionRequests Status

GroupQuotaSubscriptionRequestStatusProperties
GroupQuotaSubscriptionRequests

Interface representing a GroupQuotaSubscriptionRequests.

GroupQuotaSubscriptionRequestsGetOptionalParams

Optional parameters.

GroupQuotaSubscriptionRequestsListNextOptionalParams

Optional parameters.

GroupQuotaSubscriptionRequestsListOptionalParams

Optional parameters.

GroupQuotaSubscriptions

Interface representing a GroupQuotaSubscriptions.

GroupQuotaSubscriptionsCreateOrUpdateHeaders

Defines headers for GroupQuotaSubscriptions_createOrUpdate operation.

GroupQuotaSubscriptionsCreateOrUpdateOptionalParams

Optional parameters.

GroupQuotaSubscriptionsDeleteHeaders

Defines headers for GroupQuotaSubscriptions_delete operation.

GroupQuotaSubscriptionsDeleteOptionalParams

Optional parameters.

GroupQuotaSubscriptionsGetOptionalParams

Optional parameters.

GroupQuotaSubscriptionsListNextOptionalParams

Optional parameters.

GroupQuotaSubscriptionsListOptionalParams

Optional parameters.

GroupQuotaSubscriptionsUpdateHeaders

Defines headers for GroupQuotaSubscriptions_update operation.

GroupQuotaSubscriptionsUpdateOptionalParams

Optional parameters.

GroupQuotaUsagesBase

Resource details with usages and GroupQuota.

GroupQuotaUsagesBaseName

Name of the resource provided by the resource provider. This property is already included in the request URI, so it is a readonly property returned in the response.

GroupQuotas

Interface representing a GroupQuotas.

GroupQuotasCreateOrUpdateHeaders

Defines headers for GroupQuotas_createOrUpdate operation.

GroupQuotasCreateOrUpdateOptionalParams

Optional parameters.

GroupQuotasDeleteHeaders

Defines headers for GroupQuotas_delete operation.

GroupQuotasDeleteOptionalParams

Optional parameters.

GroupQuotasEntity

Properties and filters for ShareQuota. The request parameter is optional, if there are no filters specified.

GroupQuotasEntityBase

Properties and filters for ShareQuota. The request parameter is optional, if there are no filters specified.

GroupQuotasEntityBasePatch

Properties and filters for ShareQuota. The request parameter is optional, if there are no filters specified.

GroupQuotasEntityPatch

Properties and filters for ShareQuota. The request parameter is optional, if there are no filters specified.

GroupQuotasEntityPatchProperties

Properties

GroupQuotasEntityProperties

Properties

GroupQuotasGetOptionalParams

Optional parameters.

GroupQuotasListNextOptionalParams

Optional parameters.

GroupQuotasListOptionalParams

Optional parameters.

GroupQuotasUpdateHeaders

Defines headers for GroupQuotas_update operation.

GroupQuotasUpdateOptionalParams

Optional parameters.

LROResponse

The provisioning state for the operation.

LROResponseProperties
LimitJsonObject

LimitJson abstract class.

LimitObject

The resource quota limit value.

OperationDisplay
OperationList
OperationResponse
ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Quota

Interface representing a Quota.

QuotaAllocationRequestBase

The new quota request allocated to subscription.

QuotaAllocationRequestBaseProperties
QuotaAllocationRequestBasePropertiesName

Name of the resource provided by the resource provider. This property is already included in the request URI, so it is a readonly property returned in the response.

QuotaAllocationRequestStatus

The subscription quota allocation status.

QuotaAllocationRequestStatusList

List of QuotaAllocation Request Status

QuotaAllocationRequestStatusProperties
QuotaCreateOrUpdateOptionalParams

Optional parameters.

QuotaGetHeaders

Defines headers for Quota_get operation.

QuotaGetOptionalParams

Optional parameters.

QuotaLimits

Quota limits.

QuotaLimitsResponse

Quota limits request response.

QuotaListHeaders

Defines headers for Quota_list operation.

QuotaListNextHeaders

Defines headers for Quota_listNext operation.

QuotaListNextOptionalParams

Optional parameters.

QuotaListOptionalParams

Optional parameters.

QuotaOperation

Interface representing a QuotaOperation.

QuotaOperationListNextOptionalParams

Optional parameters.

QuotaOperationListOptionalParams

Optional parameters.

QuotaProperties

Quota properties for the specified resource.

QuotaRequestDetails

List of quota requests with details.

QuotaRequestDetailsList

Quota request information.

QuotaRequestOneResourceProperties

Quota request.

QuotaRequestOneResourceSubmitResponse

Quota request response.

QuotaRequestProperties

Quota request properties.

QuotaRequestStatus

Interface representing a QuotaRequestStatus.

QuotaRequestStatusDetails

Quota request status details.

QuotaRequestStatusGetOptionalParams

Optional parameters.

QuotaRequestStatusListNextOptionalParams

Optional parameters.

QuotaRequestStatusListOptionalParams

Optional parameters.

QuotaRequestSubmitResponse

Quota request response.

QuotaRequestSubmitResponse202

The quota request response with the quota request ID.

QuotaUpdateOptionalParams

Optional parameters.

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

ResourceBaseRequest

Resource definition with the requested quota.

ResourceName

Name of the resource provided by the resource Provider. When requesting quota, use this property name.

ResourceUsageList

List of resource usages and quotas for GroupQuota.

ResourceUsages

Resource details with usages and GroupQuota.

ServiceError

API error details.

ServiceErrorDetail

Error details.

SubRequest

Request property.

SubmittedResourceRequestStatus

Status of a single GroupQuota request.

SubmittedResourceRequestStatusList

Share Quota Entity list.

SubmittedResourceRequestStatusProperties
SubscriptionGroupQuotaAssignment

MGId the source of group quota.

SubscriptionQuotaAllocationRequestList

List of Allocated Group Quota to the subscriptions.

SubscriptionQuotaAllocations

Quota allocated to a subscription for the specific Resource Provider, Location, ResourceName. This will include the GroupQuota and total quota allocated to the subscription. Only the Group quota allocated to the subscription can be allocated back to the MG Group Quota.

SubscriptionQuotaAllocationsList

Subscription quota list.

SubscriptionQuotaAllocationsListProperties
SubscriptionQuotaAllocationsProperties

Quota properties for the specified resource.

SubscriptionQuotaAllocationsStatusList

Subscription quota allocation requests status list.

SubscriptionQuotaDetails

Subscription Quota details.

SubscriptionQuotaDetailsName

Name of the resource provided by the resource provider. This property is already included in the request URI, so it is a readonly property returned in the response.

SystemData

Metadata pertaining to creation and last modification of the resource.

Usages

Interface representing a Usages.

UsagesGetHeaders

Defines headers for Usages_get operation.

UsagesGetOptionalParams

Optional parameters.

UsagesLimits

Quota limits.

UsagesListHeaders

Defines headers for Usages_list operation.

UsagesListNextHeaders

Defines headers for Usages_listNext operation.

UsagesListNextOptionalParams

Optional parameters.

UsagesListOptionalParams

Optional parameters.

UsagesObject

The resource usages value.

UsagesProperties

Usage properties for the specified resource.

Type Aliases

CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

GroupQuotaLimitsListResponse

Contains response data for the list operation.

GroupQuotaLimitsRequestGetResponse

Contains response data for the get operation.

GroupQuotaLimitsRequestListNextResponse

Contains response data for the listNext operation.

GroupQuotaLimitsRequestListResponse

Contains response data for the list operation.

GroupQuotaLimitsRequestUpdateResponse

Contains response data for the update operation.

GroupQuotaSubscriptionAllocationListResponse

Contains response data for the list operation.

GroupQuotaSubscriptionAllocationRequestGetResponse

Contains response data for the get operation.

GroupQuotaSubscriptionAllocationRequestListNextResponse

Contains response data for the listNext operation.

GroupQuotaSubscriptionAllocationRequestListResponse

Contains response data for the list operation.

GroupQuotaSubscriptionAllocationRequestUpdateResponse

Contains response data for the update operation.

GroupQuotaSubscriptionRequestsGetResponse

Contains response data for the get operation.

GroupQuotaSubscriptionRequestsListNextResponse

Contains response data for the listNext operation.

GroupQuotaSubscriptionRequestsListResponse

Contains response data for the list operation.

GroupQuotaSubscriptionsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

GroupQuotaSubscriptionsDeleteResponse

Contains response data for the delete operation.

GroupQuotaSubscriptionsGetResponse

Contains response data for the get operation.

GroupQuotaSubscriptionsListNextResponse

Contains response data for the listNext operation.

GroupQuotaSubscriptionsListResponse

Contains response data for the list operation.

GroupQuotaSubscriptionsUpdateResponse

Contains response data for the update operation.

GroupQuotasCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

GroupQuotasDeleteResponse

Contains response data for the delete operation.

GroupQuotasGetResponse

Contains response data for the get operation.

GroupQuotasListNextResponse

Contains response data for the listNext operation.

GroupQuotasListResponse

Contains response data for the list operation.

GroupQuotasUpdateResponse

Contains response data for the update operation.

LimitJsonObjectUnion
LimitType

Defines values for LimitType.
KnownLimitType can be used interchangeably with LimitType, this enum contains the known values that the service supports.

Known values supported by the service

LimitValue

QuotaCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

QuotaGetResponse

Contains response data for the get operation.

QuotaLimitTypes

Defines values for QuotaLimitTypes.
KnownQuotaLimitTypes can be used interchangeably with QuotaLimitTypes, this enum contains the known values that the service supports.

Known values supported by the service

Independent
Shared

QuotaListNextResponse

Contains response data for the listNext operation.

QuotaListResponse

Contains response data for the list operation.

QuotaOperationListNextResponse

Contains response data for the listNext operation.

QuotaOperationListResponse

Contains response data for the list operation.

QuotaRequestState

Defines values for QuotaRequestState.
KnownQuotaRequestState can be used interchangeably with QuotaRequestState, this enum contains the known values that the service supports.

Known values supported by the service

Accepted
Invalid
Succeeded
Failed
InProgress

QuotaRequestStatusGetResponse

Contains response data for the get operation.

QuotaRequestStatusListNextResponse

Contains response data for the listNext operation.

QuotaRequestStatusListResponse

Contains response data for the list operation.

QuotaUpdateResponse

Contains response data for the update operation.

RequestState

Defines values for RequestState.
KnownRequestState can be used interchangeably with RequestState, this enum contains the known values that the service supports.

Known values supported by the service

Accepted
Created
Invalid
Succeeded
Failed
InProgress
Canceled

UsagesGetResponse

Contains response data for the get operation.

UsagesListNextResponse

Contains response data for the listNext operation.

UsagesListResponse

Contains response data for the list operation.

UsagesTypes

Defines values for UsagesTypes.
KnownUsagesTypes can be used interchangeably with UsagesTypes, this enum contains the known values that the service supports.

Known values supported by the service

Individual
Combined

Enums

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownLimitType

Known values of LimitType that the service accepts.

KnownQuotaLimitTypes

Known values of QuotaLimitTypes that the service accepts.

KnownQuotaRequestState

Known values of QuotaRequestState that the service accepts.

KnownRequestState

Known values of RequestState that the service accepts.

KnownUsagesTypes

Known values of UsagesTypes that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.