solution_templates

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

Overview

Name	solution_templates
Type	Resource
Id	azure.workload_orchestration.solution_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.
capabilities	array	List of capabilities. Required.
description	string	Description of Solution 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.
enableExternalValidation	boolean	Flag to enable external validation.
latestVersion	string	Latest solution 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)
state	string	State of resource. Known values are: "active" and "inactive". (active, inactive)
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.
capabilities	array	List of capabilities. Required.
description	string	Description of Solution 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.
enableExternalValidation	boolean	Flag to enable external validation.
latestVersion	string	Latest solution 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)
state	string	State of resource. Known values are: "active" and "inactive". (active, inactive)
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.
capabilities	array	List of capabilities. Required.
description	string	Description of Solution 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.
enableExternalValidation	boolean	Flag to enable external validation.
latestVersion	string	Latest solution 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)
state	string	State of resource. Known values are: "active" and "inactive". (active, inactive)
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, solution_template_name, subscription_id		Get a Solution 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, solution_template_name, subscription_id, location		Create or update a Solution Template Resource.
update	update	resource_group_name, solution_template_name, subscription_id, location		update a Solution Template Resource.
create_or_update	replace	resource_group_name, solution_template_name, subscription_id, location		Create or update a Solution Template Resource.
delete	delete	resource_group_name, solution_template_name, subscription_id		Delete a Solution Template Resource.
create_version	exec	resource_group_name, solution_template_name, subscription_id, solutionTemplateVersion		Create a Solution Template Version Resource.
remove_version	exec	resource_group_name, solution_template_name, subscription_id, version		Remove Solution 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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
solution_template_name	string	The name of the SolutionTemplate. Required.
subscription_id	string

SELECT examples

get

Get a Solution Template Resource.

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

list_by_resource_group

List by specified resource group.

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

list_by_subscription

List by subscription.

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

INSERT examples

create_or_update

Create or update a Solution Template Resource.

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

Manifest

# Description fields are for documentation purposes
- name: solution_templates
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the solution_templates resource.
  - name: solution_template_name
    value: "{{ solution_template_name }}"
    description: Required parameter for the solution_templates resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the solution_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 }}"
      capabilities:
        - "{{ capabilities }}"
      latestVersion: "{{ latestVersion }}"
      state: "{{ state }}"
      enableExternalValidation: {{ enableExternalValidation }}
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

update a Solution Template Resource.

UPDATE azure.workload_orchestration.solution_templates
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND solution_template_name = '{{ solution_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 Solution Template Resource.

REPLACE azure.workload_orchestration.solution_templates
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND solution_template_name = '{{ solution_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 Solution Template Resource.

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

Lifecycle Methods

create_version

Create a Solution Template Version Resource.

EXEC azure.workload_orchestration.solution_templates.create_version 
@resource_group_name='{{ resource_group_name }}' --required, 
@solution_template_name='{{ solution_template_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"updateType": "{{ updateType }}", 
"version": "{{ version }}", 
"solutionTemplateVersion": "{{ solutionTemplateVersion }}"
}'
;

remove_version

Remove Solution Template Version Resource.

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