guest_subscriptions

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

Overview

Name	guest_subscriptions
Type	Resource
Id	azure.compute_limit.guest_subscriptions

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.
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.
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, guest_subscription_id, subscription_id		Gets the properties of a guest subscription.
list_by_subscription_location_resource	select	location, subscription_id		Lists all guest subscriptions in a location.
create	insert	location, guest_subscription_id, subscription_id		Adds a subscription as a guest to consume the compute limits shared by the host subscription.
delete	delete	location, guest_subscription_id, subscription_id		Deletes a subscription as a guest to stop consuming the compute limits shared by the host 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
guest_subscription_id	string	The name of the GuestSubscription. Required.
location	string	The name of the Azure region. Required.
subscription_id	string

SELECT examples

get

Gets the properties of a guest subscription.

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

list_by_subscription_location_resource

Lists all guest subscriptions in a location.

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

INSERT examples

create

Adds a subscription as a guest to consume the compute limits shared by the host subscription.

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

Manifest

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

DELETE examples

delete

Deletes a subscription as a guest to stop consuming the compute limits shared by the host subscription.

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