storage_appliances

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

Overview

Name	storage_appliances
Type	Resource
Id	azure.nexus.storage_appliances

Fields

The following fields are returned by SELECT queries:

get

The resource has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: StorageApplianceProperties represents the properties of the storage appliance.)
tags	object	Resource tags.

list_by_resource_group

The resource list has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: StorageApplianceProperties represents the properties of the storage appliance.)
tags	object	Resource tags.

list_by_subscription

The resource list has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: StorageApplianceProperties represents the properties of the storage appliance.)
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, storageApplianceName		Get properties of the provided storage appliance.
list_by_resource_group	select	subscriptionId, resourceGroupName		Get a list of storage appliances in the provided resource group.
list_by_subscription	select	subscriptionId		Get a list of storage appliances in the provided subscription.
create_or_update	insert	subscriptionId, resourceGroupName, storageApplianceName, data__extendedLocation, data__properties		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	subscriptionId, resourceGroupName, storageApplianceName		Update properties of the provided storage appliance, or update tags associated with the storage appliance Properties and tag updates can be done independently.
delete	delete	subscriptionId, resourceGroupName, storageApplianceName		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	subscriptionId, resourceGroupName, storageApplianceName		Disable remote vendor management of the provided storage appliance.
enable_remote_vendor_management	exec	subscriptionId, resourceGroupName, storageApplianceName		Enable remote vendor management of 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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
storageApplianceName	string	The name of the storage appliance.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get properties of the provided storage appliance.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.storage_appliances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND storageApplianceName = '{{ storageApplianceName }}' -- required
;

list_by_resource_group

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

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.storage_appliances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Get a list of storage appliances in the provided subscription.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.storage_appliances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

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.nexus.storage_appliances (
data__extendedLocation,
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
storageApplianceName
)
SELECT 
'{{ extendedLocation }}' /* required */,
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ storageApplianceName }}'
RETURNING
extendedLocation,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: storage_appliances
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the storage_appliances resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the storage_appliances resource.
    - name: storageApplianceName
      value: string
      description: Required parameter for the storage_appliances resource.
    - name: extendedLocation
      value: object
      description: |
        The extended location of the cluster associated with the resource.
    - name: properties
      value: object
      description: |
        The list of the resource properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

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.nexus.storage_appliances
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND storageApplianceName = '{{ storageApplianceName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

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.nexus.storage_appliances
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND storageApplianceName = '{{ storageApplianceName }}' --required
;

Lifecycle Methods

disable_remote_vendor_management

Disable remote vendor management of the provided storage appliance.

EXEC azure.nexus.storage_appliances.disable_remote_vendor_management 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@storageApplianceName='{{ storageApplianceName }}' --required
;

enable_remote_vendor_management

Enable remote vendor management of the provided storage appliance.

EXEC azure.nexus.storage_appliances.enable_remote_vendor_management 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@storageApplianceName='{{ storageApplianceName }}' --required 
@@json=
'{
"supportEndpoints": "{{ supportEndpoints }}"
}'
;