@azure/arm-commvaultcontentstore package

Classes

ContentStoreClient

Interfaces

ActivateSaaSParameterRequest	SaaS guid for Activate and Validate SaaS Resource
BackupOptions	The backup options for the VM backup
BackupProtectionGroupRequest	The properties of BackupProtectionGroupRequest
BackupProtectionGroupResponse	Backup job response for a Protection Group
CloudAccount	A Commvault Cloud Account Resource
CloudAccountProperties	Properties specific to Commvault Cloud Account resource
CloudAccountUpdate	The type used for update operations of the CloudAccount.
CloudAccountUpdateProperties	The updatable properties of the CloudAccount.
CloudAccountsCreateOrUpdateOptionalParams	Optional parameters.
CloudAccountsDeleteOptionalParams	Optional parameters.
CloudAccountsGetOptionalParams	Optional parameters.
CloudAccountsLatestLinkedSaaSOptionalParams	Optional parameters.
CloudAccountsLinkSaaSOptionalParams	Optional parameters.
CloudAccountsListByResourceGroupOptionalParams	Optional parameters.
CloudAccountsListBySubscriptionOptionalParams	Optional parameters.
CloudAccountsOperations	Interface representing a CloudAccounts operations.
CloudAccountsUpdateOptionalParams	Optional parameters.
CommvaultPlan	A Commvault Plan Resource
ContentStoreClientOptionalParams	Optional parameters for the client.
CountProtectedItemsRequest	Request to count protected items for the provided CCA resource IDs across subscriptions.
CountProtectedItemsResponse	Response for count protected items operation.
EntityInfo	Information about an Entra entity (user or group) assigned to a role
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
ExtendedRetentionTime	Extended Retention Time
LatestLinkedSaaSResponse	Response of get latest linked SaaS resource operation
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
MarketplaceDetails	Marketplace details for an organization
OfferDetails	Offer details for the marketplace that is selected by the user
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PlanProperties	The properties of Commvault Plan
PlansCreateOrupdateOptionalParams	Optional parameters.
PlansDeleteOptionalParams	Optional parameters.
PlansGetOptionalParams	Optional parameters.
PlansListByCloudAccountOptionalParams	Optional parameters.
PlansOperations	Interface representing a Plans operations.
ProtectedItem	Concrete proxy resource types can be created by aliasing this type using a specific property type.
ProtectedItemProperties	The properties of Commvault Protected Item
ProtectedItemsGetOptionalParams	Optional parameters.
ProtectedItemsGetRestorePointsOptionalParams	Optional parameters.
ProtectedItemsListByProtectionGroupOptionalParams	Optional parameters.
ProtectedItemsOperationGroupCountByProtectionGroupsOptionalParams	Optional parameters.
ProtectedItemsOperationGroupOperations	Interface representing a ProtectedItemsOperationGroup operations.
ProtectedItemsOperations	Interface representing a ProtectedItems operations.
ProtectedItemsRestoreOptionalParams	Optional parameters.
ProtectionGroup	A Commvault Plan Resource
ProtectionGroupProperties	The properties of Commvault Protection Group
ProtectionGroupResources	The resources to be protected under Protection Group
ProtectionGroupsBackupOptionalParams	Optional parameters.
ProtectionGroupsCreateOrupdateOptionalParams	Optional parameters.
ProtectionGroupsDeleteOptionalParams	Optional parameters.
ProtectionGroupsGetOptionalParams	Optional parameters.
ProtectionGroupsListByCloudAccountOptionalParams	Optional parameters.
ProtectionGroupsOperations	Interface representing a ProtectionGroups operations.
ProtectionGroupsRestoreOptionalParams	Optional parameters.
ProtectionGroupsResumeBackupOptionalParams	Optional parameters.
ProtectionGroupsStopBackupOptionalParams	Optional parameters.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePoints	Restore points of a Protected Item
RestorePollerOptions
RestoreProtectionItemRequest	The properties of RestoreProtectionItemRequest
RestoreProtectionItemResponse	Restore resource response for a Protected Item
Retention	A Commvault Plan Retention Model
RoleAssignment	A role assignment mapping a Commvault role to one or more Entra entities (users or groups)
RoleMapping	A Commvault Role Mapping Resource. Singleton per Cloud Account - maps Entra security groups to Commvault roles for RBAC enforcement.
RoleMappingProperties	The properties of Commvault Role Mapping
RoleMappingsCreateOrUpdateOptionalParams	Optional parameters.
RoleMappingsDeleteOptionalParams	Optional parameters.
RoleMappingsGetOptionalParams	Optional parameters.
RoleMappingsListOptionalParams	Optional parameters.
RoleMappingsOperations	Interface representing a RoleMappings operations.
Rule	The rules to match resources
SaaSData	SaaS-related data properties
SaaSOperationGroupActivateResourceOptionalParams	Optional parameters.
SaaSOperationGroupOperations	Interface representing a SaaSOperationGroup operations.
SaaSResourceDetailsResponse	Marketplace SaaS resource details.
Schedule	A Commvault Plan Schedule Model
StopBackupProtectionGroupRequest	The properties of StopBackupProtectionGroupRequest
Storage	A Commvault Storage Resource
StoragePlan	The properties of Commvault Storage Plan
StorageProperties	The properties of Commvault Storage
StoragesCreateOrUpdateOptionalParams	Optional parameters.
StoragesDeleteOptionalParams	Optional parameters.
StoragesGetOptionalParams	Optional parameters.
StoragesListByCloudAccountOptionalParams	Optional parameters.
StoragesOperations	Interface representing a Storages operations.
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UserAssignedIdentity	User assigned identity properties
UserDetails	User details for an organization
VmDestinationInfo	The properties of VmDestinationInfo
VmInfo	The properties of information of a VM
VmListItem	The VM list item for backup
VmTag	The properties of VMTag for Restore Request

Type Aliases

ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
BackUpType	The type of backup KnownBackUpType can be used interchangeably with BackUpType, this enum contains the known values that the service supports. Known values supported by the service INCREMENTAL: Incremental backup FULL: Full backup BOTH: Both incremental and full backups
BackupLevel	The level of backup KnownBackupLevel can be used interchangeably with BackupLevel, this enum contains the known values that the service supports. Known values supported by the service FULL: Full backup level INCREMENTAL: Incremental backup level DIFFERENTIAL: Differential backup level SYNTHETIC_FULL: Synthetic full backup level
BackupRuleType	The type of backup rule KnownBackupRuleType can be used interchangeably with BackupRuleType, this enum contains the known values that the service supports. Known values supported by the service ALL_JOBS: All Jobs ALL_FULLS: All Fulls HOURLY_FULLS: Hourly Fulls DAILY_FULLS: Daily Fulls WEEKLY_FULLS: Weekly Fulls MONTHLY_FULLS: Monthly Fulls YEARLY_FULLS: Yearly Fulls QUARTERLY_FULLS: Quarterly Fulls HALF_YEARLY_FULLS: Half Yearly Fulls
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
DayOfWeek	The Day of Week Enum KnownDayOfWeek can be used interchangeably with DayOfWeek, this enum contains the known values that the service supports. Known values supported by the service SUNDAY: First Day of the Week MONDAY: Second Day of the Week TUESDAY: Third Day of the Week WEDNESDAY: Fourth Day of the Week THURSDAY: Fifth Day of the Week FRIDAY: Sixth Day of the Week SATURDAY: Seventh Day of the Week DAY: Any Day of the week WEEKDAY: Weekday Identifier WEEKEND_DAYS: Weekend Identifier
EntityType	The type of the entity KnownEntityType can be used interchangeably with EntityType, this enum contains the known values that the service supports. Known values supported by the service User: The entity is an Entra user Group: The entity is an Entra security group
Frequency	The frequency of backups KnownFrequency can be used interchangeably with Frequency, this enum contains the known values that the service supports. Known values supported by the service daily: Daily backups weekly: Weekly backups monthly: Monthly backups yearly: Yearly backups minutes: Minutes backups
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: No managed identity. SystemAssigned: System assigned managed identity. UserAssigned: User assigned managed identity. SystemAssigned,UserAssigned: System and user assigned managed identity.
MarketplaceSubscriptionStatus	Marketplace subscription status of a resource. KnownMarketplaceSubscriptionStatus can be used interchangeably with MarketplaceSubscriptionStatus, this enum contains the known values that the service supports. Known values supported by the service PendingFulfillmentStart: Purchased but not yet activated Subscribed: Marketplace subscription is activated Suspended: This state indicates that a customer's payment for the Marketplace service was not received Unsubscribed: Customer has cancelled the subscription
MatchType	The match type KnownMatchType can be used interchangeably with MatchType, this enum contains the known values that the service supports. Known values supported by the service all: All rules should match any: Any rule should match
MonthOfYear	The Month of Year Enum KnownMonthOfYear can be used interchangeably with MonthOfYear, this enum contains the known values that the service supports. Known values supported by the service JANUARY: First Month of the Year FEBRUARY: Second Month of the Year MARCH: Third Month of the Year APRIL: Fourth Month of the Year MAY: Fifth Month of the Year JUNE: Sixth Month of the Year JULY: Seventh Month of the Year AUGUST: Eighth Month of the Year SEPTEMBER: Ninth Month of the Year OCTOBER: Tenth Month of the Year NOVEMBER: Eleventh Month of the Year DECEMBER: Twelfth Month of the Year
Operator	The types of operator KnownOperator can be used interchangeably with Operator, this enum contains the known values that the service supports. Known values supported by the service contains: The operator contains doesNotContains: The operator does not contains doesNotEqual: The operator does not equal startsWith: The operator starts with endsWith: The operator ends with equals: The operator equals
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
ProtectionStatus	The Protection Status KnownProtectionStatus can be used interchangeably with ProtectionStatus, this enum contains the known values that the service supports. Known values supported by the service all: The protection group status is All protected: The protection group status is Protected not_protected: The protection group status is Not Protected pending: The protection group status is Pending backed_up_with_error: The protection group status is backed_up_with_error discovered: The protection group status is discovered
ResourceProvisioningState	The provisioning state of a resource type. KnownResourceProvisioningState can be used interchangeably with ResourceProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Resource has been created. Failed: Resource creation failed. Canceled: Resource creation was canceled.
RestoreType	Types of Restore Supported KnownRestoreType can be used interchangeably with RestoreType, this enum contains the known values that the service supports. Known values supported by the service NONE: Azure In place Restore VIRTUAL_MACHINE: Azure Out of Place DISK_ATTACH: Azure Attach disk restore to existing VM
RetentionTime	The retention time for Commvault Plan KnownRetentionTime can be used interchangeably with RetentionTime, this enum contains the known values that the service supports. Known values supported by the service monthly: Monthly retention time yearly: Yearly retention time
RoleName	Supported Commvault role names KnownRoleName can be used interchangeably with RoleName, this enum contains the known values that the service supports. Known values supported by the service BackupAdmin: Backup Administrator - full access to all resources BackupOperator: Backup Operator - can manage resources but cannot delete storage or plans BackupUser: Backup User - can manage protection groups, read-only on plans and storage SecurityAdmin: Security Administrator - can manage CCA enrollment and user management MultiPersonAuthorization: MPA Administrator - can authorize critical operations protected by MPA
RuleProperty	The Rule property KnownRuleProperty can be used interchangeably with RuleProperty, this enum contains the known values that the service supports. Known values supported by the service resourceGroup: The resource group of the rule name: The name of the rule tagName: The tag name of the rule tagValue: The tag value of the rule region: The region of the rule status: The status of the rule
StorageClassType	Class of Commvault Storage KnownStorageClassType can be used interchangeably with StorageClassType, this enum contains the known values that the service supports. Known values supported by the service COLD: Cold storage class HOT: Hot storage class
StorageType	Storage Type of Commvault Storage KnownStorageType can be used interchangeably with StorageType, this enum contains the known values that the service supports. Known values supported by the service Air_Gap_Protect: Air Gap Protect
Vendor	Vendor of Commvault Storage KnownVendor can be used interchangeably with Vendor, this enum contains the known values that the service supports. Known values supported by the service Azure_Blob_Storage: Azure Blob Storage
WeekOfMonth	The Week of Month Enum KnownWeekOfMonth can be used interchangeably with WeekOfMonth, this enum contains the known values that the service supports. Known values supported by the service FIRST: First Week SECOND: Second Week THIRD: Third Week FOURTH: Fourth Week LAST: LAST Week
WeeklyDays	To represent the days of the week in Weekly type KnownWeeklyDays can be used interchangeably with WeeklyDays, this enum contains the known values that the service supports. Known values supported by the service SUNDAY: First Day of the Week MONDAY: Second Day of the Week TUESDAY: Third Day of the Week WEDNESDAY: Fourth Day of the Week THURSDAY: Fifth Day of the Week FRIDAY: Sixth Day of the Week SATURDAY: Seventh Day of the Week

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownBackUpType	The type of backup
KnownBackupLevel	The level of backup
KnownBackupRuleType	The type of backup rule
KnownCreatedByType	The kind of entity that created the resource.
KnownDayOfWeek	The Day of Week Enum
KnownEntityType	The type of the entity
KnownFrequency	The frequency of backups
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownMarketplaceSubscriptionStatus	Marketplace subscription status of a resource.
KnownMatchType	The match type
KnownMonthOfYear	The Month of Year Enum
KnownOperator	The types of operator
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownProtectionStatus	The Protection Status
KnownResourceProvisioningState	The provisioning state of a resource type.
KnownRestoreType	Types of Restore Supported
KnownRetentionTime	The retention time for Commvault Plan
KnownRoleName	Supported Commvault role names
KnownRuleProperty	The Rule property
KnownStorageClassType	Class of Commvault Storage
KnownStorageType	Storage Type of Commvault Storage
KnownVendor	Vendor of Commvault Storage
KnownVersions	Supported API versions for the Commvault.ContentStore resource provider.
KnownWeekOfMonth	The Week of Month Enum
KnownWeeklyDays	To represent the days of the week in Weekly type

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(ContentStoreClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(ContentStoreClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: ContentStoreClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

ContentStoreClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor