storage_appliances

Creates, updates, deletes, gets or lists a storage_appliances resource.

Overview

Name	storage_appliances
Type	Resource
Id	azure_extras.network_cloud.storage_appliances

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.
administratorCredentials	object	The credentials of the administrative interface on this storage appliance. Required.
caCertificate	object	The CA certificate information issued by the platform for connecting to TLS interfaces for the storage appliance. Callers add this certificate to their trusted CA store to allow secure communication with the storage appliance.
capacity	integer	The total capacity of the storage appliance. Measured in GiB.
capacityUsed	integer	The amount of storage consumed. Measured in GiB.
clusterId	string	The resource ID of the cluster this storage appliance is associated with.
detailedStatus	string	The detailed status of the storage appliance. Known values are: "Available", "Degraded", "Error", and "Provisioning". (Available, Degraded, Error, Provisioning)
detailedStatusMessage	string	The descriptive message about the current detailed status.
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.").
expansionShelves	array	The list of expansion shelves connected to the storage appliance.
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
location	string	The geo-location where the resource lives. Required.
managementIpv4Address	string	The endpoint for the management interface of the storage appliance.
manufacturer	string	The manufacturer of the storage appliance.
model	string	The model of the storage appliance.
monitoringConfigurationStatus	object	The monitoring configuration status of the storage appliance.
provisioningState	string	The provisioning state of the storage appliance. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Accepted)
rackId	string	The resource ID of the rack where this storage appliance resides. Required.
rackSlot	integer	The slot the storage appliance is in the rack based on the BOM configuration. Required.
remoteVendorManagementFeature	string	The indicator of whether the storage appliance supports remote vendor management. Known values are: "Supported" and "Unsupported". (Supported, Unsupported)
remoteVendorManagementStatus	string	The indicator of whether the remote vendor management feature is enabled or disabled, or unsupported if it is an unsupported feature. Known values are: "Enabled", "Disabled", and "Unsupported". (Enabled, Disabled, Unsupported)
secretRotationStatus	array	The list of statuses that represent secret rotation activity.
serialNumber	string	The serial number for the storage appliance. Required.
storageApplianceSkuId	string	The SKU for the storage appliance. Required.
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".
version	string	The version of the storage 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.
administratorCredentials	object	The credentials of the administrative interface on this storage appliance. Required.
caCertificate	object	The CA certificate information issued by the platform for connecting to TLS interfaces for the storage appliance. Callers add this certificate to their trusted CA store to allow secure communication with the storage appliance.
capacity	integer	The total capacity of the storage appliance. Measured in GiB.
capacityUsed	integer	The amount of storage consumed. Measured in GiB.
clusterId	string	The resource ID of the cluster this storage appliance is associated with.
detailedStatus	string	The detailed status of the storage appliance. Known values are: "Available", "Degraded", "Error", and "Provisioning". (Available, Degraded, Error, Provisioning)
detailedStatusMessage	string	The descriptive message about the current detailed status.
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.").
expansionShelves	array	The list of expansion shelves connected to the storage appliance.
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
location	string	The geo-location where the resource lives. Required.
managementIpv4Address	string	The endpoint for the management interface of the storage appliance.
manufacturer	string	The manufacturer of the storage appliance.
model	string	The model of the storage appliance.
monitoringConfigurationStatus	object	The monitoring configuration status of the storage appliance.
provisioningState	string	The provisioning state of the storage appliance. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Accepted)
rackId	string	The resource ID of the rack where this storage appliance resides. Required.
rackSlot	integer	The slot the storage appliance is in the rack based on the BOM configuration. Required.
remoteVendorManagementFeature	string	The indicator of whether the storage appliance supports remote vendor management. Known values are: "Supported" and "Unsupported". (Supported, Unsupported)
remoteVendorManagementStatus	string	The indicator of whether the remote vendor management feature is enabled or disabled, or unsupported if it is an unsupported feature. Known values are: "Enabled", "Disabled", and "Unsupported". (Enabled, Disabled, Unsupported)
secretRotationStatus	array	The list of statuses that represent secret rotation activity.
serialNumber	string	The serial number for the storage appliance. Required.
storageApplianceSkuId	string	The SKU for the storage appliance. Required.
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".
version	string	The version of the storage 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.
administratorCredentials	object	The credentials of the administrative interface on this storage appliance. Required.
caCertificate	object	The CA certificate information issued by the platform for connecting to TLS interfaces for the storage appliance. Callers add this certificate to their trusted CA store to allow secure communication with the storage appliance.
capacity	integer	The total capacity of the storage appliance. Measured in GiB.
capacityUsed	integer	The amount of storage consumed. Measured in GiB.
clusterId	string	The resource ID of the cluster this storage appliance is associated with.
detailedStatus	string	The detailed status of the storage appliance. Known values are: "Available", "Degraded", "Error", and "Provisioning". (Available, Degraded, Error, Provisioning)
detailedStatusMessage	string	The descriptive message about the current detailed status.
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.").
expansionShelves	array	The list of expansion shelves connected to the storage appliance.
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
location	string	The geo-location where the resource lives. Required.
managementIpv4Address	string	The endpoint for the management interface of the storage appliance.
manufacturer	string	The manufacturer of the storage appliance.
model	string	The model of the storage appliance.
monitoringConfigurationStatus	object	The monitoring configuration status of the storage appliance.
provisioningState	string	The provisioning state of the storage appliance. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Accepted)
rackId	string	The resource ID of the rack where this storage appliance resides. Required.
rackSlot	integer	The slot the storage appliance is in the rack based on the BOM configuration. Required.
remoteVendorManagementFeature	string	The indicator of whether the storage appliance supports remote vendor management. Known values are: "Supported" and "Unsupported". (Supported, Unsupported)
remoteVendorManagementStatus	string	The indicator of whether the remote vendor management feature is enabled or disabled, or unsupported if it is an unsupported feature. Known values are: "Enabled", "Disabled", and "Unsupported". (Enabled, Disabled, Unsupported)
secretRotationStatus	array	The list of statuses that represent secret rotation activity.
serialNumber	string	The serial number for the storage appliance. Required.
storageApplianceSkuId	string	The SKU for the storage appliance. Required.
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".
version	string	The version of the storage appliance.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, storage_appliance_name, subscription_id		Get properties of the provided storage appliance.
list_by_resource_group	select	resource_group_name, subscription_id	$top, $skipToken	Get a list of storage appliances in the provided resource group.
list_by_subscription	select	subscription_id	$top, $skipToken	Get a list of storage appliances in the provided subscription.
create_or_update	insert	resource_group_name, storage_appliance_name, subscription_id, location, properties, extendedLocation		Create a new storage appliance or update the properties of the existing one. All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.
update	update	resource_group_name, storage_appliance_name, subscription_id		Update properties of the provided storage appliance, or update tags associated with the storage appliance Properties and tag updates can be done independently.
create_or_update	replace	resource_group_name, storage_appliance_name, subscription_id, location, properties, extendedLocation		Create a new storage appliance or update the properties of the existing one. All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.
delete	delete	resource_group_name, storage_appliance_name, subscription_id		Delete the provided storage appliance. All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.
disable_remote_vendor_management	exec	resource_group_name, storage_appliance_name, subscription_id		Disable remote vendor management of the provided storage appliance.
enable_remote_vendor_management	exec	resource_group_name, storage_appliance_name, subscription_id		Enable remote vendor management of the provided storage appliance.
run_read_commands	exec	resource_group_name, storage_appliance_name, subscription_id, commands, limitTimeSeconds		Run one or more read-only commands on the provided storage appliance.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
storage_appliance_name	string	The name of the storage appliance. Required.
subscription_id	string
$skipToken	string	The opaque token that the server returns to indicate where to continue listing resources from. This is used for paging through large result sets. Default value is None.
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Get properties of the provided storage appliance.

SELECT
id,
name,
administratorCredentials,
caCertificate,
capacity,
capacityUsed,
clusterId,
detailedStatus,
detailedStatusMessage,
etag,
expansionShelves,
extendedLocation,
location,
managementIpv4Address,
manufacturer,
model,
monitoringConfigurationStatus,
provisioningState,
rackId,
rackSlot,
remoteVendorManagementFeature,
remoteVendorManagementStatus,
secretRotationStatus,
serialNumber,
storageApplianceSkuId,
systemData,
tags,
type,
version
FROM azure_extras.network_cloud.storage_appliances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_appliance_name = '{{ storage_appliance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Get a list of storage appliances in the provided resource group.

SELECT
id,
name,
administratorCredentials,
caCertificate,
capacity,
capacityUsed,
clusterId,
detailedStatus,
detailedStatusMessage,
etag,
expansionShelves,
extendedLocation,
location,
managementIpv4Address,
manufacturer,
model,
monitoringConfigurationStatus,
provisioningState,
rackId,
rackSlot,
remoteVendorManagementFeature,
remoteVendorManagementStatus,
secretRotationStatus,
serialNumber,
storageApplianceSkuId,
systemData,
tags,
type,
version
FROM azure_extras.network_cloud.storage_appliances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

list_by_subscription

Get a list of storage appliances in the provided subscription.

SELECT
id,
name,
administratorCredentials,
caCertificate,
capacity,
capacityUsed,
clusterId,
detailedStatus,
detailedStatusMessage,
etag,
expansionShelves,
extendedLocation,
location,
managementIpv4Address,
manufacturer,
model,
monitoringConfigurationStatus,
provisioningState,
rackId,
rackSlot,
remoteVendorManagementFeature,
remoteVendorManagementStatus,
secretRotationStatus,
serialNumber,
storageApplianceSkuId,
systemData,
tags,
type,
version
FROM azure_extras.network_cloud.storage_appliances
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Create a new storage appliance or update the properties of the existing one. All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.

INSERT INTO azure_extras.network_cloud.storage_appliances (
tags,
location,
properties,
extendedLocation,
resource_group_name,
storage_appliance_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ extendedLocation }}' /* required */,
'{{ resource_group_name }}',
'{{ storage_appliance_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: storage_appliances
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the storage_appliances resource.
  - name: storage_appliance_name
    value: "{{ storage_appliance_name }}"
    description: Required parameter for the storage_appliances resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the storage_appliances resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The list of the resource properties. Required.
    value:
      rackId: "{{ rackId }}"
      storageApplianceSkuId: "{{ storageApplianceSkuId }}"
      rackSlot: {{ rackSlot }}
      serialNumber: "{{ serialNumber }}"
      administratorCredentials:
        password: "{{ password }}"
        username: "{{ username }}"
      caCertificate:
        hash: "{{ hash }}"
        value: "{{ value }}"
      capacity: {{ capacity }}
      capacityUsed: {{ capacityUsed }}
      clusterId: "{{ clusterId }}"
      detailedStatus: "{{ detailedStatus }}"
      detailedStatusMessage: "{{ detailedStatusMessage }}"
      expansionShelves:
        - model: "{{ model }}"
          version: "{{ version }}"
      managementIpv4Address: "{{ managementIpv4Address }}"
      manufacturer: "{{ manufacturer }}"
      model: "{{ model }}"
      monitoringConfigurationStatus:
        logLevel: "{{ logLevel }}"
        metricsLevel: "{{ metricsLevel }}"
      remoteVendorManagementFeature: "{{ remoteVendorManagementFeature }}"
      remoteVendorManagementStatus: "{{ remoteVendorManagementStatus }}"
      secretRotationStatus:
        - expirePeriodDays: {{ expirePeriodDays }}
          lastRotationTime: "{{ lastRotationTime }}"
          rotationPeriodDays: {{ rotationPeriodDays }}
          secretArchiveReference:
            keyVaultId: "{{ keyVaultId }}"
            keyVaultUri: "{{ keyVaultUri }}"
            secretName: "{{ secretName }}"
            secretVersion: "{{ secretVersion }}"
          secretType: "{{ secretType }}"
      version: "{{ version }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      The extended location of the resource. This property is required when creating the resource. Required.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update

Update properties of the provided storage appliance, or update tags associated with the storage appliance Properties and tag updates can be done independently.

UPDATE azure_extras.network_cloud.storage_appliances
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND storage_appliance_name = '{{ storage_appliance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a new storage appliance or update the properties of the existing one. All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.

REPLACE azure_extras.network_cloud.storage_appliances
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND storage_appliance_name = '{{ storage_appliance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
AND extendedLocation = '{{ extendedLocation }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete the provided storage appliance. All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.

DELETE FROM azure_extras.network_cloud.storage_appliances
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND storage_appliance_name = '{{ storage_appliance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

disable_remote_vendor_management

Disable remote vendor management of the provided storage appliance.

EXEC azure_extras.network_cloud.storage_appliances.disable_remote_vendor_management 
@resource_group_name='{{ resource_group_name }}' --required, 
@storage_appliance_name='{{ storage_appliance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

enable_remote_vendor_management

Enable remote vendor management of the provided storage appliance.

EXEC azure_extras.network_cloud.storage_appliances.enable_remote_vendor_management 
@resource_group_name='{{ resource_group_name }}' --required, 
@storage_appliance_name='{{ storage_appliance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"supportEndpoints": "{{ supportEndpoints }}"
}'
;

run_read_commands

Run one or more read-only commands on the provided storage appliance.

EXEC azure_extras.network_cloud.storage_appliances.run_read_commands 
@resource_group_name='{{ resource_group_name }}' --required, 
@storage_appliance_name='{{ storage_appliance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"commands": "{{ commands }}", 
"limitTimeSeconds": {{ limitTimeSeconds }}
}'
;