plans

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

Overview

Name	plans
Type	Resource
Id	azure_stack.subscriptions_admin.plans

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	URI of the resource.
name	string	Name of the resource.
location	string	Location of the resource
properties	object	Properties of a plan.
tags	object	List of key-value pairs.
type	string	Type of resource.

list

Name	Datatype	Description
id	string	URI of the resource.
name	string	Name of the resource.
location	string	Location of the resource
properties	object	Properties of a plan.
tags	object	List of key-value pairs.
type	string	Type of resource.

list_all

Name	Datatype	Description
id	string	URI of the resource.
name	string	Name of the resource.
location	string	Location of the resource
properties	object	Properties of a plan.
tags	object	List of key-value pairs.
type	string	Type of resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, plan		Get the specified plan.
list	select	subscriptionId, resourceGroupName		Get the list of plans under a resource group.
list_all	select	subscriptionId		List all plans across all subscriptions.
create_or_update	insert	subscriptionId, resourceGroupName, plan		Create or update the plan.
delete	delete	subscriptionId, resourceGroupName, plan		Delete the specified plan.

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
plan	string	Name of the plan.
resourceGroupName	string	The resource group the resource is located under.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.

SELECT examples

get

Get the specified plan.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure_stack.subscriptions_admin.plans
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND plan = '{{ plan }}' -- required
;

list

Get the list of plans under a resource group.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure_stack.subscriptions_admin.plans
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_all

List all plans across all subscriptions.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure_stack.subscriptions_admin.plans
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or update the plan.

INSERT INTO azure_stack.subscriptions_admin.plans (
data__properties,
data__location,
subscriptionId,
resourceGroupName,
plan
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ plan }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: plans
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the plans resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the plans resource.
    - name: plan
      value: string
      description: Required parameter for the plans resource.
    - name: properties
      value: object
      description: |
        Properties of a plan.
    - name: location
      value: string
      description: |
        Location of the resource

DELETE examples

delete

Delete the specified plan.

DELETE FROM azure_stack.subscriptions_admin.plans
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND plan = '{{ plan }}' --required
;