storage_containers

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

Overview

Name	storage_containers
Type	Resource
Id	azure_stack.azure_stack_hci.storage_containers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties under the storage container resource
tags	object	Resource tags.

list

Name	Datatype	Description
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties under the storage container resource
tags	object	Resource tags.

list_all

Name	Datatype	Description
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties under the storage container resource
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, storageContainerName		Gets a storage container
list	select	subscriptionId, resourceGroupName		Lists all of the storage containers in the specified resource group. Use the nextLink property in the response to get the next page of storage containers.
list_all	select	subscriptionId		Lists all of the storage containers in the specified subscription. Use the nextLink property in the response to get the next page of storage containers.
create_or_update	insert	subscriptionId, resourceGroupName, storageContainerName		The operation to create or update a storage container. Please note some properties can be set only during storage container creation.
update	update	subscriptionId, resourceGroupName, storageContainerName		The operation to update a storage container.
delete	delete	subscriptionId, resourceGroupName, storageContainerName		The operation to delete a storage container.

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.
storageContainerName	string	Name of the storage container
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets a storage container

SELECT
extendedLocation,
location,
properties,
tags
FROM azure_stack.azure_stack_hci.storage_containers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND storageContainerName = '{{ storageContainerName }}' -- required
;

list

Lists all of the storage containers in the specified resource group. Use the nextLink property in the response to get the next page of storage containers.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure_stack.azure_stack_hci.storage_containers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_all

Lists all of the storage containers in the specified subscription. Use the nextLink property in the response to get the next page of storage containers.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure_stack.azure_stack_hci.storage_containers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

The operation to create or update a storage container. Please note some properties can be set only during storage container creation.

INSERT INTO azure_stack.azure_stack_hci.storage_containers (
data__properties,
data__extendedLocation,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
storageContainerName
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ storageContainerName }}'
RETURNING
extendedLocation,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: storage_containers
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the storage_containers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the storage_containers resource.
    - name: storageContainerName
      value: string
      description: Required parameter for the storage_containers resource.
    - name: properties
      value: object
      description: |
        Properties under the storage container resource
    - name: extendedLocation
      value: object
      description: |
        The extendedLocation of the resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

The operation to update a storage container.

UPDATE azure_stack.azure_stack_hci.storage_containers
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND storageContainerName = '{{ storageContainerName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

DELETE examples

delete

The operation to delete a storage container.

DELETE FROM azure_stack.azure_stack_hci.storage_containers
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND storageContainerName = '{{ storageContainerName }}' --required
;