azure_large_instances

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

Overview

Name	azure_large_instances
Type	Resource
Id	azure.large_instances.azure_large_instances

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_resource_group

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_subscription

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, azureLargeInstanceName		Gets an Azure Large Instance for the specified subscription, resource group, and instance name.
list_by_resource_group	select	subscriptionId, resourceGroupName		Gets a list of Azure Large Instances in the specified subscription and resource group. The operations returns various properties of each Azure Large Instance.
list_by_subscription	select	subscriptionId		Gets a list of Azure Large Instances in the specified subscription. The operations returns various properties of each Azure Large Instance.
update	update	subscriptionId, resourceGroupName, azureLargeInstanceName		Patches the Tags field of an Azure Large Instance for the specified subscription, resource group, and instance name.
restart	exec	subscriptionId, resourceGroupName, azureLargeInstanceName		The operation to restart an Azure Large Instance (only for compute instances)
shutdown	exec	subscriptionId, resourceGroupName, azureLargeInstanceName		The operation to shutdown an Azure Large Instance (only for compute instances)
start	exec	subscriptionId, resourceGroupName, azureLargeInstanceName		The operation to start an Azure Large Instance (only for compute instances)

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
azureLargeInstanceName	string	Name of the AzureLargeInstance.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets an Azure Large Instance for the specified subscription, resource group,
and instance name.

SELECT
location,
properties,
tags
FROM azure.large_instances.azure_large_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND azureLargeInstanceName = '{{ azureLargeInstanceName }}' -- required
;

list_by_resource_group

Gets a list of Azure Large Instances in the specified subscription and resource
group. The operations returns various properties of each Azure Large Instance.

SELECT
location,
properties,
tags
FROM azure.large_instances.azure_large_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Gets a list of Azure Large Instances in the specified subscription. The
operations returns various properties of each Azure Large Instance.

SELECT
location,
properties,
tags
FROM azure.large_instances.azure_large_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

UPDATE examples

update

Patches the Tags field of an Azure Large Instance for the specified
subscription, resource group, and instance name.

UPDATE azure.large_instances.azure_large_instances
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND azureLargeInstanceName = '{{ azureLargeInstanceName }}' --required
RETURNING
location,
properties,
tags;

Lifecycle Methods

restart

The operation to restart an Azure Large Instance (only for compute instances)

EXEC azure.large_instances.azure_large_instances.restart 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@azureLargeInstanceName='{{ azureLargeInstanceName }}' --required 
@@json=
'{
"forceState": "{{ forceState }}"
}'
;

shutdown

The operation to shutdown an Azure Large Instance (only for compute instances)

EXEC azure.large_instances.azure_large_instances.shutdown 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@azureLargeInstanceName='{{ azureLargeInstanceName }}' --required
;

start

The operation to start an Azure Large Instance (only for compute instances)

EXEC azure.large_instances.azure_large_instances.start 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@azureLargeInstanceName='{{ azureLargeInstanceName }}' --required
;