plans

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

Overview

Name	plans
Type	Resource
Id	azure_isv.commvaultcontentstore.plans

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.
location	string	Location of the Commvault Plan. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
retention	object	The Commvault Plan Retention.
schedules	array	The Commvault Plan Schedule.
storagePlans	array	The storage plans associated with the Commvault Plan. Required.
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".

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.
location	string	Location of the Commvault Plan. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
retention	object	The Commvault Plan Retention.
schedules	array	The Commvault Plan Schedule.
storagePlans	array	The storage plans associated with the Commvault Plan. Required.
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".

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, plan_name, subscription_id		Get a CommvaultPlan.
list_by_cloud_account	select	resource_group_name, cloud_account_name, subscription_id		List CommvaultPlan resources by CloudAccount.
create_orupdate	insert	resource_group_name, cloud_account_name, plan_name, subscription_id		Create a CommvaultPlan.
delete	delete	resource_group_name, cloud_account_name, plan_name, subscription_id		Delete a CommvaultPlan.

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.
plan_name	string	Name of the Plan resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a CommvaultPlan.

SELECT
id,
name,
location,
provisioningState,
retention,
schedules,
storagePlans,
systemData,
type
FROM azure_isv.commvaultcontentstore.plans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloud_account_name = '{{ cloud_account_name }}' -- required
AND plan_name = '{{ plan_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_cloud_account

List CommvaultPlan resources by CloudAccount.

SELECT
id,
name,
location,
provisioningState,
retention,
schedules,
storagePlans,
systemData,
type
FROM azure_isv.commvaultcontentstore.plans
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_orupdate

Create a CommvaultPlan.

INSERT INTO azure_isv.commvaultcontentstore.plans (
properties,
resource_group_name,
cloud_account_name,
plan_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cloud_account_name }}',
'{{ plan_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: plans
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the plans resource.
  - name: cloud_account_name
    value: "{{ cloud_account_name }}"
    description: Required parameter for the plans resource.
  - name: plan_name
    value: "{{ plan_name }}"
    description: Required parameter for the plans resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the plans resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      location: "{{ location }}"
      storagePlans:
        - name: "{{ name }}"
          storagePoolId: "{{ storagePoolId }}"
          copyName: "{{ copyName }}"
          copyPrecedence: {{ copyPrecedence }}
          retentionPeriod: {{ retentionPeriod }}
          retentionTime: "{{ retentionTime }}"
          backupRuleType: "{{ backupRuleType }}"
          extendedRetention: "{{ extendedRetention }}"
      schedules:
        - backupType: "{{ backupType }}"
          frequency: "{{ frequency }}"
          runsEvery: {{ runsEvery }}
          weekOfMonth: "{{ weekOfMonth }}"
          dayOfWeek: "{{ dayOfWeek }}"
          monthOfYear: "{{ monthOfYear }}"
          dayOfMonth: {{ dayOfMonth }}
          weeklyDays: "{{ weeklyDays }}"
          time: "{{ time }}"
          timeZone: "{{ timeZone }}"
      retention:
        numberOfSnapshots: {{ numberOfSnapshots }}
      provisioningState: "{{ provisioningState }}"

DELETE examples

delete

Delete a CommvaultPlan.

DELETE FROM azure_isv.commvaultcontentstore.plans
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cloud_account_name = '{{ cloud_account_name }}' --required
AND plan_name = '{{ plan_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;