solution_versions

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

Overview

Name	solution_versions
Type	Resource
Id	azure.workload_orchestration.solution_versions

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.
actionType	string	The type of the latest action performed on this solution version. Known values are: "deploy", "staging", and "externalValidation". (deploy, staging, externalValidation)
configuration	string	Resolved configuration values.
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.
errorDetails	object	Error Details if any failure is there.
extendedLocation	object	:vartype extended_location: ~azure.mgmt.workloadorchestration.models.ExtendedLocation
externalValidationId	string	External validation id.
latestActionTrackingUri	string	The URI for tracking the latest action performed on this solution version.
provisioningState	string	Provisioning state of resource. Known values are: "Succeeded", "Failed", "Canceled", "Initialized", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, Initialized, InProgress, Deleting)
reviewId	string	Review id of resolved config for this solution version.
revision	integer	Revision number of resolved config for this solution version.
solutionDependencies	array	Solution Dependency Context.
solutionInstanceName	string	Solution instance name.
solutionTemplateVersionId	string	Solution Template Version Id.
specification	object	App components spec. Required.
state	string	State of solution instance. Known values are: "InReview", "UpgradeInReview", "ReadyToDeploy", "ReadyToUpgrade", "Deploying", "Deployed", "Failed", "Undeployed", "PendingExternalValidation", "ExternalValidationFailed", and "Staging". (InReview, UpgradeInReview, ReadyToDeploy, ReadyToUpgrade, Deploying, Deployed, Failed, Undeployed, PendingExternalValidation, ExternalValidationFailed, Staging)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetDisplayName	string	Name of applicable target's display name.
targetLevelConfiguration	string	Configuration on the line level across all solution template versions.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_solution

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.
actionType	string	The type of the latest action performed on this solution version. Known values are: "deploy", "staging", and "externalValidation". (deploy, staging, externalValidation)
configuration	string	Resolved configuration values.
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.
errorDetails	object	Error Details if any failure is there.
extendedLocation	object	:vartype extended_location: ~azure.mgmt.workloadorchestration.models.ExtendedLocation
externalValidationId	string	External validation id.
latestActionTrackingUri	string	The URI for tracking the latest action performed on this solution version.
provisioningState	string	Provisioning state of resource. Known values are: "Succeeded", "Failed", "Canceled", "Initialized", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, Initialized, InProgress, Deleting)
reviewId	string	Review id of resolved config for this solution version.
revision	integer	Revision number of resolved config for this solution version.
solutionDependencies	array	Solution Dependency Context.
solutionInstanceName	string	Solution instance name.
solutionTemplateVersionId	string	Solution Template Version Id.
specification	object	App components spec. Required.
state	string	State of solution instance. Known values are: "InReview", "UpgradeInReview", "ReadyToDeploy", "ReadyToUpgrade", "Deploying", "Deployed", "Failed", "Undeployed", "PendingExternalValidation", "ExternalValidationFailed", and "Staging". (InReview, UpgradeInReview, ReadyToDeploy, ReadyToUpgrade, Deploying, Deployed, Failed, Undeployed, PendingExternalValidation, ExternalValidationFailed, Staging)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetDisplayName	string	Name of applicable target's display name.
targetLevelConfiguration	string	Configuration on the line level across all solution template versions.
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, target_name, solution_name, solution_version_name, subscription_id		Get a Solution Version Resource.
list_by_solution	select	resource_group_name, target_name, solution_name, subscription_id		List Solution Version Resources.
create_or_update	insert	resource_group_name, target_name, solution_name, solution_version_name, subscription_id		Create or update a Solution Version Resource.
update	update	resource_group_name, target_name, solution_name, solution_version_name, subscription_id		Update a Solution Version Resource.
create_or_update	replace	resource_group_name, target_name, solution_name, solution_version_name, subscription_id		Create or update a Solution Version Resource.
delete	delete	resource_group_name, target_name, solution_name, solution_version_name, subscription_id		Delete a Solution 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_name	string	Name of the solution. Required.
solution_version_name	string	Name of the solution version. Required.
subscription_id	string
target_name	string	Name of the target. Required.

SELECT examples

get

Get a Solution Version Resource.

SELECT
id,
name,
actionType,
configuration,
eTag,
errorDetails,
extendedLocation,
externalValidationId,
latestActionTrackingUri,
provisioningState,
reviewId,
revision,
solutionDependencies,
solutionInstanceName,
solutionTemplateVersionId,
specification,
state,
systemData,
targetDisplayName,
targetLevelConfiguration,
type
FROM azure.workload_orchestration.solution_versions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND target_name = '{{ target_name }}' -- required
AND solution_name = '{{ solution_name }}' -- required
AND solution_version_name = '{{ solution_version_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_solution

List Solution Version Resources.

SELECT
id,
name,
actionType,
configuration,
eTag,
errorDetails,
extendedLocation,
externalValidationId,
latestActionTrackingUri,
provisioningState,
reviewId,
revision,
solutionDependencies,
solutionInstanceName,
solutionTemplateVersionId,
specification,
state,
systemData,
targetDisplayName,
targetLevelConfiguration,
type
FROM azure.workload_orchestration.solution_versions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND target_name = '{{ target_name }}' -- required
AND solution_name = '{{ solution_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a Solution Version Resource.

INSERT INTO azure.workload_orchestration.solution_versions (
properties,
extendedLocation,
resource_group_name,
target_name,
solution_name,
solution_version_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ target_name }}',
'{{ solution_name }}',
'{{ solution_version_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
eTag,
extendedLocation,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: solution_versions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the solution_versions resource.
  - name: target_name
    value: "{{ target_name }}"
    description: Required parameter for the solution_versions resource.
  - name: solution_name
    value: "{{ solution_name }}"
    description: Required parameter for the solution_versions resource.
  - name: solution_version_name
    value: "{{ solution_version_name }}"
    description: Required parameter for the solution_versions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the solution_versions resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      solutionTemplateVersionId: "{{ solutionTemplateVersionId }}"
      revision: {{ revision }}
      targetDisplayName: "{{ targetDisplayName }}"
      configuration: "{{ configuration }}"
      targetLevelConfiguration: "{{ targetLevelConfiguration }}"
      specification: "{{ specification }}"
      reviewId: "{{ reviewId }}"
      externalValidationId: "{{ externalValidationId }}"
      state: "{{ state }}"
      solutionInstanceName: "{{ solutionInstanceName }}"
      solutionDependencies:
        - solutionVersionId: "{{ solutionVersionId }}"
          solutionInstanceName: "{{ solutionInstanceName }}"
          solutionTemplateVersionId: "{{ solutionTemplateVersionId }}"
          targetId: "{{ targetId }}"
          dependencies: "{{ dependencies }}"
      errorDetails:
        code: "{{ code }}"
        message: "{{ message }}"
        target: "{{ target }}"
        details:
          - code: "{{ code }}"
            message: "{{ message }}"
            target: "{{ target }}"
            details: "{{ details }}"
            additionalInfo: "{{ additionalInfo }}"
        additionalInfo:
          - type: "{{ type }}"
            info: "{{ info }}"
      latestActionTrackingUri: "{{ latestActionTrackingUri }}"
      actionType: "{{ actionType }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      :vartype extended_location: ~azure.mgmt.workloadorchestration.models.ExtendedLocation
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update

Update a Solution Version Resource.

UPDATE azure.workload_orchestration.solution_versions
SET 
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND target_name = '{{ target_name }}' --required
AND solution_name = '{{ solution_name }}' --required
AND solution_version_name = '{{ solution_version_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
extendedLocation,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create or update a Solution Version Resource.

REPLACE azure.workload_orchestration.solution_versions
SET 
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND target_name = '{{ target_name }}' --required
AND solution_name = '{{ solution_name }}' --required
AND solution_version_name = '{{ solution_version_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
extendedLocation,
properties,
systemData,
type;

DELETE examples

delete

Delete a Solution Version Resource.

DELETE FROM azure.workload_orchestration.solution_versions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND target_name = '{{ target_name }}' --required
AND solution_name = '{{ solution_name }}' --required
AND solution_version_name = '{{ solution_version_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;