azure_large_storage_instance

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

Overview

Name	azure_large_storage_instance
Type	Resource
Id	azure.large_instance.azure_large_storage_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.
azureLargeStorageInstanceUniqueIdentifier	string	Specifies the AzureLargeStorageInstance unique ID.
location	string	The geo-location where the resource lives. Required.
storageProperties	object	Specifies the storage properties for the AzureLargeStorage instance.
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.
azureLargeStorageInstanceUniqueIdentifier	string	Specifies the AzureLargeStorageInstance unique ID.
location	string	The geo-location where the resource lives. Required.
storageProperties	object	Specifies the storage properties for the AzureLargeStorage instance.
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.
azureLargeStorageInstanceUniqueIdentifier	string	Specifies the AzureLargeStorageInstance unique ID.
location	string	The geo-location where the resource lives. Required.
storageProperties	object	Specifies the storage properties for the AzureLargeStorage instance.
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_storage_instance_name, subscription_id		Gets an Azure Large Storage instance for the specified subscription, resource group, and instance name.
list_by_resource_group	select	resource_group_name, subscription_id		Gets a list of AzureLargeStorageInstances in the specified subscription and resource group. The operations returns various properties of each Azure LargeStorage instance.
list_by_subscription	select	subscription_id		Gets a list of AzureLargeStorageInstances in the specified subscription. The operations returns various properties of each Azure LargeStorage instance.
update	update	resource_group_name, azure_large_storage_instance_name, subscription_id		Patches the Tags field of a Azure Large Storage Instance for the specified subscription, resource group, and instance name.

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_storage_instance_name	string	Name of the AzureLargeStorageInstance. 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 Storage instance for the specified subscription, resource group, and instance name.

SELECT
id,
name,
azureLargeStorageInstanceUniqueIdentifier,
location,
storageProperties,
systemData,
tags,
type
FROM azure.large_instance.azure_large_storage_instance
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND azure_large_storage_instance_name = '{{ azure_large_storage_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets a list of AzureLargeStorageInstances in the specified subscription and resource group. The operations returns various properties of each Azure LargeStorage instance.

SELECT
id,
name,
azureLargeStorageInstanceUniqueIdentifier,
location,
storageProperties,
systemData,
tags,
type
FROM azure.large_instance.azure_large_storage_instance
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Gets a list of AzureLargeStorageInstances in the specified subscription. The operations returns various properties of each Azure LargeStorage instance.

SELECT
id,
name,
azureLargeStorageInstanceUniqueIdentifier,
location,
storageProperties,
systemData,
tags,
type
FROM azure.large_instance.azure_large_storage_instance
WHERE subscription_id = '{{ subscription_id }}' -- required
;

UPDATE examples

update

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

UPDATE azure.large_instance.azure_large_storage_instance
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND azure_large_storage_instance_name = '{{ azure_large_storage_instance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;