plan_members

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

Overview

Name	plan_members
Type	Resource
Id	azure.dev_center.plan_members

Fields

The following fields are returned by SELECT queries:

get

OK. The request has succeeded.

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
properties	object	Plan member properties
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

OK. The request has succeeded.

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
properties	object	Plan member properties
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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	subscriptionId, resourceGroupName, planName, memberName		Gets a devcenter plan member.
list	select	subscriptionId, resourceGroupName, planName	$top	Lists all of the members assigned to a devcenter plan.
create_or_update	insert	subscriptionId, resourceGroupName, planName, memberName		Creates or updates a devcenter plan member resource
update	update	subscriptionId, resourceGroupName, planName, memberName		Partially updates a devcenter plan member.
delete	delete	subscriptionId, resourceGroupName, planName, memberName		Deletes a devcenter plan member

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
memberName	string	The name of a devcenter plan member.
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 member.

SELECT
id,
name,
properties,
systemData,
tags,
type
FROM azure.dev_center.plan_members
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND planName = '{{ planName }}' -- required
AND memberName = '{{ memberName }}' -- required
;

list

Lists all of the members assigned to a devcenter plan.

SELECT
id,
name,
properties,
systemData,
tags,
type
FROM azure.dev_center.plan_members
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND planName = '{{ planName }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates a devcenter plan member resource

INSERT INTO azure.dev_center.plan_members (
data__properties,
data__tags,
subscriptionId,
resourceGroupName,
planName,
memberName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ planName }}',
'{{ memberName }}'
RETURNING
id,
name,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: plan_members
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the plan_members resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the plan_members resource.
    - name: planName
      value: string
      description: Required parameter for the plan_members resource.
    - name: memberName
      value: string
      description: Required parameter for the plan_members resource.
    - name: properties
      value: object
      description: |
        Plan member properties
    - name: tags
      value: object
      description: |
        Resource tags.

UPDATE examples

update

Partially updates a devcenter plan member.

UPDATE azure.dev_center.plan_members
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND planName = '{{ planName }}' --required
AND memberName = '{{ memberName }}' --required
RETURNING
id,
name,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a devcenter plan member

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