controllers

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

Overview

Name	controllers
Type	Resource
Id	azure_extras.devspaces.controllers

Fields

The following fields are returned by SELECT queries:

list_connection_details

Name	Datatype	Description
connectionDetailsList	array	List of Azure Dev Spaces Controller connection details.

get

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
dataPlaneFqdn	string	DNS name for accessing DataPlane services.
hostSuffix	string	DNS suffix for public endpoints running in the Azure Dev Spaces Controller.
location	string	Region where the Azure resource is located.
provisioningState	string	Provisioning state of the Azure Dev Spaces Controller. Known values are: "Succeeded", "Failed", "Canceled", "Updating", "Creating", "Deleting", and "Deleted".
sku	object	Model representing SKU for Azure Dev Spaces Controller. Required.
tags	object	Tags for the Azure resource.
targetContainerHostApiServerFqdn	string	DNS of the target container host's API server.
targetContainerHostCredentialsBase64	string	Credentials of the target container host (base64). Required.
targetContainerHostResourceId	string	Resource ID of the target container host. Required.
type	string	The type of the resource.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
dataPlaneFqdn	string	DNS name for accessing DataPlane services.
hostSuffix	string	DNS suffix for public endpoints running in the Azure Dev Spaces Controller.
location	string	Region where the Azure resource is located.
provisioningState	string	Provisioning state of the Azure Dev Spaces Controller. Known values are: "Succeeded", "Failed", "Canceled", "Updating", "Creating", "Deleting", and "Deleted".
sku	object	Model representing SKU for Azure Dev Spaces Controller. Required.
tags	object	Tags for the Azure resource.
targetContainerHostApiServerFqdn	string	DNS of the target container host's API server.
targetContainerHostCredentialsBase64	string	Credentials of the target container host (base64). Required.
targetContainerHostResourceId	string	Resource ID of the target container host. Required.
type	string	The type of the resource.

list

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
dataPlaneFqdn	string	DNS name for accessing DataPlane services.
hostSuffix	string	DNS suffix for public endpoints running in the Azure Dev Spaces Controller.
location	string	Region where the Azure resource is located.
provisioningState	string	Provisioning state of the Azure Dev Spaces Controller. Known values are: "Succeeded", "Failed", "Canceled", "Updating", "Creating", "Deleting", and "Deleted".
sku	object	Model representing SKU for Azure Dev Spaces Controller. Required.
tags	object	Tags for the Azure resource.
targetContainerHostApiServerFqdn	string	DNS of the target container host's API server.
targetContainerHostCredentialsBase64	string	Credentials of the target container host (base64). Required.
targetContainerHostResourceId	string	Resource ID of the target container host. Required.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_connection_details	select	resource_group_name, name, subscription_id		Lists connection details for an Azure Dev Spaces Controller. Lists connection details for the underlying container resources of an Azure Dev Spaces Controller.
get	select	resource_group_name, name, subscription_id		Gets an Azure Dev Spaces Controller. Gets the properties for an Azure Dev Spaces Controller.
list_by_resource_group	select	resource_group_name, subscription_id		Lists the Azure Dev Spaces Controllers in a resource group. Lists all the Azure Dev Spaces Controllers with their properties in the specified resource group and subscription.
list	select	subscription_id		Lists the Azure Dev Spaces Controllers in a subscription. Lists all the Azure Dev Spaces Controllers with their properties in the subscription.
create	insert	resource_group_name, name, subscription_id, sku, properties		Creates an Azure Dev Spaces Controller. Creates an Azure Dev Spaces Controller with the specified create parameters.
update	update	resource_group_name, name, subscription_id		Updates an Azure Dev Spaces Controller. Updates the properties of an existing Azure Dev Spaces Controller with the specified update parameters.
delete	delete	resource_group_name, name, subscription_id		Deletes an Azure Dev Spaces Controller. 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. Required.
resource_group_name	string	Resource group to which the resource belongs. Required.
subscription_id	string

SELECT examples

list_connection_details

Lists connection details for an Azure Dev Spaces Controller. Lists connection details for the underlying container resources of an Azure Dev Spaces Controller.

SELECT
connectionDetailsList
FROM azure_extras.devspaces.controllers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Gets an Azure Dev Spaces Controller. Gets the properties for an Azure Dev Spaces Controller.

SELECT
id,
name,
dataPlaneFqdn,
hostSuffix,
location,
provisioningState,
sku,
tags,
targetContainerHostApiServerFqdn,
targetContainerHostCredentialsBase64,
targetContainerHostResourceId,
type
FROM azure_extras.devspaces.controllers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

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

SELECT
id,
name,
dataPlaneFqdn,
hostSuffix,
location,
provisioningState,
sku,
tags,
targetContainerHostApiServerFqdn,
targetContainerHostCredentialsBase64,
targetContainerHostResourceId,
type
FROM azure_extras.devspaces.controllers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

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

SELECT
id,
name,
dataPlaneFqdn,
hostSuffix,
location,
provisioningState,
sku,
tags,
targetContainerHostApiServerFqdn,
targetContainerHostCredentialsBase64,
targetContainerHostResourceId,
type
FROM azure_extras.devspaces.controllers
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

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

INSERT INTO azure_extras.devspaces.controllers (
tags,
location,
sku,
properties,
resource_group_name,
name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ sku }}' /* required */,
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
sku,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: controllers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the controllers resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the controllers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the controllers resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Tags for the Azure resource.
  - name: location
    value: "{{ location }}"
    description: |
      Region where the Azure resource is located.
  - name: sku
    description: |
      Model representing SKU for Azure Dev Spaces Controller. Required.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
  - name: properties
    value:
      targetContainerHostResourceId: "{{ targetContainerHostResourceId }}"
      targetContainerHostCredentialsBase64: "{{ targetContainerHostCredentialsBase64 }}"

UPDATE examples

update

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

UPDATE azure_extras.devspaces.controllers
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
sku,
tags,
type;

DELETE examples

delete

Deletes an Azure Dev Spaces Controller. Deletes an existing Azure Dev Spaces Controller.

DELETE FROM azure_extras.devspaces.controllers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;