environment_definitions

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

Overview

Name	environment_definitions
Type	Resource
Id	azure.dev_center.environment_definitions

Fields

The following fields are returned by SELECT queries:

get_by_project_catalog

OK. The request has succeeded.

Name	Datatype	Description
properties	object	Environment definition properties.

get

OK. The request has succeeded.

Name	Datatype	Description
properties	object	Environment definition properties.

list_by_project_catalog

OK. The request has succeeded.

Name	Datatype	Description
properties	object	Environment definition properties.

list_by_catalog

OK. The request has succeeded.

Name	Datatype	Description
properties	object	Environment definition properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_project_catalog	select			Gets an environment definition from the catalog.
get	select			Gets an environment definition from the catalog.
list_by_project_catalog	select	subscriptionId, resourceGroupName, projectName, catalogName		Lists the environment definitions in this project catalog.
list_by_catalog	select	subscriptionId, resourceGroupName, devCenterName, catalogName	$top	List environment definitions in the catalog.

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
catalogName	string	The name of the Catalog.
devCenterName	string	The name of the devcenter.
projectName	string	The name of the project.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
$top	integer (int32)	The maximum number of resources to return from the operation. Example: '$top=10'.

SELECT examples

get_by_project_catalog

Gets an environment definition from the catalog.

SELECT
properties
FROM azure.dev_center.environment_definitions
;

get

Gets an environment definition from the catalog.

SELECT
properties
FROM azure.dev_center.environment_definitions
;

list_by_project_catalog

Lists the environment definitions in this project catalog.

SELECT
properties
FROM azure.dev_center.environment_definitions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND projectName = '{{ projectName }}' -- required
AND catalogName = '{{ catalogName }}' -- required
;

list_by_catalog

List environment definitions in the catalog.

SELECT
properties
FROM azure.dev_center.environment_definitions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND devCenterName = '{{ devCenterName }}' -- required
AND catalogName = '{{ catalogName }}' -- required
AND $top = '{{ $top }}'
;