storages
Creates, updates, deletes, gets or lists a storages resource.
Overview
| Name | storages |
| Type | Resource |
| Id | azure_isv.commvaultcontentstore.storages |
Fields
The following fields are returned by SELECT queries:
- get
- list_by_cloud_account
| 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. |
class | string | The class of Commvault Storage. Required. Known values are: "COLD" and "HOT". (COLD, HOT) |
location | string | Location of the Commvault Storage. Required. |
provisioningState | string | Provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled) |
storageType | string | The type of Commvault Storage. Required. "Air_Gap_Protect" (Air_Gap_Protect) |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". |
vendor | string | The vendor of Commvault Storage. Required. "Azure_Blob_Storage" (Azure_Blob_Storage) |
| 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. |
class | string | The class of Commvault Storage. Required. Known values are: "COLD" and "HOT". (COLD, HOT) |
location | string | Location of the Commvault Storage. Required. |
provisioningState | string | Provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled) |
storageType | string | The type of Commvault Storage. Required. "Air_Gap_Protect" (Air_Gap_Protect) |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". |
vendor | string | The vendor of Commvault Storage. Required. "Azure_Blob_Storage" (Azure_Blob_Storage) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | resource_group_name, cloud_account_name, storage_name, subscription_id | Get a Storage. | |
list_by_cloud_account | select | resource_group_name, cloud_account_name, subscription_id | List Storage resources by CloudAccount. | |
create_or_update | insert | resource_group_name, cloud_account_name, storage_name, subscription_id | Create a Storage. | |
create_or_update | replace | resource_group_name, cloud_account_name, storage_name, subscription_id | Create a Storage. | |
delete | delete | resource_group_name, cloud_account_name, storage_name, subscription_id | Delete a Storage. |
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 |
|---|---|---|
cloud_account_name | string | Name of the Cloud Account resource. Required. |
resource_group_name | string | The name of the resource group. The name is case insensitive. Required. |
storage_name | string | Name of the Storage resource. Required. |
subscription_id | string |
SELECT examples
- get
- list_by_cloud_account
Get a Storage.
SELECT
id,
name,
class,
location,
provisioningState,
storageType,
systemData,
type,
vendor
FROM azure_isv.commvaultcontentstore.storages
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloud_account_name = '{{ cloud_account_name }}' -- required
AND storage_name = '{{ storage_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
List Storage resources by CloudAccount.
SELECT
id,
name,
class,
location,
provisioningState,
storageType,
systemData,
type,
vendor
FROM azure_isv.commvaultcontentstore.storages
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloud_account_name = '{{ cloud_account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
INSERT examples
- create_or_update
- Manifest
Create a Storage.
INSERT INTO azure_isv.commvaultcontentstore.storages (
properties,
resource_group_name,
cloud_account_name,
storage_name,
subscription_id
)
SELECT
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cloud_account_name }}',
'{{ storage_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;
# Description fields are for documentation purposes
- name: storages
props:
- name: resource_group_name
value: "{{ resource_group_name }}"
description: Required parameter for the storages resource.
- name: cloud_account_name
value: "{{ cloud_account_name }}"
description: Required parameter for the storages resource.
- name: storage_name
value: "{{ storage_name }}"
description: Required parameter for the storages resource.
- name: subscription_id
value: "{{ subscription_id }}"
description: Required parameter for the storages resource.
- name: properties
description: |
The resource-specific properties for this resource.
value:
location: "{{ location }}"
storageType: "{{ storageType }}"
vendor: "{{ vendor }}"
class: "{{ class }}"
provisioningState: "{{ provisioningState }}"
REPLACE examples
- create_or_update
Create a Storage.
REPLACE azure_isv.commvaultcontentstore.storages
SET
properties = '{{ properties }}'
WHERE
resource_group_name = '{{ resource_group_name }}' --required
AND cloud_account_name = '{{ cloud_account_name }}' --required
AND storage_name = '{{ storage_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;
DELETE examples
- delete
Delete a Storage.
DELETE FROM azure_isv.commvaultcontentstore.storages
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cloud_account_name = '{{ cloud_account_name }}' --required
AND storage_name = '{{ storage_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;