shared_limits

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

Overview

Name	shared_limits
Type	Resource
Id	azure.compute_limit.shared_limits

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.
limit	integer	The maximum permitted usage of the resource.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
resourceName	object	The limit name properties.
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".
unit	string	The quota units, such as Count.

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.
limit	integer	The maximum permitted usage of the resource.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
resourceName	object	The limit name properties.
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".
unit	string	The quota units, such as Count.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	location, name, subscription_id		Gets the properties of a compute limit shared by the host subscription with its guest subscriptions.
list_by_subscription_location_resource	select	location, subscription_id		Lists all compute limits shared by the host subscription with its guest subscriptions.
create	insert	location, name, subscription_id		Enables sharing of a compute limit by the host subscription with its guest subscriptions.
delete	delete	location, name, subscription_id		Disables sharing of a compute limit by the host subscription with its guest subscriptions.

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.
name	string	The name of the SharedLimit. Required.
subscription_id	string

SELECT examples

get

Gets the properties of a compute limit shared by the host subscription with its guest subscriptions.

SELECT
id,
name,
limit,
provisioningState,
resourceName,
systemData,
type,
unit
FROM azure.compute_limit.shared_limits
WHERE location = '{{ location }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription_location_resource

Lists all compute limits shared by the host subscription with its guest subscriptions.

SELECT
id,
name,
limit,
provisioningState,
resourceName,
systemData,
type,
unit
FROM azure.compute_limit.shared_limits
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Enables sharing of a compute limit by the host subscription with its guest subscriptions.

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

Manifest

# Description fields are for documentation purposes
- name: shared_limits
props:
  - name: location
    value: "{{ location }}"
    description: Required parameter for the shared_limits resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the shared_limits resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the shared_limits resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      resourceName:
        value: "{{ value }}"
        localizedValue: "{{ localizedValue }}"
      limit: {{ limit }}
      unit: "{{ unit }}"
      provisioningState: "{{ provisioningState }}"

DELETE examples

delete

Disables sharing of a compute limit by the host subscription with its guest subscriptions.

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