environment_definitions

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

Overview

Name	environment_definitions
Type	Resource
Id	azure.devcenter.environment_definitions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
description	string	A short description of the environment definition.
parameters	array	Input parameters passed to an environment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
templatePath	string	Path to the Environment Definition entrypoint file.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
validationStatus	string	Validation status for the environment definition. Known values are: "Unknown", "Pending", "Succeeded", and "Failed".

get_by_project_catalog

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
description	string	A short description of the environment definition.
parameters	array	Input parameters passed to an environment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
templatePath	string	Path to the Environment Definition entrypoint file.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
validationStatus	string	Validation status for the environment definition. Known values are: "Unknown", "Pending", "Succeeded", and "Failed".

list_by_project_catalog

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
description	string	A short description of the environment definition.
parameters	array	Input parameters passed to an environment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
templatePath	string	Path to the Environment Definition entrypoint file.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
validationStatus	string	Validation status for the environment definition. Known values are: "Unknown", "Pending", "Succeeded", and "Failed".

list_by_catalog

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
description	string	A short description of the environment definition.
parameters	array	Input parameters passed to an environment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
templatePath	string	Path to the Environment Definition entrypoint file.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
validationStatus	string	Validation status for the environment definition. Known values are: "Unknown", "Pending", "Succeeded", and "Failed".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, dev_center_name, catalog_name, environment_definition_name, subscription_id		Gets an environment definition from the catalog.
get_by_project_catalog	select	resource_group_name, project_name, catalog_name, environment_definition_name, subscription_id		Gets an environment definition from the catalog.
list_by_project_catalog	select	resource_group_name, project_name, catalog_name, subscription_id		Lists the environment definitions in this project catalog.
list_by_catalog	select	resource_group_name, dev_center_name, catalog_name, subscription_id	$top	List environment definitions in the catalog.
get_error_details	exec	resource_group_name, dev_center_name, catalog_name, environment_definition_name, subscription_id		Gets Environment Definition error details.

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.
dev_center_name	string	The name of the devcenter. Required.
environment_definition_name	string	The name of the Environment Definition. Required.
project_name	string	The name of the project. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Gets an environment definition from the catalog.

SELECT
id,
name,
description,
parameters,
systemData,
templatePath,
type,
validationStatus
FROM azure.devcenter.environment_definitions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dev_center_name = '{{ dev_center_name }}' -- required
AND catalog_name = '{{ catalog_name }}' -- required
AND environment_definition_name = '{{ environment_definition_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_by_project_catalog

Gets an environment definition from the catalog.

SELECT
id,
name,
description,
parameters,
systemData,
templatePath,
type,
validationStatus
FROM azure.devcenter.environment_definitions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND catalog_name = '{{ catalog_name }}' -- required
AND environment_definition_name = '{{ environment_definition_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_project_catalog

Lists the environment definitions in this project catalog.

SELECT
id,
name,
description,
parameters,
systemData,
templatePath,
type,
validationStatus
FROM azure.devcenter.environment_definitions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND catalog_name = '{{ catalog_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_catalog

List environment definitions in the catalog.

SELECT
id,
name,
description,
parameters,
systemData,
templatePath,
type,
validationStatus
FROM azure.devcenter.environment_definitions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dev_center_name = '{{ dev_center_name }}' -- required
AND catalog_name = '{{ catalog_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

Lifecycle Methods

get_error_details

Gets Environment Definition error details.

EXEC azure.devcenter.environment_definitions.get_error_details 
@resource_group_name='{{ resource_group_name }}' --required, 
@dev_center_name='{{ dev_center_name }}' --required, 
@catalog_name='{{ catalog_name }}' --required, 
@environment_definition_name='{{ environment_definition_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;