environment_definitions

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

Overview

Name	environment_definitions
Type	Resource
Id	azure.developer_devcenter.environment_definitions

Fields

The following fields are returned by SELECT queries:

get_environment_definition

Name	Datatype	Description
id	string	The ID of the environment definition. Required.
name	string	Name of the environment definition. Required.
catalogName	string	Name of the catalog. Required.
description	string	A short description of the environment definition.
parameters	array	Input parameters passed to an environment.
parametersSchema	string	JSON schema defining the parameters object passed to an environment.
templatePath	string	Path to the Environment Definition entrypoint file.

list_environment_definitions_by_catalog

Name	Datatype	Description
id	string	The ID of the environment definition. Required.
name	string	Name of the environment definition. Required.
catalogName	string	Name of the catalog. Required.
description	string	A short description of the environment definition.
parameters	array	Input parameters passed to an environment.
parametersSchema	string	JSON schema defining the parameters object passed to an environment.
templatePath	string	Path to the Environment Definition entrypoint file.

list_environment_definitions

Name	Datatype	Description
id	string	The ID of the environment definition. Required.
name	string	Name of the environment definition. Required.
catalogName	string	Name of the catalog. Required.
description	string	A short description of the environment definition.
parameters	array	Input parameters passed to an environment.
parametersSchema	string	JSON schema defining the parameters object passed to an environment.
templatePath	string	Path to the Environment Definition entrypoint file.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_environment_definition	select	project_name, catalog_name, definition_name, endpoint		Get an environment definition from a catalog.
list_environment_definitions_by_catalog	select	project_name, catalog_name, endpoint		Lists all environment definitions available within a catalog.
list_environment_definitions	select	project_name, endpoint		Lists all environment definitions available 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
catalog_name	string	The name of the catalog. Required.
definition_name	string	Name of the environment definition. Required.
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

get_environment_definition

Get an environment definition from a catalog.

SELECT
id,
name,
catalogName,
description,
parameters,
parametersSchema,
templatePath
FROM azure.developer_devcenter.environment_definitions
WHERE project_name = '{{ project_name }}' -- required
AND catalog_name = '{{ catalog_name }}' -- required
AND definition_name = '{{ definition_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_environment_definitions_by_catalog

Lists all environment definitions available within a catalog.

SELECT
id,
name,
catalogName,
description,
parameters,
parametersSchema,
templatePath
FROM azure.developer_devcenter.environment_definitions
WHERE project_name = '{{ project_name }}' -- required
AND catalog_name = '{{ catalog_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_environment_definitions

Lists all environment definitions available for a project.

SELECT
id,
name,
catalogName,
description,
parameters,
parametersSchema,
templatePath
FROM azure.developer_devcenter.environment_definitions
WHERE project_name = '{{ project_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;