environment_types

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

Overview

Name	environment_types
Type	Resource
Id	azure.dev_center.environment_types

Fields

The following fields are returned by SELECT queries:

get

OK. The request has succeeded.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	Properties of an environment type.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_dev_center

OK. The request has succeeded.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	Properties of an environment type.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, devCenterName, environmentTypeName		Gets an environment type.
list_by_dev_center	select	subscriptionId, resourceGroupName, devCenterName	$top	Lists environment types for the devcenter.
create_or_update	insert	subscriptionId, resourceGroupName, devCenterName, environmentTypeName		Creates or updates an environment type.
update	update	subscriptionId, resourceGroupName, devCenterName, environmentTypeName		Partially updates an environment type.
delete	delete	subscriptionId, resourceGroupName, devCenterName, environmentTypeName		Deletes an environment type.

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
devCenterName	string	The name of the devcenter.
environmentTypeName	string	The name of the environment type.
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

Gets an environment type.

SELECT
id,
name,
properties,
systemData,
tags,
type
FROM azure.dev_center.environment_types
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND devCenterName = '{{ devCenterName }}' -- required
AND environmentTypeName = '{{ environmentTypeName }}' -- required
;

list_by_dev_center

Lists environment types for the devcenter.

SELECT
id,
name,
properties,
systemData,
tags,
type
FROM azure.dev_center.environment_types
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND devCenterName = '{{ devCenterName }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates an environment type.

INSERT INTO azure.dev_center.environment_types (
data__properties,
data__tags,
subscriptionId,
resourceGroupName,
devCenterName,
environmentTypeName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ devCenterName }}',
'{{ environmentTypeName }}'
RETURNING
id,
name,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: environment_types
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the environment_types resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the environment_types resource.
    - name: devCenterName
      value: string
      description: Required parameter for the environment_types resource.
    - name: environmentTypeName
      value: string
      description: Required parameter for the environment_types resource.
    - name: properties
      value: object
      description: |
        Properties of an environment type.
    - name: tags
      value: object
      description: |
        Resource tags.

UPDATE examples

update

Partially updates an environment type.

UPDATE azure.dev_center.environment_types
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND devCenterName = '{{ devCenterName }}' --required
AND environmentTypeName = '{{ environmentTypeName }}' --required
RETURNING
id,
name,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes an environment type.

DELETE FROM azure.dev_center.environment_types
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND devCenterName = '{{ devCenterName }}' --required
AND environmentTypeName = '{{ environmentTypeName }}' --required
;