storage_containers

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

Overview

Name	storage_containers
Type	Resource
Id	azure_stack.azure_stack_hci_vm.storage_containers

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.
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives. Required.
path	string	Path of the storage container on the disk. Required.
provisioningState	string	Provisioning state of the storage container. Known values are: "Succeeded", "Failed", "InProgress", "Accepted", "Deleting", and "Canceled". (Succeeded, Failed, InProgress, Accepted, Deleting, Canceled)
status	object	The observed state of storage containers.
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".

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.
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives. Required.
path	string	Path of the storage container on the disk. Required.
provisioningState	string	Provisioning state of the storage container. Known values are: "Succeeded", "Failed", "InProgress", "Accepted", "Deleting", and "Canceled". (Succeeded, Failed, InProgress, Accepted, Deleting, Canceled)
status	object	The observed state of storage containers.
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".

list_all

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.
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives. Required.
path	string	Path of the storage container on the disk. Required.
provisioningState	string	Provisioning state of the storage container. Known values are: "Succeeded", "Failed", "InProgress", "Accepted", "Deleting", and "Canceled". (Succeeded, Failed, InProgress, Accepted, Deleting, Canceled)
status	object	The observed state of storage containers.
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, storage_container_name, subscription_id		Gets a storage container.
list_by_resource_group	select	resource_group_name, subscription_id		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	subscription_id		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	resource_group_name, storage_container_name, subscription_id, location		The operation to create or update a storage container. Please note some properties can be set only during storage container creation.
update	update	resource_group_name, storage_container_name, subscription_id		The operation to update a storage container.
create_or_update	replace	resource_group_name, storage_container_name, subscription_id, location		The operation to create or update a storage container. Please note some properties can be set only during storage container creation.
delete	delete	resource_group_name, storage_container_name, subscription_id		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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
storage_container_name	string	Name of the storage container. Required.
subscription_id	string

SELECT examples

get

Gets a storage container.

SELECT
id,
name,
extendedLocation,
location,
path,
provisioningState,
status,
systemData,
tags,
type
FROM azure_stack.azure_stack_hci_vm.storage_containers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_container_name = '{{ storage_container_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

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
id,
name,
extendedLocation,
location,
path,
provisioningState,
status,
systemData,
tags,
type
FROM azure_stack.azure_stack_hci_vm.storage_containers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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
id,
name,
extendedLocation,
location,
path,
provisioningState,
status,
systemData,
tags,
type
FROM azure_stack.azure_stack_hci_vm.storage_containers
WHERE subscription_id = '{{ subscription_id }}' -- 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_vm.storage_containers (
tags,
location,
properties,
extendedLocation,
resource_group_name,
storage_container_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ storage_container_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: storage_containers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the storage_containers resource.
  - name: storage_container_name
    value: "{{ storage_container_name }}"
    description: Required parameter for the storage_containers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the storage_containers 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 resource-specific properties for this resource.
    value:
      path: "{{ path }}"
      provisioningState: "{{ provisioningState }}"
      status:
        errorCode: "{{ errorCode }}"
        errorMessage: "{{ errorMessage }}"
        availableSizeMB: {{ availableSizeMB }}
        containerSizeMB: {{ containerSizeMB }}
        provisioningStatus:
          operationId: "{{ operationId }}"
          status: "{{ status }}"
  - name: extendedLocation
    description: |
      The extendedLocation of the resource.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update

The operation to update a storage container.

UPDATE azure_stack.azure_stack_hci_vm.storage_containers
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND storage_container_name = '{{ storage_container_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type;

REPLACE 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.

REPLACE azure_stack.azure_stack_hci_vm.storage_containers
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND storage_container_name = '{{ storage_container_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

The operation to delete a storage container.

DELETE FROM azure_stack.azure_stack_hci_vm.storage_containers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND storage_container_name = '{{ storage_container_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;