environment_types

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

Overview

Name	environment_types
Type	Resource
Id	azure.devcenter.environment_types

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.
displayName	string	The display name of the environment type.
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
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

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.
displayName	string	The display name of the environment type.
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
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	resource_group_name, dev_center_name, environment_type_name, subscription_id		Gets an environment type.
list_by_dev_center	select	resource_group_name, dev_center_name, subscription_id	$top	Lists environment types for the devcenter.
create_or_update	insert	resource_group_name, dev_center_name, environment_type_name, subscription_id		Creates or updates an environment type.
update	update	resource_group_name, dev_center_name, environment_type_name, subscription_id		Partially updates an environment type.
create_or_update	replace	resource_group_name, dev_center_name, environment_type_name, subscription_id		Creates or updates an environment type.
delete	delete	resource_group_name, dev_center_name, environment_type_name, subscription_id		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
dev_center_name	string	The name of the devcenter. Required.
environment_type_name	string	The name of the environment type. 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 type.

SELECT
id,
name,
displayName,
provisioningState,
systemData,
tags,
type
FROM azure.devcenter.environment_types
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dev_center_name = '{{ dev_center_name }}' -- required
AND environment_type_name = '{{ environment_type_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_dev_center

Lists environment types for the devcenter.

SELECT
id,
name,
displayName,
provisioningState,
systemData,
tags,
type
FROM azure.devcenter.environment_types
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dev_center_name = '{{ dev_center_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates an environment type.

INSERT INTO azure.devcenter.environment_types (
tags,
properties,
resource_group_name,
dev_center_name,
environment_type_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ dev_center_name }}',
'{{ environment_type_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: environment_types
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the environment_types resource.
  - name: dev_center_name
    value: "{{ dev_center_name }}"
    description: Required parameter for the environment_types resource.
  - name: environment_type_name
    value: "{{ environment_type_name }}"
    description: Required parameter for the environment_types resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the environment_types resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    value:
      displayName: "{{ displayName }}"

UPDATE examples

update

Partially updates an environment type.

UPDATE azure.devcenter.environment_types
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dev_center_name = '{{ dev_center_name }}' --required
AND environment_type_name = '{{ environment_type_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates an environment type.

REPLACE azure.devcenter.environment_types
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dev_center_name = '{{ dev_center_name }}' --required
AND environment_type_name = '{{ environment_type_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes an environment type.

DELETE FROM azure.devcenter.environment_types
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND dev_center_name = '{{ dev_center_name }}' --required
AND environment_type_name = '{{ environment_type_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;