cloud_accounts

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

Overview

Name	cloud_accounts
Type	Resource
Id	azure_isv.commvaultcontentstore.cloud_accounts

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.
backupAdminOnCcaCreate	object	The backup administrator principal provided during CCA create. Required on create (enforced by backend), ignored on update.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
marketplace	object	Marketplace details of the resource. Required.
multiPersonAuthorizationOnCcaCreate	object	The multi-person authorization (MPA) administrator principal provided during CCA create. Required on create (enforced by backend), ignored on update.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
ssoUrl	string	SSO URL for the Commvault Cloud Account.
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".
user	object	Details of the user. Required.

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.
backupAdminOnCcaCreate	object	The backup administrator principal provided during CCA create. Required on create (enforced by backend), ignored on update.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
marketplace	object	Marketplace details of the resource. Required.
multiPersonAuthorizationOnCcaCreate	object	The multi-person authorization (MPA) administrator principal provided during CCA create. Required on create (enforced by backend), ignored on update.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
ssoUrl	string	SSO URL for the Commvault Cloud Account.
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".
user	object	Details of the user. Required.

list_by_subscription

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.
backupAdminOnCcaCreate	object	The backup administrator principal provided during CCA create. Required on create (enforced by backend), ignored on update.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
marketplace	object	Marketplace details of the resource. Required.
multiPersonAuthorizationOnCcaCreate	object	The multi-person authorization (MPA) administrator principal provided during CCA create. Required on create (enforced by backend), ignored on update.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
ssoUrl	string	SSO URL for the Commvault Cloud Account.
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".
user	object	Details of the user. Required.

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, subscription_id		Get a CloudAccount.
list_by_resource_group	select	resource_group_name, subscription_id		List CloudAccount resources by resource group.
list_by_subscription	select	subscription_id		List CloudAccount resources by subscription ID.
create_or_update	insert	resource_group_name, cloud_account_name, subscription_id, location		Create a CloudAccount.
update	update	resource_group_name, cloud_account_name, subscription_id		Update a CloudAccount.
create_or_update	replace	resource_group_name, cloud_account_name, subscription_id, location		Create a CloudAccount.
delete	delete	resource_group_name, cloud_account_name, subscription_id		Delete a CloudAccount.
link_saa_s	exec	resource_group_name, cloud_account_name, subscription_id		Links a new SaaS to the cloud account. Links a new SaaS to the cloud account.
latest_linked_saa_s	exec	resource_group_name, cloud_account_name, subscription_id		Returns the latest SaaS linked to the cloud account.

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.
subscription_id	string

SELECT examples

get

Get a CloudAccount.

SELECT
id,
name,
backupAdminOnCcaCreate,
identity,
location,
marketplace,
multiPersonAuthorizationOnCcaCreate,
provisioningState,
ssoUrl,
systemData,
tags,
type,
user
FROM azure_isv.commvaultcontentstore.cloud_accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloud_account_name = '{{ cloud_account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List CloudAccount resources by resource group.

SELECT
id,
name,
backupAdminOnCcaCreate,
identity,
location,
marketplace,
multiPersonAuthorizationOnCcaCreate,
provisioningState,
ssoUrl,
systemData,
tags,
type,
user
FROM azure_isv.commvaultcontentstore.cloud_accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List CloudAccount resources by subscription ID.

SELECT
id,
name,
backupAdminOnCcaCreate,
identity,
location,
marketplace,
multiPersonAuthorizationOnCcaCreate,
provisioningState,
ssoUrl,
systemData,
tags,
type,
user
FROM azure_isv.commvaultcontentstore.cloud_accounts
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a CloudAccount.

INSERT INTO azure_isv.commvaultcontentstore.cloud_accounts (
tags,
location,
properties,
identity,
resource_group_name,
cloud_account_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ cloud_account_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: cloud_accounts
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the cloud_accounts resource.
  - name: cloud_account_name
    value: "{{ cloud_account_name }}"
    description: Required parameter for the cloud_accounts resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the cloud_accounts 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:
      marketplace:
        subscriptionId: "{{ subscriptionId }}"
        subscriptionStatus: "{{ subscriptionStatus }}"
        saasResourceId: "{{ saasResourceId }}"
        offerDetails:
          publisherId: "{{ publisherId }}"
          offerId: "{{ offerId }}"
          planId: "{{ planId }}"
          planName: "{{ planName }}"
          termUnit: "{{ termUnit }}"
          termId: "{{ termId }}"
      user:
        firstName: "{{ firstName }}"
        lastName: "{{ lastName }}"
        emailAddress: "{{ emailAddress }}"
        upn: "{{ upn }}"
        phoneNumber: "{{ phoneNumber }}"
      provisioningState: "{{ provisioningState }}"
      ssoUrl: "{{ ssoUrl }}"
      backupAdminOnCcaCreate:
        id: "{{ id }}"
        displayName: "{{ displayName }}"
        entityType: "{{ entityType }}"
      multiPersonAuthorizationOnCcaCreate:
        id: "{{ id }}"
        displayName: "{{ displayName }}"
        entityType: "{{ entityType }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update a CloudAccount.

UPDATE azure_isv.commvaultcontentstore.cloud_accounts
SET 
identity = '{{ identity }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cloud_account_name = '{{ cloud_account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a CloudAccount.

REPLACE azure_isv.commvaultcontentstore.cloud_accounts
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cloud_account_name = '{{ cloud_account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a CloudAccount.

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

Lifecycle Methods

link_saa_s

Links a new SaaS to the cloud account. Links a new SaaS to the cloud account.

EXEC azure_isv.commvaultcontentstore.cloud_accounts.link_saa_s 
@resource_group_name='{{ resource_group_name }}' --required, 
@cloud_account_name='{{ cloud_account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"saaSResourceId": "{{ saaSResourceId }}"
}'
;

latest_linked_saa_s

Returns the latest SaaS linked to the cloud account.

EXEC azure_isv.commvaultcontentstore.cloud_accounts.latest_linked_saa_s 
@resource_group_name='{{ resource_group_name }}' --required, 
@cloud_account_name='{{ cloud_account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;