member_cap_overrides

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

Overview

Name	member_cap_overrides
Type	Resource
Id	azure.compute_limit.member_cap_overrides

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.
cap	integer	The cap value in count units for this member subscription. 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_parent

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.
cap	integer	The cap value in count units for this member subscription. 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, member_subscription_id, subscription_id		Gets the cap override configured for a single member subscription.
list_by_parent	select	location, vm_family_name, subscription_id		Lists all per-member cap overrides configured under a SharedLimitCap.
create_or_update	insert	location, vm_family_name, member_subscription_id, subscription_id		Creates or replaces the cap override for a single member subscription.
create_or_update	replace	location, vm_family_name, member_subscription_id, subscription_id		Creates or replaces the cap override for a single member subscription.
delete	delete	location, vm_family_name, member_subscription_id, subscription_id		Removes the per-member cap override for a member subscription.

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.
member_subscription_id	string	The name of the MemberCapOverride. Required.
subscription_id	string
vm_family_name	string	The name of the SharedLimitCap. Required.

SELECT examples

get

Gets the cap override configured for a single member subscription.

SELECT
id,
name,
cap,
provisioningState,
systemData,
type
FROM azure.compute_limit.member_cap_overrides
WHERE location = '{{ location }}' -- required
AND vm_family_name = '{{ vm_family_name }}' -- required
AND member_subscription_id = '{{ member_subscription_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_parent

Lists all per-member cap overrides configured under a SharedLimitCap.

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

INSERT examples

create_or_update

Creates or replaces the cap override for a single member subscription.

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

Manifest

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

REPLACE examples

create_or_update

Creates or replaces the cap override for a single member subscription.

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

DELETE examples

delete

Removes the per-member cap override for a member subscription.

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