config_templates

Creates, updates, deletes, gets or lists a config_templates resource.

Overview

Name	config_templates
Type	Resource
Id	azure.workload_orchestration.config_templates

Fields

The following fields are returned by SELECT queries:

get

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.
description	string	Description of config template. Required.
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
latestVersion	string	Latest config template version.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of resource. Known values are: "Succeeded", "Failed", "Canceled", "Initialized", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, Initialized, InProgress, Deleting)
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_resource_group

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.
description	string	Description of config template. Required.
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
latestVersion	string	Latest config template version.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of resource. Known values are: "Succeeded", "Failed", "Canceled", "Initialized", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, Initialized, InProgress, Deleting)
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_subscription

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.
description	string	Description of config template. Required.
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
latestVersion	string	Latest config template version.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of resource. Known values are: "Succeeded", "Failed", "Canceled", "Initialized", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, Initialized, InProgress, Deleting)
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, config_template_name, subscription_id		Get a Config Template Resource.
list_by_resource_group	select	resource_group_name, subscription_id		List by specified resource group.
list_by_subscription	select	subscription_id		List by subscription.
create_or_update	insert	resource_group_name, config_template_name, subscription_id, location		Create or update a Config Template Resource.
update	update	resource_group_name, config_template_name, subscription_id, location		update a Config Template Resource.
create_or_update	replace	resource_group_name, config_template_name, subscription_id, location		Create or update a Config Template Resource.
delete	delete	resource_group_name, config_template_name, subscription_id		Delete a Config Template Resource.
create_version	exec	resource_group_name, config_template_name, subscription_id, configTemplateVersion		Create or update a Config Template Version Resource with the specified UpdateType.
remove_version	exec	resource_group_name, config_template_name, subscription_id, version		Remove Config Template Version Resource.

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
config_template_name	string	The name of the ConfigTemplate. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a Config Template Resource.

SELECT
id,
name,
description,
eTag,
latestVersion,
location,
provisioningState,
systemData,
tags,
type
FROM azure.workload_orchestration.config_templates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND config_template_name = '{{ config_template_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List by specified resource group.

SELECT
id,
name,
description,
eTag,
latestVersion,
location,
provisioningState,
systemData,
tags,
type
FROM azure.workload_orchestration.config_templates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List by subscription.

SELECT
id,
name,
description,
eTag,
latestVersion,
location,
provisioningState,
systemData,
tags,
type
FROM azure.workload_orchestration.config_templates
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a Config Template Resource.

INSERT INTO azure.workload_orchestration.config_templates (
tags,
location,
properties,
resource_group_name,
config_template_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ config_template_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
eTag,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: config_templates
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the config_templates resource.
  - name: config_template_name
    value: "{{ config_template_name }}"
    description: Required parameter for the config_templates resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the config_templates resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      description: "{{ description }}"
      latestVersion: "{{ latestVersion }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

update a Config Template Resource.

UPDATE azure.workload_orchestration.config_templates
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND config_template_name = '{{ config_template_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
eTag,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update a Config Template Resource.

REPLACE azure.workload_orchestration.config_templates
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND config_template_name = '{{ config_template_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
eTag,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a Config Template Resource.

DELETE FROM azure.workload_orchestration.config_templates
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND config_template_name = '{{ config_template_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

create_version

Create or update a Config Template Version Resource with the specified UpdateType.

EXEC azure.workload_orchestration.config_templates.create_version 
@resource_group_name='{{ resource_group_name }}' --required, 
@config_template_name='{{ config_template_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"updateType": "{{ updateType }}", 
"version": "{{ version }}", 
"configTemplateVersion": "{{ configTemplateVersion }}"
}'
;

remove_version

Remove Config Template Version Resource.

EXEC azure.workload_orchestration.config_templates.remove_version 
@resource_group_name='{{ resource_group_name }}' --required, 
@config_template_name='{{ config_template_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"version": "{{ version }}"
}'
;