plans

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

Overview

Name	plans
Type	Resource
Id	azure.dev_center.plans

Fields

The following fields are returned by SELECT queries:

get

OK. The request has succeeded.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Plan properties
sku	object	The resource model definition representing SKU
tags	object	Resource tags.

list_by_resource_group

OK. The request has succeeded.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Plan properties
sku	object	The resource model definition representing SKU
tags	object	Resource tags.

list_by_subscription

OK. The request has succeeded.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Plan properties
sku	object	The resource model definition representing SKU
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, planName		Gets a devcenter plan.
list_by_resource_group	select	subscriptionId, resourceGroupName	$top	Lists all devcenter plans in a resource group.
list_by_subscription	select	subscriptionId	$top	Lists all devcenter plans in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, planName		Creates or updates a devcenter plan resource
update	update	subscriptionId, resourceGroupName, planName		Partially updates a devcenter plan.
delete	delete	subscriptionId, resourceGroupName, planName		Deletes a devcenter 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
planName	string	The name of the devcenter plan.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
$top	integer (int32)	The maximum number of resources to return from the operation. Example: '$top=10'.

SELECT examples

get

Gets a devcenter plan.

SELECT
location,
properties,
sku,
tags
FROM azure.dev_center.plans
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND planName = '{{ planName }}' -- required
;

list_by_resource_group

Lists all devcenter plans in a resource group.

SELECT
location,
properties,
sku,
tags
FROM azure.dev_center.plans
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND $top = '{{ $top }}'
;

list_by_subscription

Lists all devcenter plans in a subscription.

SELECT
location,
properties,
sku,
tags
FROM azure.dev_center.plans
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates a devcenter plan resource

INSERT INTO azure.dev_center.plans (
data__tags,
data__location,
data__properties,
data__sku,
subscriptionId,
resourceGroupName,
planName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ sku }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ planName }}'
RETURNING
location,
properties,
sku,
tags
;

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: planName
      value: string
      description: Required parameter for the plans resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Plan properties
    - name: sku
      value: object
      description: |
        The resource model definition representing SKU

UPDATE examples

update

Partially updates a devcenter plan.

UPDATE azure.dev_center.plans
SET 
data__tags = '{{ tags }}',
data__location = '{{ location }}',
data__sku = '{{ sku }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND planName = '{{ planName }}' --required
RETURNING
location,
properties,
sku,
tags;

DELETE examples

delete

Deletes a devcenter plan

DELETE FROM azure.dev_center.plans
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND planName = '{{ planName }}' --required
;