elastic_sans

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

Overview

Name	elastic_sans
Type	Resource
Id	azure.elastic_san.elastic_sans

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.
autoScaleProperties	object	Auto Scale Properties for Elastic San Appliance.
availabilityZones	array	Logical zone for Elastic San resource; example: ["1"].
baseSizeTiB	integer	Base size of the Elastic San appliance in TiB. Required.
extendedCapacitySizeTiB	integer	Extended size of the Elastic San appliance in TiB. Required.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	The list of Private Endpoint Connections.
provisioningState	string	State of the operation on the resource. Known values are: "Invalid", "Succeeded", "Failed", "Canceled", "Pending", "Creating", "Updating", "Deleting", "Deleted", and "Restoring". (Invalid, Succeeded, Failed, Canceled, Pending, Creating, Updating, Deleting, Deleted, Restoring)
publicNetworkAccess	string	Allow or disallow public network access to ElasticSan. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
sku	object	resource sku. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
totalIops	integer	Total Provisioned IOPS of the Elastic San appliance.
totalMBps	integer	Total Provisioned MBps Elastic San appliance.
totalSizeTiB	integer	Total size of the Elastic San appliance in TB.
totalVolumeSizeGiB	integer	Total size of the provisioned Volumes in GiB.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
volumeGroupCount	integer	Total number of volume groups in this Elastic San appliance.

list_by_resource_group

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.
autoScaleProperties	object	Auto Scale Properties for Elastic San Appliance.
availabilityZones	array	Logical zone for Elastic San resource; example: ["1"].
baseSizeTiB	integer	Base size of the Elastic San appliance in TiB. Required.
extendedCapacitySizeTiB	integer	Extended size of the Elastic San appliance in TiB. Required.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	The list of Private Endpoint Connections.
provisioningState	string	State of the operation on the resource. Known values are: "Invalid", "Succeeded", "Failed", "Canceled", "Pending", "Creating", "Updating", "Deleting", "Deleted", and "Restoring". (Invalid, Succeeded, Failed, Canceled, Pending, Creating, Updating, Deleting, Deleted, Restoring)
publicNetworkAccess	string	Allow or disallow public network access to ElasticSan. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
sku	object	resource sku. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
totalIops	integer	Total Provisioned IOPS of the Elastic San appliance.
totalMBps	integer	Total Provisioned MBps Elastic San appliance.
totalSizeTiB	integer	Total size of the Elastic San appliance in TB.
totalVolumeSizeGiB	integer	Total size of the provisioned Volumes in GiB.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
volumeGroupCount	integer	Total number of volume groups in this Elastic San appliance.

list_by_subscription

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.
autoScaleProperties	object	Auto Scale Properties for Elastic San Appliance.
availabilityZones	array	Logical zone for Elastic San resource; example: ["1"].
baseSizeTiB	integer	Base size of the Elastic San appliance in TiB. Required.
extendedCapacitySizeTiB	integer	Extended size of the Elastic San appliance in TiB. Required.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	The list of Private Endpoint Connections.
provisioningState	string	State of the operation on the resource. Known values are: "Invalid", "Succeeded", "Failed", "Canceled", "Pending", "Creating", "Updating", "Deleting", "Deleted", and "Restoring". (Invalid, Succeeded, Failed, Canceled, Pending, Creating, Updating, Deleting, Deleted, Restoring)
publicNetworkAccess	string	Allow or disallow public network access to ElasticSan. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
sku	object	resource sku. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
totalIops	integer	Total Provisioned IOPS of the Elastic San appliance.
totalMBps	integer	Total Provisioned MBps Elastic San appliance.
totalSizeTiB	integer	Total size of the Elastic San appliance in TB.
totalVolumeSizeGiB	integer	Total size of the provisioned Volumes in GiB.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
volumeGroupCount	integer	Total number of volume groups in this Elastic San appliance.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, elastic_san_name, subscription_id		Get a ElasticSan.
list_by_resource_group	select	resource_group_name, subscription_id		Gets a list of ElasticSan in a resource group.
list_by_subscription	select	subscription_id		Gets a list of ElasticSans in a subscription.
create	insert	resource_group_name, elastic_san_name, subscription_id, location, properties		Create ElasticSan.
update	update	resource_group_name, elastic_san_name, subscription_id		Update a Elastic San.
delete	delete	resource_group_name, elastic_san_name, subscription_id		Delete a Elastic San.

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
elastic_san_name	string	The name of the ElasticSan. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a ElasticSan.

SELECT
id,
name,
autoScaleProperties,
availabilityZones,
baseSizeTiB,
extendedCapacitySizeTiB,
location,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
totalIops,
totalMBps,
totalSizeTiB,
totalVolumeSizeGiB,
type,
volumeGroupCount
FROM azure.elastic_san.elastic_sans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND elastic_san_name = '{{ elastic_san_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets a list of ElasticSan in a resource group.

SELECT
id,
name,
autoScaleProperties,
availabilityZones,
baseSizeTiB,
extendedCapacitySizeTiB,
location,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
totalIops,
totalMBps,
totalSizeTiB,
totalVolumeSizeGiB,
type,
volumeGroupCount
FROM azure.elastic_san.elastic_sans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Gets a list of ElasticSans in a subscription.

SELECT
id,
name,
autoScaleProperties,
availabilityZones,
baseSizeTiB,
extendedCapacitySizeTiB,
location,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
totalIops,
totalMBps,
totalSizeTiB,
totalVolumeSizeGiB,
type,
volumeGroupCount
FROM azure.elastic_san.elastic_sans
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create ElasticSan.

INSERT INTO azure.elastic_san.elastic_sans (
tags,
location,
properties,
resource_group_name,
elastic_san_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ elastic_san_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: elastic_sans
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the elastic_sans resource.
  - name: elastic_san_name
    value: "{{ elastic_san_name }}"
    description: Required parameter for the elastic_sans resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the elastic_sans resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Properties of ElasticSan. Required.
    value:
      sku:
        name: "{{ name }}"
        tier: "{{ tier }}"
      availabilityZones:
        - "{{ availabilityZones }}"
      provisioningState: "{{ provisioningState }}"
      baseSizeTiB: {{ baseSizeTiB }}
      extendedCapacitySizeTiB: {{ extendedCapacitySizeTiB }}
      totalVolumeSizeGiB: {{ totalVolumeSizeGiB }}
      volumeGroupCount: {{ volumeGroupCount }}
      totalIops: {{ totalIops }}
      totalMBps: {{ totalMBps }}
      totalSizeTiB: {{ totalSizeTiB }}
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            provisioningState: "{{ provisioningState }}"
            privateEndpoint:
              id: "{{ id }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            groupIds:
              - "{{ groupIds }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"
      autoScaleProperties:
        scaleUpProperties:
          unusedSizeTiB: {{ unusedSizeTiB }}
          increaseCapacityUnitByTiB: {{ increaseCapacityUnitByTiB }}
          capacityUnitScaleUpLimitTiB: {{ capacityUnitScaleUpLimitTiB }}
          autoScalePolicyEnforcement: "{{ autoScalePolicyEnforcement }}"

UPDATE examples

update

Update a Elastic San.

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

DELETE examples

delete

Delete a Elastic San.

DELETE FROM azure.elastic_san.elastic_sans
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND elastic_san_name = '{{ elastic_san_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;