controllers

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

Overview

Name	controllers
Type	Resource
Id	azure_extras.dev_spaces.controllers

Fields

The following fields are returned by SELECT queries:

get

The request was successful; response contains the Azure Dev Spaces Controller.

Name	Datatype	Description
location	string	Region where the Azure resource is located.
properties	object
sku	object	Model representing SKU for Azure Dev Spaces Controller.
tags	object	Tags for the Azure resource.

list_by_resource_group

The request was successful; response contains the list of Azure Dev Spaces Controllers in the resource group.

Name	Datatype	Description
location	string	Region where the Azure resource is located.
properties	object
sku	object	Model representing SKU for Azure Dev Spaces Controller.
tags	object	Tags for the Azure resource.

list

The request was successful; response contains the list of Azure Dev Spaces Controllers in the subscription.

Name	Datatype	Description
location	string	Region where the Azure resource is located.
properties	object
sku	object	Model representing SKU for Azure Dev Spaces Controller.
tags	object	Tags for the Azure resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, name		Gets the properties for an Azure Dev Spaces Controller.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all the Azure Dev Spaces Controllers with their properties in the specified resource group and subscription.
list	select	subscriptionId		Lists all the Azure Dev Spaces Controllers with their properties in the subscription.
create	insert	subscriptionId, resourceGroupName, name, data__properties, data__sku, data__location		Creates an Azure Dev Spaces Controller with the specified create parameters.
update	update	subscriptionId, resourceGroupName, name		Updates the properties of an existing Azure Dev Spaces Controller with the specified update parameters.
delete	delete	subscriptionId, resourceGroupName, name		Deletes an existing Azure Dev Spaces Controller.

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
name	string	Name of the resource.
resourceGroupName	string	Resource group to which the resource belongs.
subscriptionId	string	Azure subscription ID.

SELECT examples

get

Gets the properties for an Azure Dev Spaces Controller.

SELECT
location,
properties,
sku,
tags
FROM azure_extras.dev_spaces.controllers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
;

list_by_resource_group

Lists all the Azure Dev Spaces Controllers with their properties in the specified resource group and subscription.

SELECT
location,
properties,
sku,
tags
FROM azure_extras.dev_spaces.controllers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list

Lists all the Azure Dev Spaces Controllers with their properties in the subscription.

SELECT
location,
properties,
sku,
tags
FROM azure_extras.dev_spaces.controllers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates an Azure Dev Spaces Controller with the specified create parameters.

INSERT INTO azure_extras.dev_spaces.controllers (
data__tags,
data__location,
data__properties,
data__sku,
subscriptionId,
resourceGroupName,
name
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ sku }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ name }}'
RETURNING
location,
properties,
sku,
tags
;

Manifest

# Description fields are for documentation purposes
- name: controllers
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the controllers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the controllers resource.
    - name: name
      value: string
      description: Required parameter for the controllers resource.
    - name: tags
      value: object
      description: |
        Tags for the Azure resource.
    - name: location
      value: string
      description: |
        Region where the Azure resource is located.
    - name: properties
      value: object
    - name: sku
      value: object
      description: |
        Model representing SKU for Azure Dev Spaces Controller.

UPDATE examples

update

Updates the properties of an existing Azure Dev Spaces Controller with the specified update parameters.

UPDATE azure_extras.dev_spaces.controllers
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
RETURNING
location,
properties,
sku,
tags;

DELETE examples

delete

Deletes an existing Azure Dev Spaces Controller.

DELETE FROM azure_extras.dev_spaces.controllers
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
;