instances

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

Overview

Name	instances
Type	Resource
Id	azure.workload_orchestration.instances

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.
activeState	string	State of instance. Known values are: "active" and "inactive". (active, inactive)
deploymentTimestampEpoch	integer	Deployment timestamp of instance.
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.
extendedLocation	object	:vartype extended_location: ~azure.mgmt.workloadorchestration.models.ExtendedLocation
provisioningState	string	Provisioning state of resource. Known values are: "Succeeded", "Failed", "Canceled", "Initialized", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, Initialized, InProgress, Deleting)
reconciliationPolicy	object	Reconciliation policy of instance.
solutionScope	string	Scope of instance.
solutionVersionId	string	Solution version of instance. Required.
status	object	Status of instance.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetId	string	Target of instance. Required.
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.
activeState	string	State of instance. Known values are: "active" and "inactive". (active, inactive)
deploymentTimestampEpoch	integer	Deployment timestamp of instance.
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.
extendedLocation	object	:vartype extended_location: ~azure.mgmt.workloadorchestration.models.ExtendedLocation
provisioningState	string	Provisioning state of resource. Known values are: "Succeeded", "Failed", "Canceled", "Initialized", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, Initialized, InProgress, Deleting)
reconciliationPolicy	object	Reconciliation policy of instance.
solutionScope	string	Scope of instance.
solutionVersionId	string	Solution version of instance. Required.
status	object	Status of instance.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetId	string	Target of instance. Required.
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, instance_name, subscription_id		Get Instance Resource.
list_by_solution	select	resource_group_name, target_name, solution_name, subscription_id		List Instance Resources.
create_or_update	insert	resource_group_name, target_name, solution_name, instance_name, subscription_id		Create or update Instance Resource.
update	update	resource_group_name, target_name, solution_name, instance_name, subscription_id		Update an Instance Resource.
create_or_update	replace	resource_group_name, target_name, solution_name, instance_name, subscription_id		Create or update Instance Resource.
delete	delete	resource_group_name, target_name, solution_name, instance_name, subscription_id		Delete Instance 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
instance_name	string	Name of the instance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
solution_name	string	Name of the solution. Required.
subscription_id	string
target_name	string	Name of the target. Required.

SELECT examples

get

Get Instance Resource.

SELECT
id,
name,
activeState,
deploymentTimestampEpoch,
eTag,
extendedLocation,
provisioningState,
reconciliationPolicy,
solutionScope,
solutionVersionId,
status,
systemData,
targetId,
type
FROM azure.workload_orchestration.instances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND target_name = '{{ target_name }}' -- required
AND solution_name = '{{ solution_name }}' -- required
AND instance_name = '{{ instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_solution

List Instance Resources.

SELECT
id,
name,
activeState,
deploymentTimestampEpoch,
eTag,
extendedLocation,
provisioningState,
reconciliationPolicy,
solutionScope,
solutionVersionId,
status,
systemData,
targetId,
type
FROM azure.workload_orchestration.instances
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 Instance Resource.

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

Manifest

# Description fields are for documentation purposes
- name: instances
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the instances resource.
  - name: target_name
    value: "{{ target_name }}"
    description: Required parameter for the instances resource.
  - name: solution_name
    value: "{{ solution_name }}"
    description: Required parameter for the instances resource.
  - name: instance_name
    value: "{{ instance_name }}"
    description: Required parameter for the instances resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the instances resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      solutionVersionId: "{{ solutionVersionId }}"
      targetId: "{{ targetId }}"
      activeState: "{{ activeState }}"
      reconciliationPolicy:
        state: "{{ state }}"
        interval: "{{ interval }}"
      solutionScope: "{{ solutionScope }}"
      status:
        lastModified: "{{ lastModified }}"
        deployed: {{ deployed }}
        expectedRunningJobId: {{ expectedRunningJobId }}
        runningJobId: {{ runningJobId }}
        status: "{{ status }}"
        statusDetails: "{{ statusDetails }}"
        generation: {{ generation }}
        targetStatuses:
          - name: "{{ name }}"
            status: "{{ status }}"
            componentStatuses: "{{ componentStatuses }}"
      deploymentTimestampEpoch: {{ deploymentTimestampEpoch }}
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      :vartype extended_location: ~azure.mgmt.workloadorchestration.models.ExtendedLocation
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update

Update an Instance Resource.

UPDATE azure.workload_orchestration.instances
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 instance_name = '{{ instance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
extendedLocation,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create or update Instance Resource.

REPLACE azure.workload_orchestration.instances
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 instance_name = '{{ instance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
extendedLocation,
properties,
systemData,
type;

DELETE examples

delete

Delete Instance Resource.

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