all_environments

Creates, updates, deletes, gets or lists an all_environments resource.

Overview

Name	all_environments
Type	Resource
Id	azure.developer_devcenter.all_environments

Fields

The following fields are returned by SELECT queries:

list_all_environments

Name	Datatype	Description
name	string	Environment name. Required.
catalogName	string	Name of the catalog. Required.
environmentDefinitionName	string	Name of the environment definition. Required.
environmentType	string	Environment type. Required.
error	object	Provisioning error details. Populated only for error states.
parameters	object	Parameters object for the environment.
provisioningState	string	The provisioning state of the environment. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Accepted", "Deleting", "Updating", "Preparing", "Running", "Syncing", "MovingResources", "TransientFailure", and "StorageProvisioningFailed". (Succeeded, Failed, Canceled, Creating, Accepted, Deleting, Updating, Preparing, Running, Syncing, MovingResources, TransientFailure, StorageProvisioningFailed)
resourceGroupId	string	The identifier of the resource group containing the environment's resources.
user	string	The AAD object id of the owner of this Environment.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_all_environments	select	project_name, endpoint		Lists the environments for a project.

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
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
project_name	string	The DevCenter Project upon which to execute operations. Required.

SELECT examples

list_all_environments

Lists the environments for a project.

SELECT
name,
catalogName,
environmentDefinitionName,
environmentType,
error,
parameters,
provisioningState,
resourceGroupId,
user
FROM azure.developer_devcenter.all_environments
WHERE project_name = '{{ project_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;