azure_large_instance

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

Overview

Name	azure_large_instance
Type	Resource
Id	azure.large_instance.azure_large_instance

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
azureLargeInstanceId	string	Specifies the Azure Large Instance unique ID.
hardwareProfile	object	Specifies the hardware settings for the Azure Large Instance.
hwRevision	string	Hardware revision of an Azure Large Instance.
location	string	The geo-location where the resource lives. Required.
networkProfile	object	Specifies the network settings for the Azure Large Instance.
osProfile	object	Specifies the operating system settings for the Azure Large Instance.
partnerNodeId	string	ARM ID of another AzureLargeInstance that will share a network with this AzureLargeInstance.
powerState	string	Resource power state. Known values are: "starting", "started", "stopping", "stopped", "restarting", and "unknown".
provisioningState	string	State of provisioning of the AzureLargeInstance. Known values are: "Accepted", "Creating", "Updating", "Failed", "Succeeded", "Deleting", "Migrating", and "Canceled".
proximityPlacementGroup	string	Resource proximity placement group.
storageProfile	object	Specifies the storage settings for the Azure Large Instance disks.
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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
azureLargeInstanceId	string	Specifies the Azure Large Instance unique ID.
hardwareProfile	object	Specifies the hardware settings for the Azure Large Instance.
hwRevision	string	Hardware revision of an Azure Large Instance.
location	string	The geo-location where the resource lives. Required.
networkProfile	object	Specifies the network settings for the Azure Large Instance.
osProfile	object	Specifies the operating system settings for the Azure Large Instance.
partnerNodeId	string	ARM ID of another AzureLargeInstance that will share a network with this AzureLargeInstance.
powerState	string	Resource power state. Known values are: "starting", "started", "stopping", "stopped", "restarting", and "unknown".
provisioningState	string	State of provisioning of the AzureLargeInstance. Known values are: "Accepted", "Creating", "Updating", "Failed", "Succeeded", "Deleting", "Migrating", and "Canceled".
proximityPlacementGroup	string	Resource proximity placement group.
storageProfile	object	Specifies the storage settings for the Azure Large Instance disks.
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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
azureLargeInstanceId	string	Specifies the Azure Large Instance unique ID.
hardwareProfile	object	Specifies the hardware settings for the Azure Large Instance.
hwRevision	string	Hardware revision of an Azure Large Instance.
location	string	The geo-location where the resource lives. Required.
networkProfile	object	Specifies the network settings for the Azure Large Instance.
osProfile	object	Specifies the operating system settings for the Azure Large Instance.
partnerNodeId	string	ARM ID of another AzureLargeInstance that will share a network with this AzureLargeInstance.
powerState	string	Resource power state. Known values are: "starting", "started", "stopping", "stopped", "restarting", and "unknown".
provisioningState	string	State of provisioning of the AzureLargeInstance. Known values are: "Accepted", "Creating", "Updating", "Failed", "Succeeded", "Deleting", "Migrating", and "Canceled".
proximityPlacementGroup	string	Resource proximity placement group.
storageProfile	object	Specifies the storage settings for the Azure Large Instance disks.
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, azure_large_instance_name, subscription_id		Gets an Azure Large Instance for the specified subscription, resource group, and instance name.
list_by_resource_group	select	resource_group_name, subscription_id		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	subscription_id		Gets a list of Azure Large Instances in the specified subscription. The operations returns various properties of each Azure Large Instance.
update	update	resource_group_name, azure_large_instance_name, subscription_id		Patches the Tags field of an Azure Large Instance for the specified subscription, resource group, and instance name.
restart	exec	resource_group_name, azure_large_instance_name, subscription_id		The operation to restart an Azure Large Instance (only for compute instances).
shutdown	exec	resource_group_name, azure_large_instance_name, subscription_id		The operation to shutdown an Azure Large Instance (only for compute instances).
start	exec	resource_group_name, azure_large_instance_name, subscription_id		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
azure_large_instance_name	string	Name of the AzureLargeInstance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

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

SELECT
id,
name,
azureLargeInstanceId,
hardwareProfile,
hwRevision,
location,
networkProfile,
osProfile,
partnerNodeId,
powerState,
provisioningState,
proximityPlacementGroup,
storageProfile,
systemData,
tags,
type
FROM azure.large_instance.azure_large_instance
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND azure_large_instance_name = '{{ azure_large_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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
id,
name,
azureLargeInstanceId,
hardwareProfile,
hwRevision,
location,
networkProfile,
osProfile,
partnerNodeId,
powerState,
provisioningState,
proximityPlacementGroup,
storageProfile,
systemData,
tags,
type
FROM azure.large_instance.azure_large_instance
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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
id,
name,
azureLargeInstanceId,
hardwareProfile,
hwRevision,
location,
networkProfile,
osProfile,
partnerNodeId,
powerState,
provisioningState,
proximityPlacementGroup,
storageProfile,
systemData,
tags,
type
FROM azure.large_instance.azure_large_instance
WHERE subscription_id = '{{ subscription_id }}' -- 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_instance.azure_large_instance
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND azure_large_instance_name = '{{ azure_large_instance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

Lifecycle Methods

restart

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

EXEC azure.large_instance.azure_large_instance.restart 
@resource_group_name='{{ resource_group_name }}' --required, 
@azure_large_instance_name='{{ azure_large_instance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"forceState": "{{ forceState }}"
}'
;

shutdown

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

EXEC azure.large_instance.azure_large_instance.shutdown 
@resource_group_name='{{ resource_group_name }}' --required, 
@azure_large_instance_name='{{ azure_large_instance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

start

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

EXEC azure.large_instance.azure_large_instance.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@azure_large_instance_name='{{ azure_large_instance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;