SharedLimitCapProperties interface

Properties of a shared limit cap resource.

Properties

defaultMemberCap

The default member cap value (in count units). Set to a non-negative integer to apply a cap to all member subscriptions that do not have a per-member override. Omit the property to leave no default cap in effect.

isBoundedCap

Controls whether the service validates the aggregate cap against the group limit for the VM family.

SUM(caps) is the sum of all per-member overrides' cap values plus defaultMemberCap multiplied by the number of member subscriptions without an override.

When true, the service rejects any configuration where SUM(caps) exceeds the group limit. When false, SUM(caps) is permitted to exceed the group limit.

Enabling this flag is rejected if the current configuration already breaches the group limit; reduce caps first, then enable.

provisioningState

The provisioning state of the resource.

Property Details

defaultMemberCap

The default member cap value (in count units). Set to a non-negative integer to apply a cap to all member subscriptions that do not have a per-member override. Omit the property to leave no default cap in effect.

defaultMemberCap?: number

Property Value

number

isBoundedCap

Controls whether the service validates the aggregate cap against the group limit for the VM family.

SUM(caps) is the sum of all per-member overrides' cap values plus defaultMemberCap multiplied by the number of member subscriptions without an override.

When true, the service rejects any configuration where SUM(caps) exceeds the group limit. When false, SUM(caps) is permitted to exceed the group limit.

Enabling this flag is rejected if the current configuration already breaches the group limit; reduce caps first, then enable.

isBoundedCap: boolean

Property Value

boolean

provisioningState

The provisioning state of the resource.

provisioningState?: string

Property Value

string