shared_limit_caps

Creates, updates, deletes, gets or lists a shared_limit_caps resource.

Overview

Name	shared_limit_caps
Type	Resource
Id	azure.compute_limit.shared_limit_caps

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
defaultMemberCap	integer	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	boolean	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. Required.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription_location_resource

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
defaultMemberCap	integer	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	boolean	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. Required.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	location, vm_family_name, subscription_id		Gets the shared limit cap configuration for a VM family, as visible to the caller's subscription.
list_by_subscription_location_resource	select	location, subscription_id		Lists all shared limit cap configurations visible to the caller's subscription.
create_or_update	insert	location, vm_family_name, subscription_id		Creates or replaces the shared limit cap configuration for a VM family.
create_or_update	replace	location, vm_family_name, subscription_id		Creates or replaces the shared limit cap configuration for a VM family.
delete	delete	location, vm_family_name, subscription_id		Deletes the shared limit cap configuration for a VM family. The caller's subscription is treated as the host subscription.
set_member_cap_overrides	exec	location, vm_family_name, subscription_id, memberCapOverrides		Replaces the full set of per-member cap overrides for this shared limit cap. The supplied array becomes the new complete set of overrides; supplying an empty array clears all existing overrides.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
location	string	The name of the Azure region. Required.
subscription_id	string
vm_family_name	string	The name of the SharedLimitCap. Required.

SELECT examples

get

Gets the shared limit cap configuration for a VM family, as visible to the caller's subscription.

SELECT
id,
name,
defaultMemberCap,
isBoundedCap,
provisioningState,
systemData,
type
FROM azure.compute_limit.shared_limit_caps
WHERE location = '{{ location }}' -- required
AND vm_family_name = '{{ vm_family_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription_location_resource

Lists all shared limit cap configurations visible to the caller's subscription.

SELECT
id,
name,
defaultMemberCap,
isBoundedCap,
provisioningState,
systemData,
type
FROM azure.compute_limit.shared_limit_caps
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or replaces the shared limit cap configuration for a VM family.

INSERT INTO azure.compute_limit.shared_limit_caps (
properties,
location,
vm_family_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ vm_family_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: shared_limit_caps
props:
  - name: location
    value: "{{ location }}"
    description: Required parameter for the shared_limit_caps resource.
  - name: vm_family_name
    value: "{{ vm_family_name }}"
    description: Required parameter for the shared_limit_caps resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the shared_limit_caps resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      defaultMemberCap: {{ defaultMemberCap }}
      isBoundedCap: {{ isBoundedCap }}
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates or replaces the shared limit cap configuration for a VM family.

REPLACE azure.compute_limit.shared_limit_caps
SET 
properties = '{{ properties }}'
WHERE 
location = '{{ location }}' --required
AND vm_family_name = '{{ vm_family_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the shared limit cap configuration for a VM family. The caller's subscription is treated as the host subscription.

DELETE FROM azure.compute_limit.shared_limit_caps
WHERE location = '{{ location }}' --required
AND vm_family_name = '{{ vm_family_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

set_member_cap_overrides

Replaces the full set of per-member cap overrides for this shared limit cap. The supplied array becomes the new complete set of overrides; supplying an empty array clears all existing overrides.

EXEC azure.compute_limit.shared_limit_caps.set_member_cap_overrides 
@location='{{ location }}' --required, 
@vm_family_name='{{ vm_family_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"memberCapOverrides": "{{ memberCapOverrides }}"
}'
;