instance_histories

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

Overview

Name	instance_histories
Type	Resource
Id	azure.workload_orchestration.instance_histories

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)
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.
solutionVersion	object	Solution version of instance. Required.
status	object	Deployment Status of instance.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
target	object	Target of instance. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_instance

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)
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.
solutionVersion	object	Solution version of instance. Required.
status	object	Deployment Status of instance.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
target	object	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, instance_history_name, subscription_id		Get InstanceHistory Resource.
list_by_instance	select	resource_group_name, target_name, solution_name, instance_name, subscription_id		List InstanceHistory Resources.

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_history_name	string	Name of the instance history. Required.
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 InstanceHistory Resource.

SELECT
id,
name,
activeState,
eTag,
extendedLocation,
provisioningState,
reconciliationPolicy,
solutionScope,
solutionVersion,
status,
systemData,
target,
type
FROM azure.workload_orchestration.instance_histories
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 instance_history_name = '{{ instance_history_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_instance

List InstanceHistory Resources.

SELECT
id,
name,
activeState,
eTag,
extendedLocation,
provisioningState,
reconciliationPolicy,
solutionScope,
solutionVersion,
status,
systemData,
target,
type
FROM azure.workload_orchestration.instance_histories
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
;