storage_domains

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

Overview

Name	storage_domains
Type	Resource
Id	azure_extras.storsimple_1200_series.storage_domains

Fields

The following fields are returned by SELECT queries:

get

The storage domain.

Name	Datatype	Description
id	string	The identifier.
name	string	The name.
properties	object	The properties.
type	string	The type.

list_by_manager

The collection of storage domains.

Name	Datatype	Description
id	string	The identifier.
name	string	The name.
properties	object	The properties.
type	string	The type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	storageDomainName, subscriptionId, resourceGroupName, managerName		Returns the properties of the specified storage domain name.
list_by_manager	select	subscriptionId, resourceGroupName, managerName		Retrieves all the storage domains in a manager.
create_or_update	insert	storageDomainName, subscriptionId, resourceGroupName, managerName, data__properties		Creates or updates the storage domain.
delete	delete	storageDomainName, subscriptionId, resourceGroupName, managerName		Deletes the storage domain.

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
managerName	string	The manager name
resourceGroupName	string	The resource group name
storageDomainName	string	The storage domain name.
subscriptionId	string	The subscription id

SELECT examples

get

Returns the properties of the specified storage domain name.

SELECT
id,
name,
properties,
type
FROM azure_extras.storsimple_1200_series.storage_domains
WHERE storageDomainName = '{{ storageDomainName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managerName = '{{ managerName }}' -- required
;

list_by_manager

Retrieves all the storage domains in a manager.

SELECT
id,
name,
properties,
type
FROM azure_extras.storsimple_1200_series.storage_domains
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managerName = '{{ managerName }}' -- required
;

INSERT examples

create_or_update

Creates or updates the storage domain.

INSERT INTO azure_extras.storsimple_1200_series.storage_domains (
data__properties,
storageDomainName,
subscriptionId,
resourceGroupName,
managerName
)
SELECT 
'{{ properties }}' /* required */,
'{{ storageDomainName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ managerName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: storage_domains
  props:
    - name: storageDomainName
      value: string
      description: Required parameter for the storage_domains resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the storage_domains resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the storage_domains resource.
    - name: managerName
      value: string
      description: Required parameter for the storage_domains resource.
    - name: properties
      value: object
      description: |
        The properties.

DELETE examples

delete

Deletes the storage domain.

DELETE FROM azure_extras.storsimple_1200_series.storage_domains
WHERE storageDomainName = '{{ storageDomainName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND managerName = '{{ managerName }}' --required
;