From d742ab0d605d9fc0bc90f2a0e1f68b39e80d2f3d Mon Sep 17 00:00:00 2001 From: Saurabh Jaiswal Date: Tue, 27 Oct 2026 01:29:14 +0530 Subject: [PATCH 1/2] [Az.Commvault] Add the Az.Commvault module for Commvault.ContentStore API 2026-09-30 Autorest-generated module (0.1.0) for the Azure Native ISV service Liftr-Commvault: 34 cmdlets for cloud accounts, plans, storages, protection groups, role mappings and protected items, with examples, help, UX metadata and test stubs. Generated from azure-rest-api-specs commit e91f0b95 (tag package-2026-09-30). Adds the module to tools/CreateMappings_rules.json. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- .../Commvault.Autorest/.gitattributes | 1 + src/Commvault/Commvault.Autorest/.gitignore | 16 + .../Properties/AssemblyInfo.cs | 28 + src/Commvault/Commvault.Autorest/README.md | 153 +++++ .../cloudAccounts-plans.json | 95 +++ ...ounts-protectionGroups-protectedItems.json | 105 +++ .../cloudAccounts-protectionGroups.json | 138 ++++ .../cloudAccounts-storages.json | 224 +++++++ .../Commvault.ContentStore/cloudAccounts.json | 199 ++++++ .../custom/Az.Commvault.custom.psm1 | 17 + .../Commvault.Autorest/custom/README.md | 41 ++ .../Commvault.Autorest/docs/Az.Commvault.md | 119 ++++ .../docs/Backup-AzCommvaultProtectionGroup.md | 385 +++++++++++ .../Connect-AzCommvaultCloudAccountSaaS.md | 291 ++++++++ ...isable-AzCommvaultStorageComplianceLock.md | 206 ++++++ ...Enable-AzCommvaultStorageComplianceLock.md | 203 ++++++ .../docs/Get-AzCommvaultCloudAccount.md | 158 +++++ ...AzCommvaultCloudAccountLatestLinkedSaaS.md | 133 ++++ .../docs/Get-AzCommvaultPlan.md | 181 +++++ .../docs/Get-AzCommvaultProtectedItem.md | 218 ++++++ .../docs/Get-AzCommvaultProtectedItemCount.md | 147 ++++ ...et-AzCommvaultProtectedItemRestorePoint.md | 206 ++++++ .../docs/Get-AzCommvaultProtectionGroup.md | 182 +++++ .../docs/Get-AzCommvaultRoleMapping.md | 133 ++++ .../docs/Get-AzCommvaultStorage.md | 181 +++++ .../docs/Initialize-AzCommvaultSaaS.md | 456 +++++++++++++ .../docs/New-AzCommvaultCloudAccount.md | 633 ++++++++++++++++++ .../docs/New-AzCommvaultPlan.md | 325 +++++++++ .../docs/New-AzCommvaultProtectionGroup.md | 324 +++++++++ .../docs/New-AzCommvaultRoleMapping.md | 209 ++++++ .../docs/New-AzCommvaultStorage.md | 292 ++++++++ .../Commvault.Autorest/docs/README.md | 11 + .../docs/Remove-AzCommvaultCloudAccount.md | 209 ++++++ .../docs/Remove-AzCommvaultPlan.md | 246 +++++++ .../docs/Remove-AzCommvaultProtectionGroup.md | 246 +++++++ .../docs/Remove-AzCommvaultRoleMapping.md | 179 +++++ .../docs/Remove-AzCommvaultStorage.md | 246 +++++++ .../docs/Restore-AzCommvaultProtectedItem.md | 397 +++++++++++ .../Restore-AzCommvaultProtectionGroup.md | 351 ++++++++++ ...Resume-AzCommvaultProtectionGroupBackup.md | 217 ++++++ .../Stop-AzCommvaultProtectionGroupBackup.md | 366 ++++++++++ .../docs/Sync-AzCommvaultStorage.md | 202 ++++++ .../docs/Update-AzCommvaultCloudAccount.md | 576 ++++++++++++++++ .../docs/Update-AzCommvaultPlan.md | 271 ++++++++ .../docs/Update-AzCommvaultProtectionGroup.md | 301 +++++++++ .../docs/Update-AzCommvaultRoleMapping.md | 183 +++++ .../docs/Update-AzCommvaultStorage.md | 247 +++++++ .../Backup-AzCommvaultProtectionGroup.md | 14 + .../Connect-AzCommvaultCloudAccountSaaS.md | 14 + ...isable-AzCommvaultStorageComplianceLock.md | 8 + ...Enable-AzCommvaultStorageComplianceLock.md | 7 + .../examples/Get-AzCommvaultCloudAccount.md | 21 + ...AzCommvaultCloudAccountLatestLinkedSaaS.md | 7 + .../examples/Get-AzCommvaultPlan.md | 14 + .../examples/Get-AzCommvaultProtectedItem.md | 14 + .../Get-AzCommvaultProtectedItemCount.md | 14 + ...et-AzCommvaultProtectedItemRestorePoint.md | 7 + .../Get-AzCommvaultProtectionGroup.md | 14 + .../examples/Get-AzCommvaultRoleMapping.md | 8 + .../examples/Get-AzCommvaultStorage.md | 14 + .../examples/Initialize-AzCommvaultSaaS.md | 14 + .../examples/New-AzCommvaultCloudAccount.md | 25 + .../examples/New-AzCommvaultPlan.md | 16 + .../New-AzCommvaultProtectionGroup.md | 15 + .../examples/New-AzCommvaultRoleMapping.md | 18 + .../examples/New-AzCommvaultStorage.md | 14 + .../Remove-AzCommvaultCloudAccount.md | 7 + .../examples/Remove-AzCommvaultPlan.md | 7 + .../Remove-AzCommvaultProtectionGroup.md | 7 + .../examples/Remove-AzCommvaultRoleMapping.md | 7 + .../examples/Remove-AzCommvaultStorage.md | 7 + .../Restore-AzCommvaultProtectedItem.md | 14 + .../Restore-AzCommvaultProtectionGroup.md | 14 + ...Resume-AzCommvaultProtectionGroupBackup.md | 7 + .../Stop-AzCommvaultProtectionGroupBackup.md | 14 + .../examples/Sync-AzCommvaultStorage.md | 7 + .../Update-AzCommvaultCloudAccount.md | 14 + .../examples/Update-AzCommvaultPlan.md | 15 + .../Update-AzCommvaultProtectionGroup.md | 14 + .../examples/Update-AzCommvaultRoleMapping.md | 10 + .../examples/Update-AzCommvaultStorage.md | 7 + .../Commvault.Autorest/generate-info.json | 3 + src/Commvault/Commvault.Autorest/how-to.md | 58 ++ .../Commvault.Autorest/resources/README.md | 11 + ...ackup-AzCommvaultProtectionGroup.Tests.ps1 | 49 ++ ...nect-AzCommvaultCloudAccountSaaS.Tests.ps1 | 41 ++ ...AzCommvaultStorageComplianceLock.Tests.ps1 | 29 + ...AzCommvaultStorageComplianceLock.Tests.ps1 | 29 + .../Get-AzCommvaultCloudAccount.Tests.ps1 | 33 + ...aultCloudAccountLatestLinkedSaaS.Tests.ps1 | 25 + .../test/Get-AzCommvaultPlan.Tests.ps1 | 33 + .../Get-AzCommvaultProtectedItem.Tests.ps1 | 37 + ...et-AzCommvaultProtectedItemCount.Tests.ps1 | 33 + ...mmvaultProtectedItemRestorePoint.Tests.ps1 | 33 + .../Get-AzCommvaultProtectionGroup.Tests.ps1 | 33 + .../test/Get-AzCommvaultRoleMapping.Tests.ps1 | 25 + .../test/Get-AzCommvaultStorage.Tests.ps1 | 33 + .../test/Initialize-AzCommvaultSaaS.Tests.ps1 | 33 + .../New-AzCommvaultCloudAccount.Tests.ps1 | 29 + .../test/New-AzCommvaultPlan.Tests.ps1 | 33 + .../New-AzCommvaultProtectionGroup.Tests.ps1 | 33 + .../test/New-AzCommvaultRoleMapping.Tests.ps1 | 29 + .../test/New-AzCommvaultStorage.Tests.ps1 | 33 + .../Commvault.Autorest/test/README.md | 17 + .../Remove-AzCommvaultCloudAccount.Tests.ps1 | 25 + .../test/Remove-AzCommvaultPlan.Tests.ps1 | 29 + ...emove-AzCommvaultProtectionGroup.Tests.ps1 | 29 + .../Remove-AzCommvaultRoleMapping.Tests.ps1 | 25 + .../test/Remove-AzCommvaultStorage.Tests.ps1 | 29 + ...Restore-AzCommvaultProtectedItem.Tests.ps1 | 57 ++ ...store-AzCommvaultProtectionGroup.Tests.ps1 | 49 ++ ...AzCommvaultProtectionGroupBackup.Tests.ps1 | 29 + ...AzCommvaultProtectionGroupBackup.Tests.ps1 | 49 ++ .../test/Sync-AzCommvaultStorage.Tests.ps1 | 29 + .../Update-AzCommvaultCloudAccount.Tests.ps1 | 25 + .../test/Update-AzCommvaultPlan.Tests.ps1 | 29 + ...pdate-AzCommvaultProtectionGroup.Tests.ps1 | 29 + .../Update-AzCommvaultRoleMapping.Tests.ps1 | 25 + .../test/Update-AzCommvaultStorage.Tests.ps1 | 29 + .../Commvault.Autorest/test/loadEnv.ps1 | 29 + .../Commvault.Autorest/test/utils.ps1 | 56 ++ .../utils/Get-SubscriptionIdTestSafe.ps1 | 7 + .../utils/Unprotect-SecureString.ps1 | 16 + src/Commvault/Commvault.sln | 74 ++ src/Commvault/Commvault/Az.Commvault.psd1 | 154 +++++ src/Commvault/Commvault/ChangeLog.md | 30 + src/Commvault/Commvault/Commvault.csproj | 28 + .../Commvault/Properties/AssemblyInfo.cs | 28 + src/Commvault/Commvault/help/Az.Commvault.md | 119 ++++ .../help/Backup-AzCommvaultProtectionGroup.md | 385 +++++++++++ .../Connect-AzCommvaultCloudAccountSaaS.md | 292 ++++++++ ...isable-AzCommvaultStorageComplianceLock.md | 205 ++++++ ...Enable-AzCommvaultStorageComplianceLock.md | 202 ++++++ .../help/Get-AzCommvaultCloudAccount.md | 158 +++++ ...AzCommvaultCloudAccountLatestLinkedSaaS.md | 133 ++++ .../Commvault/help/Get-AzCommvaultPlan.md | 182 +++++ .../help/Get-AzCommvaultProtectedItem.md | 220 ++++++ .../help/Get-AzCommvaultProtectedItemCount.md | 149 +++++ ...et-AzCommvaultProtectedItemRestorePoint.md | 207 ++++++ .../help/Get-AzCommvaultProtectionGroup.md | 183 +++++ .../help/Get-AzCommvaultRoleMapping.md | 133 ++++ .../Commvault/help/Get-AzCommvaultStorage.md | 182 +++++ .../help/Initialize-AzCommvaultSaaS.md | 457 +++++++++++++ .../help/New-AzCommvaultCloudAccount.md | 632 +++++++++++++++++ .../Commvault/help/New-AzCommvaultPlan.md | 325 +++++++++ .../help/New-AzCommvaultProtectionGroup.md | 324 +++++++++ .../help/New-AzCommvaultRoleMapping.md | 211 ++++++ .../Commvault/help/New-AzCommvaultStorage.md | 291 ++++++++ .../help/Remove-AzCommvaultCloudAccount.md | 209 ++++++ .../Commvault/help/Remove-AzCommvaultPlan.md | 246 +++++++ .../help/Remove-AzCommvaultProtectionGroup.md | 246 +++++++ .../help/Remove-AzCommvaultRoleMapping.md | 179 +++++ .../help/Remove-AzCommvaultStorage.md | 246 +++++++ .../help/Restore-AzCommvaultProtectedItem.md | 396 +++++++++++ .../Restore-AzCommvaultProtectionGroup.md | 351 ++++++++++ ...Resume-AzCommvaultProtectionGroupBackup.md | 216 ++++++ .../Stop-AzCommvaultProtectionGroupBackup.md | 370 ++++++++++ .../Commvault/help/Sync-AzCommvaultStorage.md | 202 ++++++ .../help/Update-AzCommvaultCloudAccount.md | 577 ++++++++++++++++ .../Commvault/help/Update-AzCommvaultPlan.md | 271 ++++++++ .../help/Update-AzCommvaultProtectionGroup.md | 301 +++++++++ .../help/Update-AzCommvaultRoleMapping.md | 182 +++++ .../help/Update-AzCommvaultStorage.md | 247 +++++++ tools/CreateMappings_rules.json | 4 + 164 files changed, 21510 insertions(+) create mode 100644 src/Commvault/Commvault.Autorest/.gitattributes create mode 100644 src/Commvault/Commvault.Autorest/.gitignore create mode 100644 src/Commvault/Commvault.Autorest/Properties/AssemblyInfo.cs create mode 100644 src/Commvault/Commvault.Autorest/README.md create mode 100644 src/Commvault/Commvault.Autorest/UX/Commvault.ContentStore/cloudAccounts-plans.json create mode 100644 src/Commvault/Commvault.Autorest/UX/Commvault.ContentStore/cloudAccounts-protectionGroups-protectedItems.json create mode 100644 src/Commvault/Commvault.Autorest/UX/Commvault.ContentStore/cloudAccounts-protectionGroups.json create mode 100644 src/Commvault/Commvault.Autorest/UX/Commvault.ContentStore/cloudAccounts-storages.json create mode 100644 src/Commvault/Commvault.Autorest/UX/Commvault.ContentStore/cloudAccounts.json create mode 100644 src/Commvault/Commvault.Autorest/custom/Az.Commvault.custom.psm1 create mode 100644 src/Commvault/Commvault.Autorest/custom/README.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Az.Commvault.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Backup-AzCommvaultProtectionGroup.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Connect-AzCommvaultCloudAccountSaaS.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Disable-AzCommvaultStorageComplianceLock.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Enable-AzCommvaultStorageComplianceLock.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultCloudAccount.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultCloudAccountLatestLinkedSaaS.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultPlan.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultProtectedItem.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultProtectedItemCount.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultProtectedItemRestorePoint.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultProtectionGroup.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultRoleMapping.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultStorage.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Initialize-AzCommvaultSaaS.md create mode 100644 src/Commvault/Commvault.Autorest/docs/New-AzCommvaultCloudAccount.md create mode 100644 src/Commvault/Commvault.Autorest/docs/New-AzCommvaultPlan.md create mode 100644 src/Commvault/Commvault.Autorest/docs/New-AzCommvaultProtectionGroup.md create mode 100644 src/Commvault/Commvault.Autorest/docs/New-AzCommvaultRoleMapping.md create mode 100644 src/Commvault/Commvault.Autorest/docs/New-AzCommvaultStorage.md create mode 100644 src/Commvault/Commvault.Autorest/docs/README.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Remove-AzCommvaultCloudAccount.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Remove-AzCommvaultPlan.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Remove-AzCommvaultProtectionGroup.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Remove-AzCommvaultRoleMapping.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Remove-AzCommvaultStorage.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Restore-AzCommvaultProtectedItem.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Restore-AzCommvaultProtectionGroup.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Resume-AzCommvaultProtectionGroupBackup.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Stop-AzCommvaultProtectionGroupBackup.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Sync-AzCommvaultStorage.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Update-AzCommvaultCloudAccount.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Update-AzCommvaultPlan.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Update-AzCommvaultProtectionGroup.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Update-AzCommvaultRoleMapping.md create mode 100644 src/Commvault/Commvault.Autorest/docs/Update-AzCommvaultStorage.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Backup-AzCommvaultProtectionGroup.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Connect-AzCommvaultCloudAccountSaaS.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Disable-AzCommvaultStorageComplianceLock.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Enable-AzCommvaultStorageComplianceLock.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultCloudAccount.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultCloudAccountLatestLinkedSaaS.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultPlan.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultProtectedItem.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultProtectedItemCount.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultProtectedItemRestorePoint.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultProtectionGroup.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultRoleMapping.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultStorage.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Initialize-AzCommvaultSaaS.md create mode 100644 src/Commvault/Commvault.Autorest/examples/New-AzCommvaultCloudAccount.md create mode 100644 src/Commvault/Commvault.Autorest/examples/New-AzCommvaultPlan.md create mode 100644 src/Commvault/Commvault.Autorest/examples/New-AzCommvaultProtectionGroup.md create mode 100644 src/Commvault/Commvault.Autorest/examples/New-AzCommvaultRoleMapping.md create mode 100644 src/Commvault/Commvault.Autorest/examples/New-AzCommvaultStorage.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Remove-AzCommvaultCloudAccount.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Remove-AzCommvaultPlan.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Remove-AzCommvaultProtectionGroup.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Remove-AzCommvaultRoleMapping.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Remove-AzCommvaultStorage.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Restore-AzCommvaultProtectedItem.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Restore-AzCommvaultProtectionGroup.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Resume-AzCommvaultProtectionGroupBackup.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Stop-AzCommvaultProtectionGroupBackup.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Sync-AzCommvaultStorage.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Update-AzCommvaultCloudAccount.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Update-AzCommvaultPlan.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Update-AzCommvaultProtectionGroup.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Update-AzCommvaultRoleMapping.md create mode 100644 src/Commvault/Commvault.Autorest/examples/Update-AzCommvaultStorage.md create mode 100644 src/Commvault/Commvault.Autorest/generate-info.json create mode 100644 src/Commvault/Commvault.Autorest/how-to.md create mode 100644 src/Commvault/Commvault.Autorest/resources/README.md create mode 100644 src/Commvault/Commvault.Autorest/test/Backup-AzCommvaultProtectionGroup.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Connect-AzCommvaultCloudAccountSaaS.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Disable-AzCommvaultStorageComplianceLock.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Enable-AzCommvaultStorageComplianceLock.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Get-AzCommvaultCloudAccount.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Get-AzCommvaultCloudAccountLatestLinkedSaaS.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Get-AzCommvaultPlan.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Get-AzCommvaultProtectedItem.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Get-AzCommvaultProtectedItemCount.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Get-AzCommvaultProtectedItemRestorePoint.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Get-AzCommvaultProtectionGroup.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Get-AzCommvaultRoleMapping.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Get-AzCommvaultStorage.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Initialize-AzCommvaultSaaS.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/New-AzCommvaultCloudAccount.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/New-AzCommvaultPlan.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/New-AzCommvaultProtectionGroup.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/New-AzCommvaultRoleMapping.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/New-AzCommvaultStorage.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/README.md create mode 100644 src/Commvault/Commvault.Autorest/test/Remove-AzCommvaultCloudAccount.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Remove-AzCommvaultPlan.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Remove-AzCommvaultProtectionGroup.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Remove-AzCommvaultRoleMapping.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Remove-AzCommvaultStorage.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Restore-AzCommvaultProtectedItem.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Restore-AzCommvaultProtectionGroup.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Resume-AzCommvaultProtectionGroupBackup.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Stop-AzCommvaultProtectionGroupBackup.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Sync-AzCommvaultStorage.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Update-AzCommvaultCloudAccount.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Update-AzCommvaultPlan.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Update-AzCommvaultProtectionGroup.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Update-AzCommvaultRoleMapping.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/Update-AzCommvaultStorage.Tests.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/loadEnv.ps1 create mode 100644 src/Commvault/Commvault.Autorest/test/utils.ps1 create mode 100644 src/Commvault/Commvault.Autorest/utils/Get-SubscriptionIdTestSafe.ps1 create mode 100644 src/Commvault/Commvault.Autorest/utils/Unprotect-SecureString.ps1 create mode 100644 src/Commvault/Commvault.sln create mode 100644 src/Commvault/Commvault/Az.Commvault.psd1 create mode 100644 src/Commvault/Commvault/ChangeLog.md create mode 100644 src/Commvault/Commvault/Commvault.csproj create mode 100644 src/Commvault/Commvault/Properties/AssemblyInfo.cs create mode 100644 src/Commvault/Commvault/help/Az.Commvault.md create mode 100644 src/Commvault/Commvault/help/Backup-AzCommvaultProtectionGroup.md create mode 100644 src/Commvault/Commvault/help/Connect-AzCommvaultCloudAccountSaaS.md create mode 100644 src/Commvault/Commvault/help/Disable-AzCommvaultStorageComplianceLock.md create mode 100644 src/Commvault/Commvault/help/Enable-AzCommvaultStorageComplianceLock.md create mode 100644 src/Commvault/Commvault/help/Get-AzCommvaultCloudAccount.md create mode 100644 src/Commvault/Commvault/help/Get-AzCommvaultCloudAccountLatestLinkedSaaS.md create mode 100644 src/Commvault/Commvault/help/Get-AzCommvaultPlan.md create mode 100644 src/Commvault/Commvault/help/Get-AzCommvaultProtectedItem.md create mode 100644 src/Commvault/Commvault/help/Get-AzCommvaultProtectedItemCount.md create mode 100644 src/Commvault/Commvault/help/Get-AzCommvaultProtectedItemRestorePoint.md create mode 100644 src/Commvault/Commvault/help/Get-AzCommvaultProtectionGroup.md create mode 100644 src/Commvault/Commvault/help/Get-AzCommvaultRoleMapping.md create mode 100644 src/Commvault/Commvault/help/Get-AzCommvaultStorage.md create mode 100644 src/Commvault/Commvault/help/Initialize-AzCommvaultSaaS.md create mode 100644 src/Commvault/Commvault/help/New-AzCommvaultCloudAccount.md create mode 100644 src/Commvault/Commvault/help/New-AzCommvaultPlan.md create mode 100644 src/Commvault/Commvault/help/New-AzCommvaultProtectionGroup.md create mode 100644 src/Commvault/Commvault/help/New-AzCommvaultRoleMapping.md create mode 100644 src/Commvault/Commvault/help/New-AzCommvaultStorage.md create mode 100644 src/Commvault/Commvault/help/Remove-AzCommvaultCloudAccount.md create mode 100644 src/Commvault/Commvault/help/Remove-AzCommvaultPlan.md create mode 100644 src/Commvault/Commvault/help/Remove-AzCommvaultProtectionGroup.md create mode 100644 src/Commvault/Commvault/help/Remove-AzCommvaultRoleMapping.md create mode 100644 src/Commvault/Commvault/help/Remove-AzCommvaultStorage.md create mode 100644 src/Commvault/Commvault/help/Restore-AzCommvaultProtectedItem.md create mode 100644 src/Commvault/Commvault/help/Restore-AzCommvaultProtectionGroup.md create mode 100644 src/Commvault/Commvault/help/Resume-AzCommvaultProtectionGroupBackup.md create mode 100644 src/Commvault/Commvault/help/Stop-AzCommvaultProtectionGroupBackup.md create mode 100644 src/Commvault/Commvault/help/Sync-AzCommvaultStorage.md create mode 100644 src/Commvault/Commvault/help/Update-AzCommvaultCloudAccount.md create mode 100644 src/Commvault/Commvault/help/Update-AzCommvaultPlan.md create mode 100644 src/Commvault/Commvault/help/Update-AzCommvaultProtectionGroup.md create mode 100644 src/Commvault/Commvault/help/Update-AzCommvaultRoleMapping.md create mode 100644 src/Commvault/Commvault/help/Update-AzCommvaultStorage.md diff --git a/src/Commvault/Commvault.Autorest/.gitattributes b/src/Commvault/Commvault.Autorest/.gitattributes new file mode 100644 index 000000000000..2125666142eb --- /dev/null +++ b/src/Commvault/Commvault.Autorest/.gitattributes @@ -0,0 +1 @@ +* text=auto \ No newline at end of file diff --git a/src/Commvault/Commvault.Autorest/.gitignore b/src/Commvault/Commvault.Autorest/.gitignore new file mode 100644 index 000000000000..6ec158bd9768 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/.gitignore @@ -0,0 +1,16 @@ +bin +obj +.vs +generated +internal +exports +tools +test/*-TestResults.xml +license.txt +/*.ps1 +/*.psd1 +/*.ps1xml +/*.psm1 +/*.snk +/*.csproj +/*.nuspec \ No newline at end of file diff --git a/src/Commvault/Commvault.Autorest/Properties/AssemblyInfo.cs b/src/Commvault/Commvault.Autorest/Properties/AssemblyInfo.cs new file mode 100644 index 000000000000..6bb3114f0456 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/Properties/AssemblyInfo.cs @@ -0,0 +1,28 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the Apache License, Version 2.0 (the ""License""); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an ""AS IS"" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code +// is regenerated. + +using System; +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; + +[assembly: System.Reflection.AssemblyCompanyAttribute("Microsoft")] +[assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")] +[assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")] +[assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - Commvault")] +[assembly: System.Reflection.AssemblyFileVersionAttribute("0.1.0")] +[assembly: System.Reflection.AssemblyVersionAttribute("0.1.0")] +[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)] +[assembly: System.CLSCompliantAttribute(false)] + + diff --git a/src/Commvault/Commvault.Autorest/README.md b/src/Commvault/Commvault.Autorest/README.md new file mode 100644 index 000000000000..fdd423f5b6db --- /dev/null +++ b/src/Commvault/Commvault.Autorest/README.md @@ -0,0 +1,153 @@ + +# Az.Commvault +This directory contains the PowerShell module for the Commvault service. + +--- +## Info +- Modifiable: yes +- Generated: all +- Committed: yes +- Packaged: yes + +--- +## Detail +This module was primarily generated via [AutoRest](https://github.com/Azure/autorest) using the [PowerShell](https://github.com/Azure/autorest.powershell) extension. + +## Module Requirements +- [Az.Accounts module](https://www.powershellgallery.com/packages/Az.Accounts/), version 2.7.5 or greater + +## Authentication +AutoRest does not generate authentication code for the module. Authentication is handled via Az.Accounts by altering the HTTP payload before it is sent. + +## Development +For information on how to develop for `Az.Commvault`, see [how-to.md](how-to.md). + + +### AutoRest Configuration + +> see https://aka.ms/autorest + +```yaml +# pin the swagger version by using the commit id instead of branch name +commit: e91f0b95c03a435a7d745e8c70930aadce552d39 +require: +# readme.azure.noprofile.md is the common configuration file + - $(this-folder)/../../readme.azure.noprofile.md + - $(repo)/specification/liftrcommvault/resource-manager/readme.md +# If the swagger has not been put in the repo, you may uncomment the following line and refer to it locally +# - (this-folder)/relative-path-to-your-local-readme.md + +try-require: + - $(repo)/specification/liftrcommvault/resource-manager/readme.powershell.md + +# generate from the stable API version +tag: package-2026-09-30 + +# For new RP, the version is 0.1.0 +module-version: 0.1.0 +# Normally, title is the service name +title: Commvault +service-name: Commvault +subject-prefix: Commvault + +directive: + # Following are common directives which are normally required in all the RPs + # 1. Remove the unexpanded parameter set + # 2. For New-* cmdlets, ViaIdentity is not required + + # Keep only the expanded, JsonFilePath and JsonString parameter sets of the create and update cmdlets. + - where: + variant: ^(Create|Update)(?!.*?(Expanded|JsonFilePath|JsonString)) + remove: true + # New-* cmdlets create a resource by name, so the ViaIdentity parameter sets are not needed. + - where: + variant: ^CreateViaIdentity$|^CreateViaIdentityExpanded$ + remove: true + + # Remove the set-* cmdlet. New-* and Update-* cover the same operations. + - where: + verb: Set + remove: true + + # The operationIds Plans_CreateOrupdate and ProtectionGroups_CreateOrupdate contain a typo in the swagger + # (lower-case "u"), which leaks into the cmdlet noun. Rename the nouns instead of changing the released API. + - where: + verb: New + subject: PlanOrupdate + set: + subject: Plan + # Same typo as above, for the protection group. + - where: + verb: New + subject: ProtectionGroupOrupdate + set: + subject: ProtectionGroup + + # The operation group name SaaSOperationGroup leaks into the cmdlet noun. Use a readable name. + - where: + verb: Initialize + subject: SaaSOperationGroupResource + set: + subject: SaaS + # The operation group name ProtectedItemsOperationGroup leaks into the cmdlet noun, and the count is a read-only POST. + - where: + verb: Invoke + subject: CountProtectedItemsOperationGroup + set: + verb: Get + subject: ProtectedItemCount + + # POST actions without a mapped verb are generated as Invoke-*. Use approved verbs that describe the action. + - where: + verb: Invoke + subject: LatestCloudAccountLinkedSaaS + set: + verb: Get + subject: CloudAccountLatestLinkedSaaS + # Linking a SaaS resource to the cloud account is a connect operation. + - where: + verb: Invoke + subject: LinkCloudAccountSaaS + set: + verb: Connect + subject: CloudAccountSaaS + + # The Refresh action maps to the Update verb and would share Update-AzCommvaultStorage with the PUT-based update. + - where: + verb: Update + subject: Storage + variant: ^Refresh + set: + verb: Sync + + # The parameter name Class ends with "s", which static analysis (rule 8410) reports as a plural noun. + # Use the name of the swagger enum type instead. + - where: + verb: New|Update + subject: Storage + parameter-name: Class + set: + parameter-name: StorageClassType + + # These cmdlets are POST operations that only read data. Hide -WhatIf and -Confirm because they have no side effects. + - where: + verb: Get + subject: CloudAccountLatestLinkedSaaS|ProtectedItemCount|ProtectedItemRestorePoint + set: + suppress-should-process: true + + # A cloud account has exactly one role mapping, named "default". The List parameter set has the same parameters as + # Get, so PowerShell can never select it. Remove it to keep the help unambiguous. + - where: + verb: Get + subject: RoleMapping + variant: ^List$ + remove: true + + # The swagger description of ProtectedItems_GetRestorePoints ("Limits used for creation of resources.") belongs to an + # unrelated operation and would become the cmdlet synopsis. Replace it with an accurate description. + - from: swagger-document + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Commvault.ContentStore/cloudAccounts/{cloudAccountName}/protectionGroups/{protectionGroupName}/protectedItems/{protectedItemName}/getRestorePoints"].post.description + transform: >- + return "Gets the restore points that are available for a protected item." +``` diff --git a/src/Commvault/Commvault.Autorest/UX/Commvault.ContentStore/cloudAccounts-plans.json b/src/Commvault/Commvault.Autorest/UX/Commvault.ContentStore/cloudAccounts-plans.json new file mode 100644 index 000000000000..52fbecefac62 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/UX/Commvault.ContentStore/cloudAccounts-plans.json @@ -0,0 +1,95 @@ +{ + "resourceType": "cloudAccounts/plans", + "apiVersion": "2026-09-30", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.commvault" + }, + "commands": [ + { + "name": "Get-AzCommvaultPlan", + "description": "Get a CommvaultPlan", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Commvault.ContentStore/cloudAccounts/{cloudAccountName}/plans/{planName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultplan" + }, + "parameterSets": [ + { + "parameters": [ + "-CloudAccountName ", + "-Name ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Get a CommvaultPlan", + "parameters": [ + { + "name": "-CloudAccountName", + "value": "[Path.cloudAccountName]" + }, + { + "name": "-Name", + "value": "[Path.planName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Remove-AzCommvaultPlan", + "description": "Delete a CommvaultPlan", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Commvault.ContentStore/cloudAccounts/{cloudAccountName}/plans/{planName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.commvault/remove-azcommvaultplan" + }, + "parameterSets": [ + { + "parameters": [ + "-CloudAccountName ", + "-Name ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Delete a CommvaultPlan", + "parameters": [ + { + "name": "-CloudAccountName", + "value": "[Path.cloudAccountName]" + }, + { + "name": "-Name", + "value": "[Path.planName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/Commvault/Commvault.Autorest/UX/Commvault.ContentStore/cloudAccounts-protectionGroups-protectedItems.json b/src/Commvault/Commvault.Autorest/UX/Commvault.ContentStore/cloudAccounts-protectionGroups-protectedItems.json new file mode 100644 index 000000000000..a76e2b43047a --- /dev/null +++ b/src/Commvault/Commvault.Autorest/UX/Commvault.ContentStore/cloudAccounts-protectionGroups-protectedItems.json @@ -0,0 +1,105 @@ +{ + "resourceType": "cloudAccounts/protectionGroups/protectedItems", + "apiVersion": "2026-09-30", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.commvault" + }, + "commands": [ + { + "name": "Get-AzCommvaultProtectedItemRestorePoint", + "description": "Gets the restore points that are available for a protected item.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Commvault.ContentStore/cloudAccounts/{cloudAccountName}/protectionGroups/{protectionGroupName}/protectedItems/{protectedItemName}/getRestorePoints", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultprotecteditemrestorepoint" + }, + "parameterSets": [ + { + "parameters": [ + "-CloudAccountName ", + "-ProtectedItemName ", + "-ProtectionGroupName ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Gets the restore points that are available for a protected item.", + "parameters": [ + { + "name": "-CloudAccountName", + "value": "[Path.cloudAccountName]" + }, + { + "name": "-ProtectedItemName", + "value": "[Path.protectedItemName]" + }, + { + "name": "-ProtectionGroupName", + "value": "[Path.protectionGroupName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Get-AzCommvaultProtectedItem", + "description": "Get a ProtectedItem", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Commvault.ContentStore/cloudAccounts/{cloudAccountName}/protectionGroups/{protectionGroupName}/protectedItems/{protectedItemName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultprotecteditem" + }, + "parameterSets": [ + { + "parameters": [ + "-CloudAccountName ", + "-Name ", + "-ProtectionGroupName ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Get a ProtectedItem", + "parameters": [ + { + "name": "-CloudAccountName", + "value": "[Path.cloudAccountName]" + }, + { + "name": "-Name", + "value": "[Path.protectedItemName]" + }, + { + "name": "-ProtectionGroupName", + "value": "[Path.protectionGroupName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/Commvault/Commvault.Autorest/UX/Commvault.ContentStore/cloudAccounts-protectionGroups.json b/src/Commvault/Commvault.Autorest/UX/Commvault.ContentStore/cloudAccounts-protectionGroups.json new file mode 100644 index 000000000000..5df8c7bb77e1 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/UX/Commvault.ContentStore/cloudAccounts-protectionGroups.json @@ -0,0 +1,138 @@ +{ + "resourceType": "cloudAccounts/protectionGroups", + "apiVersion": "2026-09-30", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.commvault" + }, + "commands": [ + { + "name": "Get-AzCommvaultProtectionGroup", + "description": "Get a ProtectionGroup", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Commvault.ContentStore/cloudAccounts/{cloudAccountName}/protectionGroups/{protectionGroupName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultprotectiongroup" + }, + "parameterSets": [ + { + "parameters": [ + "-CloudAccountName ", + "-Name ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Get a ProtectionGroup", + "parameters": [ + { + "name": "-CloudAccountName", + "value": "[Path.cloudAccountName]" + }, + { + "name": "-Name", + "value": "[Path.protectionGroupName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Remove-AzCommvaultProtectionGroup", + "description": "Delete a ProtectionGroup", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Commvault.ContentStore/cloudAccounts/{cloudAccountName}/protectionGroups/{protectionGroupName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.commvault/remove-azcommvaultprotectiongroup" + }, + "parameterSets": [ + { + "parameters": [ + "-CloudAccountName ", + "-Name ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Delete a ProtectionGroup", + "parameters": [ + { + "name": "-CloudAccountName", + "value": "[Path.cloudAccountName]" + }, + { + "name": "-Name", + "value": "[Path.protectionGroupName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Resume-AzCommvaultProtectionGroupBackup", + "description": "Resume Backup for a Protection Group.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Commvault.ContentStore/cloudAccounts/{cloudAccountName}/protectionGroups/{protectionGroupName}/resumeBackup", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.commvault/resume-azcommvaultprotectiongroupbackup" + }, + "parameterSets": [ + { + "parameters": [ + "-CloudAccountName ", + "-ProtectionGroupName ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Resume Backup for a Protection Group.", + "parameters": [ + { + "name": "-CloudAccountName", + "value": "[Path.cloudAccountName]" + }, + { + "name": "-ProtectionGroupName", + "value": "[Path.protectionGroupName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/Commvault/Commvault.Autorest/UX/Commvault.ContentStore/cloudAccounts-storages.json b/src/Commvault/Commvault.Autorest/UX/Commvault.ContentStore/cloudAccounts-storages.json new file mode 100644 index 000000000000..2da22da2fa72 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/UX/Commvault.ContentStore/cloudAccounts-storages.json @@ -0,0 +1,224 @@ +{ + "resourceType": "cloudAccounts/storages", + "apiVersion": "2026-09-30", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.commvault" + }, + "commands": [ + { + "name": "Disable-AzCommvaultStorageComplianceLock", + "description": "Disable compliance lock on the storage.\nInitiates an out-of-band multi-person authorization (MPA) email approval workflow on the partner side.\nThe storage compliance lock status transitions to 'DisablementPending' immediately; once the MPA approval completes, the status becomes 'Disabled' (observable via the refresh action).", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Commvault.ContentStore/cloudAccounts/{cloudAccountName}/storages/{storageName}/disableComplianceLock", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.commvault/disable-azcommvaultstoragecompliancelock" + }, + "parameterSets": [ + { + "parameters": [ + "-CloudAccountName ", + "-ResourceGroupName ", + "-StorageName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Disable compliance lock on the storage. Initiates an out-of-band multi-person authorization (MPA) email approval workflow on the partner side. The storage compliance lock status transitions to 'DisablementPending' immediately; once the MPA approval completes, the status becomes 'Disabled' (observable via the refresh action).", + "parameters": [ + { + "name": "-CloudAccountName", + "value": "[Path.cloudAccountName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-StorageName", + "value": "[Path.storageName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Enable-AzCommvaultStorageComplianceLock", + "description": "Enable compliance lock on the storage.\nSynchronous operation.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Commvault.ContentStore/cloudAccounts/{cloudAccountName}/storages/{storageName}/enableComplianceLock", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.commvault/enable-azcommvaultstoragecompliancelock" + }, + "parameterSets": [ + { + "parameters": [ + "-CloudAccountName ", + "-ResourceGroupName ", + "-StorageName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Enable compliance lock on the storage. Synchronous operation.", + "parameters": [ + { + "name": "-CloudAccountName", + "value": "[Path.cloudAccountName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-StorageName", + "value": "[Path.storageName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Get-AzCommvaultStorage", + "description": "Get a Storage", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Commvault.ContentStore/cloudAccounts/{cloudAccountName}/storages/{storageName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultstorage" + }, + "parameterSets": [ + { + "parameters": [ + "-CloudAccountName ", + "-Name ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Get a Storage", + "parameters": [ + { + "name": "-CloudAccountName", + "value": "[Path.cloudAccountName]" + }, + { + "name": "-Name", + "value": "[Path.storageName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Remove-AzCommvaultStorage", + "description": "Delete a Storage", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Commvault.ContentStore/cloudAccounts/{cloudAccountName}/storages/{storageName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.commvault/remove-azcommvaultstorage" + }, + "parameterSets": [ + { + "parameters": [ + "-CloudAccountName ", + "-Name ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Delete a Storage", + "parameters": [ + { + "name": "-CloudAccountName", + "value": "[Path.cloudAccountName]" + }, + { + "name": "-Name", + "value": "[Path.storageName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Sync-AzCommvaultStorage", + "description": "Refresh storage state from partner.\nFetches latest compliance lock status from Commvault and refresh the ARM resource.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Commvault.ContentStore/cloudAccounts/{cloudAccountName}/storages/{storageName}/refresh", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.commvault/sync-azcommvaultstorage" + }, + "parameterSets": [ + { + "parameters": [ + "-CloudAccountName ", + "-Name ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Refresh storage state from partner. Fetches latest compliance lock status from Commvault and refresh the ARM resource.", + "parameters": [ + { + "name": "-CloudAccountName", + "value": "[Path.cloudAccountName]" + }, + { + "name": "-Name", + "value": "[Path.storageName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/Commvault/Commvault.Autorest/UX/Commvault.ContentStore/cloudAccounts.json b/src/Commvault/Commvault.Autorest/UX/Commvault.ContentStore/cloudAccounts.json new file mode 100644 index 000000000000..e24259839ae5 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/UX/Commvault.ContentStore/cloudAccounts.json @@ -0,0 +1,199 @@ +{ + "resourceType": "cloudAccounts", + "apiVersion": "2026-09-30", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.commvault" + }, + "commands": [ + { + "name": "Get-AzCommvaultCloudAccountLatestLinkedSaaS", + "description": "Returns the latest SaaS linked to the cloud account.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Commvault.ContentStore/cloudAccounts/{cloudAccountName}/latestLinkedSaaS", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultcloudaccountlatestlinkedsaas" + }, + "parameterSets": [ + { + "parameters": [ + "-CloudAccountName ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Returns the latest SaaS linked to the cloud account.", + "parameters": [ + { + "name": "-CloudAccountName", + "value": "[Path.cloudAccountName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Get-AzCommvaultCloudAccount", + "description": "Get a CloudAccount", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Commvault.ContentStore/cloudAccounts/{cloudAccountName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultcloudaccount" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Get a CloudAccount", + "parameters": [ + { + "name": "-Name", + "value": "[Path.cloudAccountName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Get-AzCommvaultRoleMapping", + "description": "Get a RoleMapping", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Commvault.ContentStore/cloudAccounts/{cloudAccountName}/roleMappings/default", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultrolemapping" + }, + "parameterSets": [ + { + "parameters": [ + "-CloudAccountName ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Get a RoleMapping", + "parameters": [ + { + "name": "-CloudAccountName", + "value": "[Path.cloudAccountName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Remove-AzCommvaultCloudAccount", + "description": "Delete a CloudAccount", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Commvault.ContentStore/cloudAccounts/{cloudAccountName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.commvault/remove-azcommvaultcloudaccount" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Delete a CloudAccount", + "parameters": [ + { + "name": "-Name", + "value": "[Path.cloudAccountName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Remove-AzCommvaultRoleMapping", + "description": "Delete a RoleMapping", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Commvault.ContentStore/cloudAccounts/{cloudAccountName}/roleMappings/default", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.commvault/remove-azcommvaultrolemapping" + }, + "parameterSets": [ + { + "parameters": [ + "-CloudAccountName ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Delete a RoleMapping", + "parameters": [ + { + "name": "-CloudAccountName", + "value": "[Path.cloudAccountName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/Commvault/Commvault.Autorest/custom/Az.Commvault.custom.psm1 b/src/Commvault/Commvault.Autorest/custom/Az.Commvault.custom.psm1 new file mode 100644 index 000000000000..7ffd9d089337 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/custom/Az.Commvault.custom.psm1 @@ -0,0 +1,17 @@ +# region Generated + # Load the private module dll + $null = Import-Module -PassThru -Name (Join-Path $PSScriptRoot '../bin/Az.Commvault.private.dll') + + # Load the internal module + $internalModulePath = Join-Path $PSScriptRoot '../internal/Az.Commvault.internal.psm1' + if(Test-Path $internalModulePath) { + $null = Import-Module -Name $internalModulePath + } + + # Export nothing to clear implicit exports + Export-ModuleMember + + # Export script cmdlets + Get-ChildItem -Path $PSScriptRoot -Recurse -Include '*.ps1' -File | ForEach-Object { . $_.FullName } + Export-ModuleMember -Function (Get-ScriptCmdlet -ScriptFolder $PSScriptRoot) -Alias (Get-ScriptCmdlet -ScriptFolder $PSScriptRoot -AsAlias) +# endregion diff --git a/src/Commvault/Commvault.Autorest/custom/README.md b/src/Commvault/Commvault.Autorest/custom/README.md new file mode 100644 index 000000000000..93467e950392 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/custom/README.md @@ -0,0 +1,41 @@ +# Custom +This directory contains custom implementation for non-generated cmdlets for the `Az.Commvault` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `../exports` folder. The only generated file into this folder is the `Az.Commvault.custom.psm1`. This file should not be modified. + +## Info +- Modifiable: yes +- Generated: partial +- Committed: yes +- Packaged: yes + +## Details +For `Az.Commvault` to use custom cmdlets, it does this two different ways. We **highly recommend** creating script cmdlets, as they are easier to write and allow access to the other exported cmdlets. C# cmdlets *cannot access exported cmdlets*. + +For C# cmdlets, they are compiled with the rest of the generated low-level cmdlets into the `./bin/Az.Commvault.private.dll`. The names of the cmdlets (methods) and files must follow the `[cmdletName]_[variantName]` syntax used for generated cmdlets. The `variantName` is used as the `ParameterSetName`, so use something appropriate that doesn't clash with already created variant or parameter set names. You cannot use the `ParameterSetName` property in the `Parameter` attribute on C# cmdlets. Each cmdlet must be separated into variants using the same pattern as seen in the `generated/cmdlets` folder. + +For script cmdlets, these are loaded via the `Az.Commvault.custom.psm1`. Then, during the build process, this module is loaded and processed in the same manner as the C# cmdlets. The fundamental difference is the script cmdlets use the `ParameterSetName` attribute and C# cmdlets do not. To create a script cmdlet variant of a generated cmdlet, simply decorate all parameters in the script with the new `ParameterSetName` in the `Parameter` attribute. This will appropriately treat each parameter set as a separate variant when processed to be exported during the build. + +## Purpose +This allows the modules to have cmdlets that were not defined in the REST specification. It also allows combining logic using generated cmdlets. This is a level of customization beyond what can be done using the [readme configuration options](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md) that are currently available. These custom cmdlets are then referenced by the cmdlets created at build-time in the `../exports` folder. + +## Usage +The easiest way currently to start developing custom cmdlets is to copy an existing cmdlet. For C# cmdlets, copy one from the `generated/cmdlets` folder. For script cmdlets, build the project using `build-module.ps1` and copy one of the scripts from the `../exports` folder. After that, if you want to add new parameter sets, follow the guidelines in the `Details` section above. For implementing a new cmdlets, at minimum, please keep these parameters: +- Break +- DefaultProfile +- HttpPipelineAppend +- HttpPipelinePrepend +- Proxy +- ProxyCredential +- ProxyUseDefaultCredentials + +These provide functionality to our HTTP pipeline and other useful features. In script, you can forward these parameters using `$PSBoundParameters` to the other cmdlets you're calling within `Az.Commvault`. For C#, follow the usage seen in the `ProcessRecordAsync` method. + +### Attributes +For processing the cmdlets, we've created some additional attributes: +- `Microsoft.Azure.PowerShell.Cmdlets.Commvault.DescriptionAttribute` + - Used in C# cmdlets to provide a high-level description of the cmdlet. This is propagated to reference documentation via [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) in the exported scripts. +- `Microsoft.Azure.PowerShell.Cmdlets.Commvault.DoNotExportAttribute` + - Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.Commvault`. +- `Microsoft.Azure.PowerShell.Cmdlets.Commvault.InternalExportAttribute` + - Used in C# cmdlets to route exported cmdlets to the `../internal`, which are *not exposed* by `Az.Commvault`. For more information, see [README.md](../internal/README.md) in the `../internal` folder. +- `Microsoft.Azure.PowerShell.Cmdlets.Commvault.ProfileAttribute` + - Used in C# and script cmdlets to define which Azure profiles the cmdlet supports. This is only supported for Azure (`--azure`) modules. \ No newline at end of file diff --git a/src/Commvault/Commvault.Autorest/docs/Az.Commvault.md b/src/Commvault/Commvault.Autorest/docs/Az.Commvault.md new file mode 100644 index 000000000000..aa2d1c2fc863 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Az.Commvault.md @@ -0,0 +1,119 @@ +--- +Module Name: Az.Commvault +Module Guid: 57bcc774-5670-4a1f-9c1e-6c8ba15f3bf8 +Download Help Link: https://learn.microsoft.com/powershell/module/az.commvault +Help Version: 1.0.0.0 +Locale: en-US +--- + +# Az.Commvault Module +## Description +Microsoft Azure PowerShell: Commvault cmdlets + +## Az.Commvault Cmdlets +### [Backup-AzCommvaultProtectionGroup](Backup-AzCommvaultProtectionGroup.md) +Ad-hoc backup of protected items resource in given protection group. + +### [Connect-AzCommvaultCloudAccountSaaS](Connect-AzCommvaultCloudAccountSaaS.md) +Links a new SaaS to the cloud account. + +### [Disable-AzCommvaultStorageComplianceLock](Disable-AzCommvaultStorageComplianceLock.md) +Disable compliance lock on the storage. +Initiates an out-of-band multi-person authorization (MPA) email approval workflow on the partner side. +The storage compliance lock status transitions to 'DisablementPending' immediately; once the MPA approval completes, the status becomes 'Disabled' (observable via the refresh action). + +### [Enable-AzCommvaultStorageComplianceLock](Enable-AzCommvaultStorageComplianceLock.md) +Enable compliance lock on the storage. +Synchronous operation. + +### [Get-AzCommvaultCloudAccount](Get-AzCommvaultCloudAccount.md) +Get a CloudAccount + +### [Get-AzCommvaultCloudAccountLatestLinkedSaaS](Get-AzCommvaultCloudAccountLatestLinkedSaaS.md) +Returns the latest SaaS linked to the cloud account. + +### [Get-AzCommvaultPlan](Get-AzCommvaultPlan.md) +Get a CommvaultPlan + +### [Get-AzCommvaultProtectedItem](Get-AzCommvaultProtectedItem.md) +Get a ProtectedItem + +### [Get-AzCommvaultProtectedItemCount](Get-AzCommvaultProtectedItemCount.md) +Gets the count of protected items for provided CCA resource IDs across subscriptions. + +### [Get-AzCommvaultProtectedItemRestorePoint](Get-AzCommvaultProtectedItemRestorePoint.md) +Gets the restore points that are available for a protected item. + +### [Get-AzCommvaultProtectionGroup](Get-AzCommvaultProtectionGroup.md) +Get a ProtectionGroup + +### [Get-AzCommvaultRoleMapping](Get-AzCommvaultRoleMapping.md) +Get a RoleMapping + +### [Get-AzCommvaultStorage](Get-AzCommvaultStorage.md) +Get a Storage + +### [Initialize-AzCommvaultSaaS](Initialize-AzCommvaultSaaS.md) +Resolve the token to get the SaaS resource ID and activate the SaaS resource + +### [New-AzCommvaultCloudAccount](New-AzCommvaultCloudAccount.md) +Create a CloudAccount + +### [New-AzCommvaultPlan](New-AzCommvaultPlan.md) +Create a CommvaultPlan + +### [New-AzCommvaultProtectionGroup](New-AzCommvaultProtectionGroup.md) +Create a ProtectionGroup + +### [New-AzCommvaultRoleMapping](New-AzCommvaultRoleMapping.md) +Create a RoleMapping + +### [New-AzCommvaultStorage](New-AzCommvaultStorage.md) +Create a Storage + +### [Remove-AzCommvaultCloudAccount](Remove-AzCommvaultCloudAccount.md) +Delete a CloudAccount + +### [Remove-AzCommvaultPlan](Remove-AzCommvaultPlan.md) +Delete a CommvaultPlan + +### [Remove-AzCommvaultProtectionGroup](Remove-AzCommvaultProtectionGroup.md) +Delete a ProtectionGroup + +### [Remove-AzCommvaultRoleMapping](Remove-AzCommvaultRoleMapping.md) +Delete a RoleMapping + +### [Remove-AzCommvaultStorage](Remove-AzCommvaultStorage.md) +Delete a Storage + +### [Restore-AzCommvaultProtectedItem](Restore-AzCommvaultProtectedItem.md) +Restore resource for a protected item. + +### [Restore-AzCommvaultProtectionGroup](Restore-AzCommvaultProtectionGroup.md) +Restore resource for a protected items in given protection group. + +### [Resume-AzCommvaultProtectionGroupBackup](Resume-AzCommvaultProtectionGroupBackup.md) +Resume Backup for a Protection Group. + +### [Stop-AzCommvaultProtectionGroupBackup](Stop-AzCommvaultProtectionGroupBackup.md) +Stop Backup for a Protection Group + +### [Sync-AzCommvaultStorage](Sync-AzCommvaultStorage.md) +Refresh storage state from partner. +Fetches latest compliance lock status from Commvault and refresh the ARM resource. + +### [Update-AzCommvaultCloudAccount](Update-AzCommvaultCloudAccount.md) +Update a CloudAccount + +### [Update-AzCommvaultPlan](Update-AzCommvaultPlan.md) +Update a CommvaultPlan + +### [Update-AzCommvaultProtectionGroup](Update-AzCommvaultProtectionGroup.md) +Update a ProtectionGroup + +### [Update-AzCommvaultRoleMapping](Update-AzCommvaultRoleMapping.md) +Update a RoleMapping + +### [Update-AzCommvaultStorage](Update-AzCommvaultStorage.md) +Update a Storage + diff --git a/src/Commvault/Commvault.Autorest/docs/Backup-AzCommvaultProtectionGroup.md b/src/Commvault/Commvault.Autorest/docs/Backup-AzCommvaultProtectionGroup.md new file mode 100644 index 000000000000..9259ef11e48a --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Backup-AzCommvaultProtectionGroup.md @@ -0,0 +1,385 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/backup-azcommvaultprotectiongroup +schema: 2.0.0 +--- + +# Backup-AzCommvaultProtectionGroup + +## SYNOPSIS +Ad-hoc backup of protected items resource in given protection group. + +## SYNTAX + +### BackupViaIdentity (Default) +``` +Backup-AzCommvaultProtectionGroup -InputObject -Request + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### Backup +``` +Backup-AzCommvaultProtectionGroup -CloudAccountName -Name -ResourceGroupName + -Request [-SubscriptionId ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### BackupExpanded +``` +Backup-AzCommvaultProtectionGroup -CloudAccountName -Name -ResourceGroupName + -BackupOptionBackupCopyImmediately -BackupOptionJobDescription + -BackupOptionNotifyUserOnJobCompletion -BackupOptionRunSnapShotBackup -VMList + [-SubscriptionId ] [-BackupOptionBackupLevel ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### BackupViaIdentityCloudAccount +``` +Backup-AzCommvaultProtectionGroup -CloudAccountInputObject -Name + -Request [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### BackupViaIdentityCloudAccountExpanded +``` +Backup-AzCommvaultProtectionGroup -CloudAccountInputObject -Name + -BackupOptionBackupCopyImmediately -BackupOptionJobDescription + -BackupOptionNotifyUserOnJobCompletion -BackupOptionRunSnapShotBackup -VMList + [-BackupOptionBackupLevel ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### BackupViaIdentityExpanded +``` +Backup-AzCommvaultProtectionGroup -InputObject -BackupOptionBackupCopyImmediately + -BackupOptionJobDescription -BackupOptionNotifyUserOnJobCompletion -BackupOptionRunSnapShotBackup + -VMList [-BackupOptionBackupLevel ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### BackupViaJsonFilePath +``` +Backup-AzCommvaultProtectionGroup -CloudAccountName -Name -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### BackupViaJsonString +``` +Backup-AzCommvaultProtectionGroup -CloudAccountName -Name -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Ad-hoc backup of protected items resource in given protection group. + +## EXAMPLES + +### Example 1: Run an ad-hoc backup of a virtual machine +```powershell +Backup-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms -BackupOptionBackupCopyImmediately -BackupOptionJobDescription 'Ad-hoc backup job' -BackupOptionNotifyUserOnJobCompletion -BackupOptionRunSnapShotBackup -VMList @{ VMGuid = '40000000-aaaa-4bbb-8ccc-000000000000' } +``` + +Starts an ad-hoc backup job for the specified virtual machine in the protection group. + +### Example 2: Run an ad-hoc backup by using a JSON request +```powershell +Backup-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms -JsonString '{"vmList":[{"vmGuid":"40000000-aaaa-4bbb-8ccc-000000000000"}],"backupOptions":{"backupLevel":"FULL","jobDescription":"Ad-hoc backup job","backupCopyImmediately":true,"runSnapShotBackup":true,"notifyUserOnJobCompletion":true}}' +``` + +Starts a full ad-hoc backup job by passing the request body as a JSON string. + +## PARAMETERS + +### -BackupOptionBackupCopyImmediately +Indicates whether to run backup immediately or not for the VM + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: BackupExpanded, BackupViaIdentityCloudAccountExpanded, BackupViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupOptionBackupLevel +Indicates whether to stop backup or not for the VM + +```yaml +Type: System.String +Parameter Sets: BackupExpanded, BackupViaIdentityCloudAccountExpanded, BackupViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupOptionJobDescription +The name of the backup job to be shown in Commvault + +```yaml +Type: System.String +Parameter Sets: BackupExpanded, BackupViaIdentityCloudAccountExpanded, BackupViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupOptionNotifyUserOnJobCompletion +Indicates whether to notify the user on job completion + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: BackupExpanded, BackupViaIdentityCloudAccountExpanded, BackupViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupOptionRunSnapShotBackup +Indicates whether to run snapshot backup or not for the VM, if false, it will run regular backup + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: BackupExpanded, BackupViaIdentityCloudAccountExpanded, BackupViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: BackupViaIdentityCloudAccount, BackupViaIdentityCloudAccountExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Backup, BackupExpanded, BackupViaJsonFilePath, BackupViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: BackupViaIdentity, BackupViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Backup operation + +```yaml +Type: System.String +Parameter Sets: BackupViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Backup operation + +```yaml +Type: System.String +Parameter Sets: BackupViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the ProtectionGroup resource + +```yaml +Type: System.String +Parameter Sets: Backup, BackupExpanded, BackupViaIdentityCloudAccount, BackupViaIdentityCloudAccountExpanded, BackupViaJsonFilePath, BackupViaJsonString +Aliases: ProtectionGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Request +The properties of BackupProtectionGroupRequest + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IBackupProtectionGroupRequest +Parameter Sets: Backup, BackupViaIdentity, BackupViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Backup, BackupExpanded, BackupViaJsonFilePath, BackupViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Backup, BackupExpanded, BackupViaJsonFilePath, BackupViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMList +The vm list details. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IVMListItem[] +Parameter Sets: BackupExpanded, BackupViaIdentityCloudAccountExpanded, BackupViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IBackupProtectionGroupRequest + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IBackupProtectionGroupResponse + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Connect-AzCommvaultCloudAccountSaaS.md b/src/Commvault/Commvault.Autorest/docs/Connect-AzCommvaultCloudAccountSaaS.md new file mode 100644 index 000000000000..298c69d508a7 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Connect-AzCommvaultCloudAccountSaaS.md @@ -0,0 +1,291 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/connect-azcommvaultcloudaccountsaas +schema: 2.0.0 +--- + +# Connect-AzCommvaultCloudAccountSaaS + +## SYNOPSIS +Links a new SaaS to the cloud account. + +## SYNTAX + +### LinkExpanded (Default) +``` +Connect-AzCommvaultCloudAccountSaaS -CloudAccountName -ResourceGroupName + [-SubscriptionId ] [-SaaSResourceId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### Link +``` +Connect-AzCommvaultCloudAccountSaaS -CloudAccountName -ResourceGroupName -Body + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### LinkViaIdentity +``` +Connect-AzCommvaultCloudAccountSaaS -InputObject -Body + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### LinkViaIdentityExpanded +``` +Connect-AzCommvaultCloudAccountSaaS -InputObject [-SaaSResourceId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### LinkViaJsonFilePath +``` +Connect-AzCommvaultCloudAccountSaaS -CloudAccountName -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### LinkViaJsonString +``` +Connect-AzCommvaultCloudAccountSaaS -CloudAccountName -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Links a new SaaS to the cloud account. + +## EXAMPLES + +### Example 1: Link a SaaS resource to a cloud account +```powershell +Connect-AzCommvaultCloudAccountSaaS -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -SaaSResourceId '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Microsoft.SaaS/resources/commvault-saas' +``` + +Links the SaaS resource to the cloud account. + +### Example 2: Link a SaaS resource to a cloud account by using a JSON request +```powershell +Connect-AzCommvaultCloudAccountSaaS -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -JsonString '{"saaSResourceId":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Microsoft.SaaS/resources/commvault-saas"}' +``` + +Links the SaaS resource to the cloud account by passing the request body as a JSON string. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +SaaS-related data properties + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ISaaSData +Parameter Sets: Link, LinkViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Link, LinkExpanded, LinkViaJsonFilePath, LinkViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: LinkViaIdentity, LinkViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Link operation + +```yaml +Type: System.String +Parameter Sets: LinkViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Link operation + +```yaml +Type: System.String +Parameter Sets: LinkViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Link, LinkExpanded, LinkViaJsonFilePath, LinkViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SaaSResourceId +SaaS resource id + +```yaml +Type: System.String +Parameter Sets: LinkExpanded, LinkViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Link, LinkExpanded, LinkViaJsonFilePath, LinkViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ISaaSData + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICloudAccount + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Disable-AzCommvaultStorageComplianceLock.md b/src/Commvault/Commvault.Autorest/docs/Disable-AzCommvaultStorageComplianceLock.md new file mode 100644 index 000000000000..10efa4db43fa --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Disable-AzCommvaultStorageComplianceLock.md @@ -0,0 +1,206 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/disable-azcommvaultstoragecompliancelock +schema: 2.0.0 +--- + +# Disable-AzCommvaultStorageComplianceLock + +## SYNOPSIS +Disable compliance lock on the storage. +Initiates an out-of-band multi-person authorization (MPA) email approval workflow on the partner side. +The storage compliance lock status transitions to 'DisablementPending' immediately; once the MPA approval completes, the status becomes 'Disabled' (observable via the refresh action). + +## SYNTAX + +### Disable (Default) +``` +Disable-AzCommvaultStorageComplianceLock -CloudAccountName -ResourceGroupName + -StorageName [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### DisableViaIdentity +``` +Disable-AzCommvaultStorageComplianceLock -InputObject [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +### DisableViaIdentityCloudAccount +``` +Disable-AzCommvaultStorageComplianceLock -CloudAccountInputObject -StorageName + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Disable compliance lock on the storage. +Initiates an out-of-band multi-person authorization (MPA) email approval workflow on the partner side. +The storage compliance lock status transitions to 'DisablementPending' immediately; once the MPA approval completes, the status becomes 'Disabled' (observable via the refresh action). + +## EXAMPLES + +### Example 1: Disable the compliance lock on a storage +```powershell +Disable-AzCommvaultStorageComplianceLock -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -StorageName storage-hot +``` + +Starts the multi-person authorization approval workflow to disable the compliance lock. +The compliance lock status changes to `DisablementPending` until the approval completes. + +## PARAMETERS + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: DisableViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Disable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: DisableViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Disable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageName +Name of the Storage resource + +```yaml +Type: System.String +Parameter Sets: Disable, DisableViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Disable +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IStorage + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Enable-AzCommvaultStorageComplianceLock.md b/src/Commvault/Commvault.Autorest/docs/Enable-AzCommvaultStorageComplianceLock.md new file mode 100644 index 000000000000..642c9af02960 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Enable-AzCommvaultStorageComplianceLock.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/enable-azcommvaultstoragecompliancelock +schema: 2.0.0 +--- + +# Enable-AzCommvaultStorageComplianceLock + +## SYNOPSIS +Enable compliance lock on the storage. +Synchronous operation. + +## SYNTAX + +### Enable (Default) +``` +Enable-AzCommvaultStorageComplianceLock -CloudAccountName -ResourceGroupName + -StorageName [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### EnableViaIdentity +``` +Enable-AzCommvaultStorageComplianceLock -InputObject [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +### EnableViaIdentityCloudAccount +``` +Enable-AzCommvaultStorageComplianceLock -CloudAccountInputObject -StorageName + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Enable compliance lock on the storage. +Synchronous operation. + +## EXAMPLES + +### Example 1: Enable the compliance lock on a storage +```powershell +Enable-AzCommvaultStorageComplianceLock -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -StorageName storage-hot +``` + +Enables the compliance lock on the storage. + +## PARAMETERS + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: EnableViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Enable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: EnableViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Enable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageName +Name of the Storage resource + +```yaml +Type: System.String +Parameter Sets: Enable, EnableViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Enable +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IStorage + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultCloudAccount.md b/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultCloudAccount.md new file mode 100644 index 000000000000..b242c45d66cf --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultCloudAccount.md @@ -0,0 +1,158 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultcloudaccount +schema: 2.0.0 +--- + +# Get-AzCommvaultCloudAccount + +## SYNOPSIS +Get a CloudAccount + +## SYNTAX + +### List (Default) +``` +Get-AzCommvaultCloudAccount [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzCommvaultCloudAccount -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzCommvaultCloudAccount -InputObject [-DefaultProfile ] + [] +``` + +### List1 +``` +Get-AzCommvaultCloudAccount -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a CloudAccount + +## EXAMPLES + +### Example 1: List the cloud accounts in a subscription +```powershell +Get-AzCommvaultCloudAccount +``` + +Lists all cloud accounts in the current subscription. + +### Example 2: List the cloud accounts in a resource group +```powershell +Get-AzCommvaultCloudAccount -ResourceGroupName rg-commvault +``` + +Lists the cloud accounts in the resource group. + +### Example 3: Get a cloud account +```powershell +Get-AzCommvaultCloudAccount -ResourceGroupName rg-commvault -Name cca-contoso +``` + +Gets the cloud account named cca-contoso. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: CloudAccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICloudAccount + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultCloudAccountLatestLinkedSaaS.md b/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultCloudAccountLatestLinkedSaaS.md new file mode 100644 index 000000000000..8f9f08e12429 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultCloudAccountLatestLinkedSaaS.md @@ -0,0 +1,133 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultcloudaccountlatestlinkedsaas +schema: 2.0.0 +--- + +# Get-AzCommvaultCloudAccountLatestLinkedSaaS + +## SYNOPSIS +Returns the latest SaaS linked to the cloud account. + +## SYNTAX + +### Latest (Default) +``` +Get-AzCommvaultCloudAccountLatestLinkedSaaS -CloudAccountName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### LatestViaIdentity +``` +Get-AzCommvaultCloudAccountLatestLinkedSaaS -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Returns the latest SaaS linked to the cloud account. + +## EXAMPLES + +### Example 1: Get the latest linked SaaS of a cloud account +```powershell +Get-AzCommvaultCloudAccountLatestLinkedSaaS -ResourceGroupName rg-commvault -CloudAccountName cca-contoso +``` + +Gets the SaaS resource that was most recently linked to the cloud account. + +## PARAMETERS + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Latest +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: LatestViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Latest +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Latest +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ILatestLinkedSaaSResponse + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultPlan.md b/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultPlan.md new file mode 100644 index 000000000000..2e419621cd25 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultPlan.md @@ -0,0 +1,181 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultplan +schema: 2.0.0 +--- + +# Get-AzCommvaultPlan + +## SYNOPSIS +Get a CommvaultPlan + +## SYNTAX + +### List (Default) +``` +Get-AzCommvaultPlan -CloudAccountName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzCommvaultPlan -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzCommvaultPlan -InputObject [-DefaultProfile ] [] +``` + +### GetViaIdentityCloudAccount +``` +Get-AzCommvaultPlan -CloudAccountInputObject -Name [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get a CommvaultPlan + +## EXAMPLES + +### Example 1: List the backup plans of a cloud account +```powershell +Get-AzCommvaultPlan -ResourceGroupName rg-commvault -CloudAccountName cca-contoso +``` + +Lists the backup plans of the cloud account. + +### Example 2: Get a backup plan +```powershell +Get-AzCommvaultPlan -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name plan-daily +``` + +Gets the backup plan named plan-daily. + +## PARAMETERS + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Plan resource + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityCloudAccount +Aliases: PlanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultPlan + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultProtectedItem.md b/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultProtectedItem.md new file mode 100644 index 000000000000..94cf3f158338 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultProtectedItem.md @@ -0,0 +1,218 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultprotecteditem +schema: 2.0.0 +--- + +# Get-AzCommvaultProtectedItem + +## SYNOPSIS +Get a ProtectedItem + +## SYNTAX + +### List (Default) +``` +Get-AzCommvaultProtectedItem -CloudAccountName -ProtectionGroupName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzCommvaultProtectedItem -CloudAccountName -Name -ProtectionGroupName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzCommvaultProtectedItem -InputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentityCloudAccount +``` +Get-AzCommvaultProtectedItem -CloudAccountInputObject -Name + -ProtectionGroupName [-DefaultProfile ] [] +``` + +### GetViaIdentityProtectionGroup +``` +Get-AzCommvaultProtectedItem -Name -ProtectionGroupInputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a ProtectedItem + +## EXAMPLES + +### Example 1: List the protected items of a protection group +```powershell +Get-AzCommvaultProtectedItem -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms +``` + +Lists the protected items in the protection group. + +### Example 2: Get a protected item +```powershell +Get-AzCommvaultProtectedItem -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -Name vm-app01 +``` + +Gets the protected item named vm-app01. + +## PARAMETERS + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The protectedItem Id, name of 2 protected items can be same under a PG if they belong to different resource group or even different data source types VM/DB/AKS, etc; and name is mandatory in Azure Typespec, hence using name parameter for id in Commvault In case of Vm it will be vmGuid + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityCloudAccount, GetViaIdentityProtectionGroup +Aliases: ProtectedItemName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionGroupInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentityProtectionGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProtectionGroupName +Name of the ProtectionGroup resource + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityCloudAccount, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IProtectedItem + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultProtectedItemCount.md b/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultProtectedItemCount.md new file mode 100644 index 000000000000..ca26a921a5b0 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultProtectedItemCount.md @@ -0,0 +1,147 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultprotecteditemcount +schema: 2.0.0 +--- + +# Get-AzCommvaultProtectedItemCount + +## SYNOPSIS +Gets the count of protected items for provided CCA resource IDs across subscriptions. + +## SYNTAX + +### CountExpanded (Default) +``` +Get-AzCommvaultProtectedItemCount -ResourceId [-DefaultProfile ] [] +``` + +### Count +``` +Get-AzCommvaultProtectedItemCount -Body [-DefaultProfile ] + [] +``` + +### CountViaJsonFilePath +``` +Get-AzCommvaultProtectedItemCount -JsonFilePath [-DefaultProfile ] [] +``` + +### CountViaJsonString +``` +Get-AzCommvaultProtectedItemCount -JsonString [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets the count of protected items for provided CCA resource IDs across subscriptions. + +## EXAMPLES + +### Example 1: Count the protected items of cloud accounts +```powershell +Get-AzCommvaultProtectedItemCount -ResourceId '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Commvault.ContentStore/cloudAccounts/cca-contoso', '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Commvault.ContentStore/cloudAccounts/cca-fabrikam' +``` + +Gets the number of protected items for each of the specified cloud accounts. + +### Example 2: Count the protected items by using a JSON request +```powershell +Get-AzCommvaultProtectedItemCount -JsonString '{"resourceIds":["/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Commvault.ContentStore/cloudAccounts/cca-contoso"]}' +``` + +Gets the number of protected items by passing the request body as a JSON string. + +## PARAMETERS + +### -Body +Request to count protected items for the provided CCA resource IDs across subscriptions. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICountProtectedItemsRequest +Parameter Sets: Count +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Count operation + +```yaml +Type: System.String +Parameter Sets: CountViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Count operation + +```yaml +Type: System.String +Parameter Sets: CountViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The list of CCA resource IDs. + +```yaml +Type: System.String[] +Parameter Sets: CountExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICountProtectedItemsRequest + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICountProtectedItemsResponse + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultProtectedItemRestorePoint.md b/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultProtectedItemRestorePoint.md new file mode 100644 index 000000000000..1d83ab4d4f3b --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultProtectedItemRestorePoint.md @@ -0,0 +1,206 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultprotecteditemrestorepoint +schema: 2.0.0 +--- + +# Get-AzCommvaultProtectedItemRestorePoint + +## SYNOPSIS +Gets the restore points that are available for a protected item. + +## SYNTAX + +### Get (Default) +``` +Get-AzCommvaultProtectedItemRestorePoint -CloudAccountName -ProtectedItemName + -ProtectionGroupName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzCommvaultProtectedItemRestorePoint -InputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentityCloudAccount +``` +Get-AzCommvaultProtectedItemRestorePoint -CloudAccountInputObject + -ProtectedItemName -ProtectionGroupName [-DefaultProfile ] [] +``` + +### GetViaIdentityProtectionGroup +``` +Get-AzCommvaultProtectedItemRestorePoint -ProtectedItemName + -ProtectionGroupInputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets the restore points that are available for a protected item. + +## EXAMPLES + +### Example 1: Get the restore points of a protected item +```powershell +Get-AzCommvaultProtectedItemRestorePoint -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -ProtectedItemName vm-app01 +``` + +Gets the restore points that are available for the protected item. + +## PARAMETERS + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProtectedItemName +The protectedItem Id, name of 2 protected items can be same under a PG if they belong to different resource group or even different data source types VM/DB/AKS, etc; and name is mandatory in Azure Typespec, hence using name parameter for id in Commvault In case of Vm it will be vmGuid + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityCloudAccount, GetViaIdentityProtectionGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionGroupInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentityProtectionGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProtectionGroupName +Name of the ProtectionGroup resource + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRestorePoints + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultProtectionGroup.md b/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultProtectionGroup.md new file mode 100644 index 000000000000..3e5327463d38 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultProtectionGroup.md @@ -0,0 +1,182 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultprotectiongroup +schema: 2.0.0 +--- + +# Get-AzCommvaultProtectionGroup + +## SYNOPSIS +Get a ProtectionGroup + +## SYNTAX + +### List (Default) +``` +Get-AzCommvaultProtectionGroup -CloudAccountName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzCommvaultProtectionGroup -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzCommvaultProtectionGroup -InputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentityCloudAccount +``` +Get-AzCommvaultProtectionGroup -CloudAccountInputObject -Name + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a ProtectionGroup + +## EXAMPLES + +### Example 1: List the protection groups of a cloud account +```powershell +Get-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso +``` + +Lists the protection groups of the cloud account. + +### Example 2: Get a protection group +```powershell +Get-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms +``` + +Gets the protection group named pg-prod-vms. + +## PARAMETERS + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the ProtectionGroup resource + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityCloudAccount +Aliases: ProtectionGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IProtectionGroup + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultRoleMapping.md b/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultRoleMapping.md new file mode 100644 index 000000000000..ee48f6c0162e --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultRoleMapping.md @@ -0,0 +1,133 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultrolemapping +schema: 2.0.0 +--- + +# Get-AzCommvaultRoleMapping + +## SYNOPSIS +Get a RoleMapping + +## SYNTAX + +### Get (Default) +``` +Get-AzCommvaultRoleMapping -CloudAccountName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzCommvaultRoleMapping -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a RoleMapping + +## EXAMPLES + +### Example 1: Get the role mapping of a cloud account +```powershell +Get-AzCommvaultRoleMapping -ResourceGroupName rg-commvault -CloudAccountName cca-contoso +``` + +Gets the role mapping of the cloud account. +Each cloud account has a single role mapping that maps Commvault roles to Microsoft Entra users and groups. + +## PARAMETERS + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRoleMapping + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultStorage.md b/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultStorage.md new file mode 100644 index 000000000000..226eb6d62740 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultStorage.md @@ -0,0 +1,181 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultstorage +schema: 2.0.0 +--- + +# Get-AzCommvaultStorage + +## SYNOPSIS +Get a Storage + +## SYNTAX + +### List (Default) +``` +Get-AzCommvaultStorage -CloudAccountName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzCommvaultStorage -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzCommvaultStorage -InputObject [-DefaultProfile ] [] +``` + +### GetViaIdentityCloudAccount +``` +Get-AzCommvaultStorage -CloudAccountInputObject -Name + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a Storage + +## EXAMPLES + +### Example 1: List the storages of a cloud account +```powershell +Get-AzCommvaultStorage -ResourceGroupName rg-commvault -CloudAccountName cca-contoso +``` + +Lists the storages of the cloud account. + +### Example 2: Get a storage +```powershell +Get-AzCommvaultStorage -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name storage-hot +``` + +Gets the storage named storage-hot. + +## PARAMETERS + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Storage resource + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityCloudAccount +Aliases: StorageName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IStorage + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Initialize-AzCommvaultSaaS.md b/src/Commvault/Commvault.Autorest/docs/Initialize-AzCommvaultSaaS.md new file mode 100644 index 000000000000..a7201b82c5bb --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Initialize-AzCommvaultSaaS.md @@ -0,0 +1,456 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/initialize-azcommvaultsaas +schema: 2.0.0 +--- + +# Initialize-AzCommvaultSaaS + +## SYNOPSIS +Resolve the token to get the SaaS resource ID and activate the SaaS resource + +## SYNTAX + +### ActivateExpanded (Default) +``` +Initialize-AzCommvaultSaaS -SaasGuid [-SubscriptionId ] + [-ActivateSaaSRequestParamSaasResourceId ] [-CompanyCity ] [-CompanyCountry ] + [-CompanyJobTitle ] [-CompanyName ] [-CompanyPostalCode ] [-CompanyState ] + [-CompanyStreet ] [-CompanyWebsite ] [-PublisherId ] [-UserEmailAddress ] + [-UserFirstName ] [-UserLastName ] [-UserPhoneNumber ] [-UserUpn ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### Activate +``` +Initialize-AzCommvaultSaaS -Body [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### ActivateViaJsonFilePath +``` +Initialize-AzCommvaultSaaS -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### ActivateViaJsonString +``` +Initialize-AzCommvaultSaaS -JsonString [-SubscriptionId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Resolve the token to get the SaaS resource ID and activate the SaaS resource + +## EXAMPLES + +### Example 1: Activate a SaaS resource +```powershell +Initialize-AzCommvaultSaaS -SaasGuid '55555555-6666-7777-8888-999999999999' -PublisherId 'contoso-publisher' -ActivateSaaSRequestParamSaasResourceId '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Microsoft.SaaS/resources/commvault-saas' -UserFirstName 'John' -UserLastName 'Smith' -UserEmailAddress 'john.smith@contoso.com' -UserUpn 'john.smith@contoso.com' -CompanyName 'Contoso' +``` + +Activates the SaaS resource for the specified user and company. + +### Example 2: Activate a SaaS resource by using a JSON request +```powershell +Initialize-AzCommvaultSaaS -JsonString '{"saasGuid":"55555555-6666-7777-8888-999999999999","publisherId":"contoso-publisher","activateSaaSRequestParam":{"saasResourceId":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Microsoft.SaaS/resources/commvault-saas","user":{"firstName":"John","lastName":"Smith","emailAddress":"john.smith@contoso.com","upn":"john.smith@contoso.com"},"company":{"companyName":"Contoso"}}}' +``` + +Activates the SaaS resource by passing the request body as a JSON string. + +## PARAMETERS + +### -ActivateSaaSRequestParamSaasResourceId +Optional Marketplace SaaS resource identifier + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +SaaS guid for Activate and Validate SaaS Resource + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IActivateSaaSParameterRequest +Parameter Sets: Activate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CompanyCity +City of the company address. + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyCountry +Country of the company address. + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyJobTitle +Job title + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyName +Company name + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyPostalCode +Postal code + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyState +State or province of the company address. + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyStreet +Street address + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyWebsite +Company website + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Activate operation + +```yaml +Type: System.String +Parameter Sets: ActivateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Activate operation + +```yaml +Type: System.String +Parameter Sets: ActivateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublisherId +Optional publisher identifier + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SaasGuid +SaaS guid for Activate and Validate SaaS Resource + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserEmailAddress +Email address of the user + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserFirstName +First name of the user + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserLastName +Last name of the user + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPhoneNumber +User's phone number + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserUpn +User's principal name + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IActivateSaaSParameterRequest + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ISaaSResourceDetailsResponse + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/New-AzCommvaultCloudAccount.md b/src/Commvault/Commvault.Autorest/docs/New-AzCommvaultCloudAccount.md new file mode 100644 index 000000000000..dda2b31a6f77 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/New-AzCommvaultCloudAccount.md @@ -0,0 +1,633 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/new-azcommvaultcloudaccount +schema: 2.0.0 +--- + +# New-AzCommvaultCloudAccount + +## SYNOPSIS +Create a CloudAccount + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzCommvaultCloudAccount -Name -ResourceGroupName -Location + [-SubscriptionId ] [-CompanyCity ] [-CompanyCountry ] [-CompanyJobTitle ] + [-CompanyName ] [-CompanyPostalCode ] [-CompanyState ] [-CompanyStreet ] + [-CompanyWebsite ] [-EnableSystemAssignedIdentity] [-MarketplaceSaasResourceId ] + [-MarketplaceSubscriptionId ] [-OfferDetailOfferId ] [-OfferDetailPlanId ] + [-OfferDetailPlanName ] [-OfferDetailPublisherId ] [-OfferDetailTermId ] + [-OfferDetailTermUnit ] [-RoleAssignmentsOnCcaCreate ] [-Tag ] + [-UserAssignedIdentity ] [-UserEmailAddress ] [-UserFirstName ] + [-UserLastName ] [-UserPhoneNumber ] [-UserUpn ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzCommvaultCloudAccount -Name -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaJsonString +``` +New-AzCommvaultCloudAccount -Name -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Create a CloudAccount + +## EXAMPLES + +### Example 1: Create a cloud account +```powershell +New-AzCommvaultCloudAccount -ResourceGroupName rg-commvault -Name cca-contoso -Location eastus -EnableSystemAssignedIdentity -MarketplaceSubscriptionId '00000000-0000-0000-0000-000000000000' -OfferDetailPublisherId 'contoso-publisher' -OfferDetailOfferId 'contoso-offer' -OfferDetailPlanId 'contoso-plan' -OfferDetailPlanName 'Contoso Plan' -OfferDetailTermUnit 'P1M' -OfferDetailTermId 'contoso-term' -UserFirstName 'John' -UserLastName 'Doe' -UserEmailAddress 'john.doe@contoso.com' -UserUpn 'john.doe@contoso.com' +``` + +Creates a cloud account with a system-assigned managed identity. + +### Example 2: Create a cloud account and assign roles to Microsoft Entra groups +```powershell +$roleAssignments = @( + @{ RoleName = 'BackupAdmin'; Entity = @(@{ Id = 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'; DisplayName = 'Tenant Admins'; EntityType = 'Group' }) }, + @{ RoleName = 'BackupOperator'; Entity = @(@{ Id = '44444444-5555-6666-7777-888888888888'; DisplayName = 'Ops Team'; EntityType = 'Group' }) } +) +New-AzCommvaultCloudAccount -ResourceGroupName rg-commvault -Name cca-contoso -Location eastus -EnableSystemAssignedIdentity -MarketplaceSubscriptionId '00000000-0000-0000-0000-000000000000' -OfferDetailPublisherId 'contoso-publisher' -OfferDetailOfferId 'contoso-offer' -OfferDetailPlanId 'contoso-plan' -OfferDetailPlanName 'Contoso Plan' -OfferDetailTermUnit 'P1M' -OfferDetailTermId 'contoso-term' -UserFirstName 'John' -UserLastName 'Doe' -UserEmailAddress 'john.doe@contoso.com' -UserUpn 'john.doe@contoso.com' -RoleAssignmentsOnCcaCreate $roleAssignments +``` + +Creates a cloud account and assigns the Commvault roles to the specified Microsoft Entra groups. + +### Example 3: Create a cloud account by using a JSON file +```powershell +New-AzCommvaultCloudAccount -ResourceGroupName rg-commvault -Name cca-contoso -JsonFilePath '.\cloud-account.json' +``` + +Creates a cloud account from the request body in the JSON file. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyCity +City of the company address. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyCountry +Country of the company address. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyJobTitle +Job title + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyName +Company name + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyPostalCode +Postal code + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyState +State or province of the company address. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyStreet +Street address + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyWebsite +Company website + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketplaceSaasResourceId +Marketplace SaaS Resource Id + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketplaceSubscriptionId +Azure subscription id for the the marketplace offer is purchased from + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CloudAccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailOfferId +Offer Id for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailPlanId +Plan Id for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailPlanName +Plan Name for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailPublisherId +Publisher Id for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailTermId +Plan Display Name for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailTermUnit +Plan Display Name for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleAssignmentsOnCcaCreate +Role assignments to provision during CCA creation. +Each entry maps a Commvault role to its assigned Entra principals. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRoleAssignment[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserEmailAddress +Email address of the user + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserFirstName +First name of the user + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserLastName +Last name of the user + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPhoneNumber +User's phone number + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserUpn +User's principal name + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICloudAccount + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/New-AzCommvaultPlan.md b/src/Commvault/Commvault.Autorest/docs/New-AzCommvaultPlan.md new file mode 100644 index 000000000000..94044c9c553a --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/New-AzCommvaultPlan.md @@ -0,0 +1,325 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/new-azcommvaultplan +schema: 2.0.0 +--- + +# New-AzCommvaultPlan + +## SYNOPSIS +Create a CommvaultPlan + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzCommvaultPlan -CloudAccountName -PlanName -ResourceGroupName + [-SubscriptionId ] [-Location ] [-RetentionNumberOfSnapshot ] + [-Schedule ] [-StoragePlan ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityCloudAccountExpanded +``` +New-AzCommvaultPlan -CloudAccountInputObject -PlanName [-Location ] + [-RetentionNumberOfSnapshot ] [-Schedule ] [-StoragePlan ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzCommvaultPlan -CloudAccountName -PlanName -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzCommvaultPlan -CloudAccountName -PlanName -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Create a CommvaultPlan + +## EXAMPLES + +### Example 1: Create a backup plan +```powershell +$storagePlan = @{ Name = 'primary'; StoragePoolId = 'storage-hot'; CopyName = 'primary-copy'; CopyPrecedence = 1; RetentionPeriod = 30; RetentionTime = 'monthly'; BackupRuleType = 'ALL_JOBS' } +$schedule = @{ BackupType = 'INCREMENTAL'; Frequency = 'daily'; RunsEvery = 1; Time = '22:00'; TimeZone = 'UTC' } +New-AzCommvaultPlan -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -PlanName plan-daily -Location eastus -StoragePlan $storagePlan -Schedule $schedule -RetentionNumberOfSnapshot 7 +``` + +Creates a backup plan that runs an incremental backup every day and keeps seven snapshots. + +### Example 2: Create a backup plan by using a JSON file +```powershell +New-AzCommvaultPlan -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -PlanName plan-daily -JsonFilePath '.\plan.json' +``` + +Creates a backup plan from the request body in the JSON file. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the Commvault Plan + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanName +Name of the Plan resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionNumberOfSnapshot +Number of Snapshots + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded, CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Schedule +The Commvault Plan Schedule + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ISchedule[] +Parameter Sets: CreateExpanded, CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePlan +The storage plans associated with the Commvault Plan + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IStoragePlan[] +Parameter Sets: CreateExpanded, CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultPlan + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/New-AzCommvaultProtectionGroup.md b/src/Commvault/Commvault.Autorest/docs/New-AzCommvaultProtectionGroup.md new file mode 100644 index 000000000000..814b78b67f19 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/New-AzCommvaultProtectionGroup.md @@ -0,0 +1,324 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/new-azcommvaultprotectiongroup +schema: 2.0.0 +--- + +# New-AzCommvaultProtectionGroup + +## SYNOPSIS +Create a ProtectionGroup + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzCommvaultProtectionGroup -CloudAccountName -ProtectionGroupName + -ResourceGroupName [-SubscriptionId ] [-MatchRule ] [-MatchRuleMatchType ] + [-Plan ] [-ResourceManual ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaIdentityCloudAccountExpanded +``` +New-AzCommvaultProtectionGroup -CloudAccountInputObject -ProtectionGroupName + [-MatchRule ] [-MatchRuleMatchType ] [-Plan ] [-ResourceManual ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzCommvaultProtectionGroup -CloudAccountName -ProtectionGroupName + -ResourceGroupName -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzCommvaultProtectionGroup -CloudAccountName -ProtectionGroupName + -ResourceGroupName -JsonString [-SubscriptionId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create a ProtectionGroup + +## EXAMPLES + +### Example 1: Create a protection group for specific virtual machines +```powershell +New-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -Plan plan-daily -ResourceManual '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-app/providers/Microsoft.Compute/virtualMachines/vm-app01' +``` + +Creates a protection group that protects the specified virtual machine with the backup plan plan-daily. + +### Example 2: Create a protection group that selects virtual machines by a rule +```powershell +$rule = @{ Property = 'resourceGroup'; Operator = 'contains'; Value = 'prod' } +New-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -Plan plan-daily -MatchRule $rule -MatchRuleMatchType 'all' +``` + +Creates a protection group that protects the virtual machines whose resource group name contains prod. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchRule +rules to match + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRule[] +Parameter Sets: CreateExpanded, CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchRuleMatchType +match Type all or any + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Plan +The Commvault Plan to be associated with the Protection Group + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionGroupName +Name of the ProtectionGroup resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceManual +The items to be protected under Protection Group + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded, CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IProtectionGroup + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/New-AzCommvaultRoleMapping.md b/src/Commvault/Commvault.Autorest/docs/New-AzCommvaultRoleMapping.md new file mode 100644 index 000000000000..7e4fc88b896b --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/New-AzCommvaultRoleMapping.md @@ -0,0 +1,209 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/new-azcommvaultrolemapping +schema: 2.0.0 +--- + +# New-AzCommvaultRoleMapping + +## SYNOPSIS +Create a RoleMapping + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzCommvaultRoleMapping -CloudAccountName -ResourceGroupName [-SubscriptionId ] + [-Role ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzCommvaultRoleMapping -CloudAccountName -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzCommvaultRoleMapping -CloudAccountName -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create a RoleMapping + +## EXAMPLES + +### Example 1: Create the role mapping of a cloud account +```powershell +$roles = @( + @{ RoleName = 'BackupAdmin'; Entity = @(@{ Id = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890'; DisplayName = 'Backup Admins Group'; EntityType = 'Group' }) }, + @{ RoleName = 'BackupUser'; Entity = @(@{ Id = '22222222-3333-4444-5555-666666666666'; DisplayName = 'Jane Doe'; EntityType = 'User' }) } +) +New-AzCommvaultRoleMapping -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Role $roles +``` + +Maps the BackupAdmin and BackupUser roles to a Microsoft Entra group and user. + +### Example 2: Create the role mapping by using a JSON file +```powershell +New-AzCommvaultRoleMapping -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -JsonFilePath '.\role-mapping.json' +``` + +Creates the role mapping from the request body in the JSON file. + +## PARAMETERS + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +The list of role assignments mapping roles to Entra entities (users and groups) + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRoleAssignment[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRoleMapping + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/New-AzCommvaultStorage.md b/src/Commvault/Commvault.Autorest/docs/New-AzCommvaultStorage.md new file mode 100644 index 000000000000..c3ea4202be27 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/New-AzCommvaultStorage.md @@ -0,0 +1,292 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/new-azcommvaultstorage +schema: 2.0.0 +--- + +# New-AzCommvaultStorage + +## SYNOPSIS +Create a Storage + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzCommvaultStorage -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-Location ] [-StorageClassType ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityCloudAccountExpanded +``` +New-AzCommvaultStorage -CloudAccountInputObject -Name [-Location ] + [-StorageClassType ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaJsonFilePath +``` +New-AzCommvaultStorage -CloudAccountName -Name -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzCommvaultStorage -CloudAccountName -Name -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Create a Storage + +## EXAMPLES + +### Example 1: Create a hot storage +```powershell +New-AzCommvaultStorage -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name storage-hot -Location eastus -StorageClassType HOT +``` + +Creates a hot storage in the East US region. + +### Example 2: Create a cold storage +```powershell +New-AzCommvaultStorage -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name storage-cold -Location eastus -StorageClassType COLD +``` + +Creates a cold storage in the East US region. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the Commvault Storage + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Storage resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageClassType +The class of Commvault Storage + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IStorage + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/README.md b/src/Commvault/Commvault.Autorest/docs/README.md new file mode 100644 index 000000000000..de8d72a43301 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/README.md @@ -0,0 +1,11 @@ +# Docs +This directory contains the documentation of the cmdlets for the `Az.Commvault` module. To run documentation generation, use the `generate-help.ps1` script at the root module folder. Files in this folder will *always be overridden on regeneration*. To update documentation examples, please use the `../examples` folder. + +## Info +- Modifiable: no +- Generated: all +- Committed: yes +- Packaged: yes + +## Details +The process of documentation generation loads `Az.Commvault` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `../exports` folder. Additionally, when writing custom cmdlets in the `../custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `../examples` folder. \ No newline at end of file diff --git a/src/Commvault/Commvault.Autorest/docs/Remove-AzCommvaultCloudAccount.md b/src/Commvault/Commvault.Autorest/docs/Remove-AzCommvaultCloudAccount.md new file mode 100644 index 000000000000..0c31def76559 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Remove-AzCommvaultCloudAccount.md @@ -0,0 +1,209 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/remove-azcommvaultcloudaccount +schema: 2.0.0 +--- + +# Remove-AzCommvaultCloudAccount + +## SYNOPSIS +Delete a CloudAccount + +## SYNTAX + +### Delete (Default) +``` +Remove-AzCommvaultCloudAccount -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzCommvaultCloudAccount -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a CloudAccount + +## EXAMPLES + +### Example 1: Delete a cloud account +```powershell +Remove-AzCommvaultCloudAccount -ResourceGroupName rg-commvault -Name cca-contoso +``` + +Deletes the cloud account named cca-contoso. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: CloudAccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Remove-AzCommvaultPlan.md b/src/Commvault/Commvault.Autorest/docs/Remove-AzCommvaultPlan.md new file mode 100644 index 000000000000..15fcc87ce578 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Remove-AzCommvaultPlan.md @@ -0,0 +1,246 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/remove-azcommvaultplan +schema: 2.0.0 +--- + +# Remove-AzCommvaultPlan + +## SYNOPSIS +Delete a CommvaultPlan + +## SYNTAX + +### Delete (Default) +``` +Remove-AzCommvaultPlan -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzCommvaultPlan -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityCloudAccount +``` +Remove-AzCommvaultPlan -CloudAccountInputObject -Name + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a CommvaultPlan + +## EXAMPLES + +### Example 1: Delete a backup plan +```powershell +Remove-AzCommvaultPlan -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name plan-daily +``` + +Deletes the backup plan named plan-daily. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: DeleteViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Plan resource + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityCloudAccount +Aliases: PlanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Remove-AzCommvaultProtectionGroup.md b/src/Commvault/Commvault.Autorest/docs/Remove-AzCommvaultProtectionGroup.md new file mode 100644 index 000000000000..97733d5ce673 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Remove-AzCommvaultProtectionGroup.md @@ -0,0 +1,246 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/remove-azcommvaultprotectiongroup +schema: 2.0.0 +--- + +# Remove-AzCommvaultProtectionGroup + +## SYNOPSIS +Delete a ProtectionGroup + +## SYNTAX + +### Delete (Default) +``` +Remove-AzCommvaultProtectionGroup -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzCommvaultProtectionGroup -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityCloudAccount +``` +Remove-AzCommvaultProtectionGroup -CloudAccountInputObject -Name + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a ProtectionGroup + +## EXAMPLES + +### Example 1: Delete a protection group +```powershell +Remove-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms +``` + +Deletes the protection group named pg-prod-vms. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: DeleteViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the ProtectionGroup resource + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityCloudAccount +Aliases: ProtectionGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Remove-AzCommvaultRoleMapping.md b/src/Commvault/Commvault.Autorest/docs/Remove-AzCommvaultRoleMapping.md new file mode 100644 index 000000000000..d3f2bb8fd058 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Remove-AzCommvaultRoleMapping.md @@ -0,0 +1,179 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/remove-azcommvaultrolemapping +schema: 2.0.0 +--- + +# Remove-AzCommvaultRoleMapping + +## SYNOPSIS +Delete a RoleMapping + +## SYNTAX + +### Delete (Default) +``` +Remove-AzCommvaultRoleMapping -CloudAccountName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzCommvaultRoleMapping -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a RoleMapping + +## EXAMPLES + +### Example 1: Delete the role mapping of a cloud account +```powershell +Remove-AzCommvaultRoleMapping -ResourceGroupName rg-commvault -CloudAccountName cca-contoso +``` + +Deletes the role mapping of the cloud account. + +## PARAMETERS + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Remove-AzCommvaultStorage.md b/src/Commvault/Commvault.Autorest/docs/Remove-AzCommvaultStorage.md new file mode 100644 index 000000000000..5421c4eea98b --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Remove-AzCommvaultStorage.md @@ -0,0 +1,246 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/remove-azcommvaultstorage +schema: 2.0.0 +--- + +# Remove-AzCommvaultStorage + +## SYNOPSIS +Delete a Storage + +## SYNTAX + +### Delete (Default) +``` +Remove-AzCommvaultStorage -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzCommvaultStorage -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityCloudAccount +``` +Remove-AzCommvaultStorage -CloudAccountInputObject -Name + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a Storage + +## EXAMPLES + +### Example 1: Delete a storage +```powershell +Remove-AzCommvaultStorage -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name storage-cold +``` + +Deletes the storage named storage-cold. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: DeleteViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Storage resource + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityCloudAccount +Aliases: StorageName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Restore-AzCommvaultProtectedItem.md b/src/Commvault/Commvault.Autorest/docs/Restore-AzCommvaultProtectedItem.md new file mode 100644 index 000000000000..7eb02765cd4e --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Restore-AzCommvaultProtectedItem.md @@ -0,0 +1,397 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/restore-azcommvaultprotecteditem +schema: 2.0.0 +--- + +# Restore-AzCommvaultProtectedItem + +## SYNOPSIS +Restore resource for a protected item. + +## SYNTAX + +### RestoreViaIdentity (Default) +``` +Restore-AzCommvaultProtectedItem -InputObject -Request + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### Restore +``` +Restore-AzCommvaultProtectedItem -CloudAccountName -Name -ProtectionGroupName + -ResourceGroupName -Request [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### RestoreExpanded +``` +Restore-AzCommvaultProtectedItem -CloudAccountName -Name -ProtectionGroupName + -ResourceGroupName -InPlaceRestore -VMDestinationInfoVminfoList + [-SubscriptionId ] [-RestoreType ] [-ToTime ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### RestoreViaIdentityCloudAccount +``` +Restore-AzCommvaultProtectedItem -CloudAccountInputObject -Name + -ProtectionGroupName -Request [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +### RestoreViaIdentityCloudAccountExpanded +``` +Restore-AzCommvaultProtectedItem -CloudAccountInputObject -Name + -ProtectionGroupName -InPlaceRestore -VMDestinationInfoVminfoList + [-RestoreType ] [-ToTime ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### RestoreViaIdentityExpanded +``` +Restore-AzCommvaultProtectedItem -InputObject -InPlaceRestore + -VMDestinationInfoVminfoList [-RestoreType ] [-ToTime ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### RestoreViaIdentityProtectionGroup +``` +Restore-AzCommvaultProtectedItem -Name -ProtectionGroupInputObject + -Request [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### RestoreViaIdentityProtectionGroupExpanded +``` +Restore-AzCommvaultProtectedItem -Name -ProtectionGroupInputObject + -InPlaceRestore -VMDestinationInfoVminfoList [-RestoreType ] [-ToTime ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### RestoreViaJsonFilePath +``` +Restore-AzCommvaultProtectedItem -CloudAccountName -Name -ProtectionGroupName + -ResourceGroupName -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +### RestoreViaJsonString +``` +Restore-AzCommvaultProtectedItem -CloudAccountName -Name -ProtectionGroupName + -ResourceGroupName -JsonString [-SubscriptionId ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Restore resource for a protected item. + +## EXAMPLES + +### Example 1: Restore a protected item in place +```powershell +Restore-AzCommvaultProtectedItem -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -Name vm-app01 -InPlaceRestore -VMDestinationInfoVminfoList @{ SourceVMGuid = '40000000-aaaa-4bbb-8ccc-000000000000'; StorageAccountId = '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-restore/providers/Microsoft.Storage/storageAccounts/strestore01'; PowerOnVMAfterRestore = $true } +``` + +Restores the virtual machine in place and powers it on after the restore completes. + +### Example 2: Restore a protected item as a new virtual machine by using a JSON request +```powershell +Restore-AzCommvaultProtectedItem -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -Name vm-app01 -JsonString '{"inPlaceRestore":false,"restoreType":"VIRTUAL_MACHINE","vmDestinationInfo":{"vmInfoList":[{"sourceVmGuid":"40000000-aaaa-4bbb-8ccc-000000000000","name":"vm-app01-restored","resourceGroup":"rg-restore","region":"eastus","storageAccountId":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-restore/providers/Microsoft.Storage/storageAccounts/strestore01","networkId":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-restore/providers/Microsoft.Network/virtualNetworks/vnet-restore","subnetId":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-restore/providers/Microsoft.Network/virtualNetworks/vnet-restore/subnets/default","powerOnVmAfterRestore":true}]}}' +``` + +Restores the virtual machine as a new virtual machine in another resource group and region by passing the request body as a JSON string. + +## PARAMETERS + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: RestoreViaIdentityCloudAccount, RestoreViaIdentityCloudAccountExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Restore, RestoreExpanded, RestoreViaJsonFilePath, RestoreViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InPlaceRestore +Check whether inplace or out of place restore. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RestoreExpanded, RestoreViaIdentityCloudAccountExpanded, RestoreViaIdentityExpanded, RestoreViaIdentityProtectionGroupExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: RestoreViaIdentity, RestoreViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Restore operation + +```yaml +Type: System.String +Parameter Sets: RestoreViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Restore operation + +```yaml +Type: System.String +Parameter Sets: RestoreViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The protectedItem Id, name of 2 protected items can be same under a PG if they belong to different resource group or even different data source types VM/DB/AKS, etc; and name is mandatory in Azure Typespec, hence using name parameter for id in Commvault In case of Vm it will be vmGuid + +```yaml +Type: System.String +Parameter Sets: Restore, RestoreExpanded, RestoreViaIdentityCloudAccount, RestoreViaIdentityCloudAccountExpanded, RestoreViaIdentityProtectionGroup, RestoreViaIdentityProtectionGroupExpanded, RestoreViaJsonFilePath, RestoreViaJsonString +Aliases: ProtectedItemName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionGroupInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: RestoreViaIdentityProtectionGroup, RestoreViaIdentityProtectionGroupExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProtectionGroupName +Name of the ProtectionGroup resource + +```yaml +Type: System.String +Parameter Sets: Restore, RestoreExpanded, RestoreViaIdentityCloudAccount, RestoreViaIdentityCloudAccountExpanded, RestoreViaJsonFilePath, RestoreViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Request +The properties of RestoreProtectionItemRequest + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRestoreProtectionItemRequest +Parameter Sets: Restore, RestoreViaIdentity, RestoreViaIdentityCloudAccount, RestoreViaIdentityProtectionGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Restore, RestoreExpanded, RestoreViaJsonFilePath, RestoreViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreType +Type of Restore + +```yaml +Type: System.String +Parameter Sets: RestoreExpanded, RestoreViaIdentityCloudAccountExpanded, RestoreViaIdentityExpanded, RestoreViaIdentityProtectionGroupExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Restore, RestoreExpanded, RestoreViaJsonFilePath, RestoreViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ToTime +Time to restore + +```yaml +Type: System.String +Parameter Sets: RestoreExpanded, RestoreViaIdentityCloudAccountExpanded, RestoreViaIdentityExpanded, RestoreViaIdentityProtectionGroupExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMDestinationInfoVminfoList +List of information on VMs + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IVMInfo[] +Parameter Sets: RestoreExpanded, RestoreViaIdentityCloudAccountExpanded, RestoreViaIdentityExpanded, RestoreViaIdentityProtectionGroupExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRestoreProtectionItemRequest + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRestoreProtectionItemResponse + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Restore-AzCommvaultProtectionGroup.md b/src/Commvault/Commvault.Autorest/docs/Restore-AzCommvaultProtectionGroup.md new file mode 100644 index 000000000000..ca769fb1f074 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Restore-AzCommvaultProtectionGroup.md @@ -0,0 +1,351 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/restore-azcommvaultprotectiongroup +schema: 2.0.0 +--- + +# Restore-AzCommvaultProtectionGroup + +## SYNOPSIS +Restore resource for a protected items in given protection group. + +## SYNTAX + +### RestoreViaIdentity (Default) +``` +Restore-AzCommvaultProtectionGroup -InputObject -Request + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### Restore +``` +Restore-AzCommvaultProtectionGroup -CloudAccountName -Name -ResourceGroupName + -Request [-SubscriptionId ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### RestoreExpanded +``` +Restore-AzCommvaultProtectionGroup -CloudAccountName -Name -ResourceGroupName + -InPlaceRestore -VMDestinationInfoVminfoList [-SubscriptionId ] [-RestoreType ] + [-ToTime ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### RestoreViaIdentityCloudAccount +``` +Restore-AzCommvaultProtectionGroup -CloudAccountInputObject -Name + -Request [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### RestoreViaIdentityCloudAccountExpanded +``` +Restore-AzCommvaultProtectionGroup -CloudAccountInputObject -Name + -InPlaceRestore -VMDestinationInfoVminfoList [-RestoreType ] [-ToTime ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### RestoreViaIdentityExpanded +``` +Restore-AzCommvaultProtectionGroup -InputObject -InPlaceRestore + -VMDestinationInfoVminfoList [-RestoreType ] [-ToTime ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### RestoreViaJsonFilePath +``` +Restore-AzCommvaultProtectionGroup -CloudAccountName -Name -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### RestoreViaJsonString +``` +Restore-AzCommvaultProtectionGroup -CloudAccountName -Name -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Restore resource for a protected items in given protection group. + +## EXAMPLES + +### Example 1: Restore a protection group in place +```powershell +Restore-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms -InPlaceRestore -VMDestinationInfoVminfoList @{ SourceVMGuid = '40000000-aaaa-4bbb-8ccc-000000000000'; StorageAccountId = '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-restore/providers/Microsoft.Storage/storageAccounts/strestore01'; PowerOnVMAfterRestore = $true } +``` + +Restores the specified virtual machine of the protection group in place and powers it on after the restore completes. + +### Example 2: Restore a protection group by using a JSON file +```powershell +Restore-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms -JsonFilePath '.\restore-request.json' +``` + +Restores the protection group by using the request body in the JSON file. + +## PARAMETERS + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: RestoreViaIdentityCloudAccount, RestoreViaIdentityCloudAccountExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Restore, RestoreExpanded, RestoreViaJsonFilePath, RestoreViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InPlaceRestore +Check whether inplace or out of place restore. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RestoreExpanded, RestoreViaIdentityCloudAccountExpanded, RestoreViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: RestoreViaIdentity, RestoreViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Restore operation + +```yaml +Type: System.String +Parameter Sets: RestoreViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Restore operation + +```yaml +Type: System.String +Parameter Sets: RestoreViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the ProtectionGroup resource + +```yaml +Type: System.String +Parameter Sets: Restore, RestoreExpanded, RestoreViaIdentityCloudAccount, RestoreViaIdentityCloudAccountExpanded, RestoreViaJsonFilePath, RestoreViaJsonString +Aliases: ProtectionGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Request +The properties of RestoreProtectionItemRequest + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRestoreProtectionItemRequest +Parameter Sets: Restore, RestoreViaIdentity, RestoreViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Restore, RestoreExpanded, RestoreViaJsonFilePath, RestoreViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreType +Type of Restore + +```yaml +Type: System.String +Parameter Sets: RestoreExpanded, RestoreViaIdentityCloudAccountExpanded, RestoreViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Restore, RestoreExpanded, RestoreViaJsonFilePath, RestoreViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ToTime +Time to restore + +```yaml +Type: System.String +Parameter Sets: RestoreExpanded, RestoreViaIdentityCloudAccountExpanded, RestoreViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMDestinationInfoVminfoList +List of information on VMs + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IVMInfo[] +Parameter Sets: RestoreExpanded, RestoreViaIdentityCloudAccountExpanded, RestoreViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRestoreProtectionItemRequest + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRestoreProtectionItemResponse + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Resume-AzCommvaultProtectionGroupBackup.md b/src/Commvault/Commvault.Autorest/docs/Resume-AzCommvaultProtectionGroupBackup.md new file mode 100644 index 000000000000..e71e7e5a91fa --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Resume-AzCommvaultProtectionGroupBackup.md @@ -0,0 +1,217 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/resume-azcommvaultprotectiongroupbackup +schema: 2.0.0 +--- + +# Resume-AzCommvaultProtectionGroupBackup + +## SYNOPSIS +Resume Backup for a Protection Group. + +## SYNTAX + +### Resume (Default) +``` +Resume-AzCommvaultProtectionGroupBackup -CloudAccountName -ProtectionGroupName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +### ResumeViaIdentity +``` +Resume-AzCommvaultProtectionGroupBackup -InputObject [-DefaultProfile ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### ResumeViaIdentityCloudAccount +``` +Resume-AzCommvaultProtectionGroupBackup -CloudAccountInputObject + -ProtectionGroupName [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Resume Backup for a Protection Group. + +## EXAMPLES + +### Example 1: Resume the backups of a protection group +```powershell +Resume-AzCommvaultProtectionGroupBackup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms +``` + +Resumes the scheduled backups of a protection group whose backups were stopped. + +## PARAMETERS + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: ResumeViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Resume +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: ResumeViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionGroupName +Name of the ProtectionGroup resource + +```yaml +Type: System.String +Parameter Sets: Resume, ResumeViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Resume +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Resume +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Stop-AzCommvaultProtectionGroupBackup.md b/src/Commvault/Commvault.Autorest/docs/Stop-AzCommvaultProtectionGroupBackup.md new file mode 100644 index 000000000000..24c45096d806 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Stop-AzCommvaultProtectionGroupBackup.md @@ -0,0 +1,366 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/stop-azcommvaultprotectiongroupbackup +schema: 2.0.0 +--- + +# Stop-AzCommvaultProtectionGroupBackup + +## SYNOPSIS +Stop Backup for a Protection Group + +## SYNTAX + +### StopExpanded (Default) +``` +Stop-AzCommvaultProtectionGroupBackup -CloudAccountName -ProtectionGroupName + -ResourceGroupName -Reason [-SubscriptionId ] [-Comment ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Stop +``` +Stop-AzCommvaultProtectionGroupBackup -CloudAccountName -ProtectionGroupName + -ResourceGroupName -Request [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### StopViaIdentity +``` +Stop-AzCommvaultProtectionGroupBackup -InputObject + -Request [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### StopViaIdentityCloudAccount +``` +Stop-AzCommvaultProtectionGroupBackup -CloudAccountInputObject + -ProtectionGroupName -Request [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### StopViaIdentityCloudAccountExpanded +``` +Stop-AzCommvaultProtectionGroupBackup -CloudAccountInputObject + -ProtectionGroupName -Reason [-Comment ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### StopViaIdentityExpanded +``` +Stop-AzCommvaultProtectionGroupBackup -InputObject -Reason [-Comment ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### StopViaJsonFilePath +``` +Stop-AzCommvaultProtectionGroupBackup -CloudAccountName -ProtectionGroupName + -ResourceGroupName -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### StopViaJsonString +``` +Stop-AzCommvaultProtectionGroupBackup -CloudAccountName -ProtectionGroupName + -ResourceGroupName -JsonString [-SubscriptionId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Stop Backup for a Protection Group + +## EXAMPLES + +### Example 1: Stop the backups of a protection group +```powershell +Stop-AzCommvaultProtectionGroupBackup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -Reason 'Maintenance' -Comment 'Planned maintenance window' +``` + +Stops the scheduled backups of the protection group and records the reason and a comment. + +### Example 2: Stop the backups of a protection group by using a JSON request +```powershell +Stop-AzCommvaultProtectionGroupBackup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -JsonString '{"reason":"Maintenance","comment":"Planned maintenance window"}' +``` + +Stops the scheduled backups by passing the request body as a JSON string. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: StopViaIdentityCloudAccount, StopViaIdentityCloudAccountExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Stop, StopExpanded, StopViaJsonFilePath, StopViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +Any further comments + +```yaml +Type: System.String +Parameter Sets: StopExpanded, StopViaIdentityCloudAccountExpanded, StopViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: StopViaIdentity, StopViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Stop operation + +```yaml +Type: System.String +Parameter Sets: StopViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Stop operation + +```yaml +Type: System.String +Parameter Sets: StopViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionGroupName +Name of the ProtectionGroup resource + +```yaml +Type: System.String +Parameter Sets: Stop, StopExpanded, StopViaIdentityCloudAccount, StopViaIdentityCloudAccountExpanded, StopViaJsonFilePath, StopViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reason +The reason for stopping the backup + +```yaml +Type: System.String +Parameter Sets: StopExpanded, StopViaIdentityCloudAccountExpanded, StopViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Request +The properties of StopBackupProtectionGroupRequest + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IStopBackupProtectionGroupRequest +Parameter Sets: Stop, StopViaIdentity, StopViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Stop, StopExpanded, StopViaJsonFilePath, StopViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Stop, StopExpanded, StopViaJsonFilePath, StopViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IStopBackupProtectionGroupRequest + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Sync-AzCommvaultStorage.md b/src/Commvault/Commvault.Autorest/docs/Sync-AzCommvaultStorage.md new file mode 100644 index 000000000000..a62a1a20a68a --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Sync-AzCommvaultStorage.md @@ -0,0 +1,202 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/sync-azcommvaultstorage +schema: 2.0.0 +--- + +# Sync-AzCommvaultStorage + +## SYNOPSIS +Refresh storage state from partner. +Fetches latest compliance lock status from Commvault and refresh the ARM resource. + +## SYNTAX + +### Refresh (Default) +``` +Sync-AzCommvaultStorage -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### RefreshViaIdentity +``` +Sync-AzCommvaultStorage -InputObject [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### RefreshViaIdentityCloudAccount +``` +Sync-AzCommvaultStorage -CloudAccountInputObject -Name + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Refresh storage state from partner. +Fetches latest compliance lock status from Commvault and refresh the ARM resource. + +## EXAMPLES + +### Example 1: Refresh a storage +```powershell +Sync-AzCommvaultStorage -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name storage-hot +``` + +Refreshes the storage so that its properties, such as the compliance lock status, match the current state on the partner side. + +## PARAMETERS + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: RefreshViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Refresh +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: RefreshViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Storage resource + +```yaml +Type: System.String +Parameter Sets: Refresh, RefreshViaIdentityCloudAccount +Aliases: StorageName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Refresh +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Refresh +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IStorage + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Update-AzCommvaultCloudAccount.md b/src/Commvault/Commvault.Autorest/docs/Update-AzCommvaultCloudAccount.md new file mode 100644 index 000000000000..de79b112575b --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Update-AzCommvaultCloudAccount.md @@ -0,0 +1,576 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/update-azcommvaultcloudaccount +schema: 2.0.0 +--- + +# Update-AzCommvaultCloudAccount + +## SYNOPSIS +Update a CloudAccount + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzCommvaultCloudAccount -Name -ResourceGroupName [-SubscriptionId ] + [-CompanyCity ] [-CompanyCountry ] [-CompanyJobTitle ] [-CompanyName ] + [-CompanyPostalCode ] [-CompanyState ] [-CompanyStreet ] [-CompanyWebsite ] + [-EnableSystemAssignedIdentity ] [-MarketplaceSaasResourceId ] + [-MarketplaceSubscriptionId ] [-OfferDetailOfferId ] [-OfferDetailPlanId ] + [-OfferDetailPlanName ] [-OfferDetailPublisherId ] [-OfferDetailTermId ] + [-OfferDetailTermUnit ] [-Tag ] [-UserAssignedIdentity ] + [-UserEmailAddress ] [-UserFirstName ] [-UserLastName ] [-UserPhoneNumber ] + [-UserUpn ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzCommvaultCloudAccount -InputObject [-CompanyCity ] + [-CompanyCountry ] [-CompanyJobTitle ] [-CompanyName ] [-CompanyPostalCode ] + [-CompanyState ] [-CompanyStreet ] [-CompanyWebsite ] + [-EnableSystemAssignedIdentity ] [-MarketplaceSaasResourceId ] + [-MarketplaceSubscriptionId ] [-OfferDetailOfferId ] [-OfferDetailPlanId ] + [-OfferDetailPlanName ] [-OfferDetailPublisherId ] [-OfferDetailTermId ] + [-OfferDetailTermUnit ] [-Tag ] [-UserAssignedIdentity ] + [-UserEmailAddress ] [-UserFirstName ] [-UserLastName ] [-UserPhoneNumber ] + [-UserUpn ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update a CloudAccount + +## EXAMPLES + +### Example 1: Update the tags of a cloud account +```powershell +Update-AzCommvaultCloudAccount -ResourceGroupName rg-commvault -Name cca-contoso -Tag @{ Environment = 'Production' } +``` + +Updates the tags of the cloud account. + +### Example 2: Update the company details of a cloud account +```powershell +Update-AzCommvaultCloudAccount -ResourceGroupName rg-commvault -Name cca-contoso -CompanyName 'Contoso' -CompanyJobTitle 'Backup Operator' -CompanyCity 'Redmond' -CompanyState 'WA' -CompanyCountry 'USA' -CompanyPostalCode '98052' +``` + +Updates the company details of the cloud account. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyCity +City of the company address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyCountry +Country of the company address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyJobTitle +Job title + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyName +Company name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyPostalCode +Postal code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyState +State or province of the company address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyStreet +Street address + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyWebsite +Company website + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```yaml +Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MarketplaceSaasResourceId +Marketplace SaaS Resource Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketplaceSubscriptionId +Azure subscription id for the the marketplace offer is purchased from + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: CloudAccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailOfferId +Offer Id for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailPlanId +Plan Id for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailPlanName +Plan Name for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailPublisherId +Publisher Id for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailTermId +Plan Display Name for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailTermUnit +Plan Display Name for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserEmailAddress +Email address of the user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserFirstName +First name of the user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserLastName +Last name of the user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPhoneNumber +User's phone number + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserUpn +User's principal name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICloudAccount + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Update-AzCommvaultPlan.md b/src/Commvault/Commvault.Autorest/docs/Update-AzCommvaultPlan.md new file mode 100644 index 000000000000..4e0e92681f8a --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Update-AzCommvaultPlan.md @@ -0,0 +1,271 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/update-azcommvaultplan +schema: 2.0.0 +--- + +# Update-AzCommvaultPlan + +## SYNOPSIS +Update a CommvaultPlan + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzCommvaultPlan -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-RetentionNumberOfSnapshot ] [-Schedule ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityCloudAccountExpanded +``` +Update-AzCommvaultPlan -CloudAccountInputObject -Name + [-RetentionNumberOfSnapshot ] [-Schedule ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzCommvaultPlan -InputObject [-RetentionNumberOfSnapshot ] + [-Schedule ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Update a CommvaultPlan + +## EXAMPLES + +### Example 1: Update the retention of a backup plan +```powershell +Update-AzCommvaultPlan -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name plan-daily -RetentionNumberOfSnapshot 14 +``` + +Changes the backup plan so that it keeps 14 snapshots. + +### Example 2: Update the schedule of a backup plan +```powershell +$schedule = @{ BackupType = 'INCREMENTAL'; Frequency = 'daily'; RunsEvery = 1; Time = '23:30'; TimeZone = 'UTC' } +Update-AzCommvaultPlan -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name plan-daily -Schedule $schedule +``` + +Changes the backup plan so that the daily incremental backup runs at 23:30 UTC. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: UpdateViaIdentityCloudAccountExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Plan resource + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityCloudAccountExpanded +Aliases: PlanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionNumberOfSnapshot +Number of Snapshots + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Schedule +The Commvault Plan Schedule + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ISchedule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultPlan + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Update-AzCommvaultProtectionGroup.md b/src/Commvault/Commvault.Autorest/docs/Update-AzCommvaultProtectionGroup.md new file mode 100644 index 000000000000..4902fd5b955f --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Update-AzCommvaultProtectionGroup.md @@ -0,0 +1,301 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/update-azcommvaultprotectiongroup +schema: 2.0.0 +--- + +# Update-AzCommvaultProtectionGroup + +## SYNOPSIS +Update a ProtectionGroup + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzCommvaultProtectionGroup -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-MatchRule ] [-MatchRuleMatchType ] [-Plan ] + [-ResourceManual ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentityCloudAccountExpanded +``` +Update-AzCommvaultProtectionGroup -CloudAccountInputObject -Name + [-MatchRule ] [-MatchRuleMatchType ] [-Plan ] [-ResourceManual ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzCommvaultProtectionGroup -InputObject [-MatchRule ] + [-MatchRuleMatchType ] [-Plan ] [-ResourceManual ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update a ProtectionGroup + +## EXAMPLES + +### Example 1: Change the backup plan of a protection group +```powershell +Update-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms -Plan plan-weekly +``` + +Changes the protection group to use the backup plan plan-weekly. + +### Example 2: Change the virtual machines of a protection group +```powershell +Update-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms -ResourceManual '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-app/providers/Microsoft.Compute/virtualMachines/vm-app02' +``` + +Changes the protection group so that it protects the specified virtual machine. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: UpdateViaIdentityCloudAccountExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MatchRule +rules to match + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchRuleMatchType +match Type all or any + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the ProtectionGroup resource + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityCloudAccountExpanded +Aliases: ProtectionGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Plan +The Commvault Plan to be associated with the Protection Group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceManual +The items to be protected under Protection Group + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IProtectionGroup + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Update-AzCommvaultRoleMapping.md b/src/Commvault/Commvault.Autorest/docs/Update-AzCommvaultRoleMapping.md new file mode 100644 index 000000000000..951fb5421d51 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Update-AzCommvaultRoleMapping.md @@ -0,0 +1,183 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/update-azcommvaultrolemapping +schema: 2.0.0 +--- + +# Update-AzCommvaultRoleMapping + +## SYNOPSIS +Update a RoleMapping + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzCommvaultRoleMapping -CloudAccountName -ResourceGroupName + [-SubscriptionId ] [-Role ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzCommvaultRoleMapping -InputObject [-Role ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update a RoleMapping + +## EXAMPLES + +### Example 1: Update the role mapping of a cloud account +```powershell +$roles = @( + @{ RoleName = 'BackupOperator'; Entity = @(@{ Id = '11111111-2222-3333-4444-555555555555'; DisplayName = 'Commvault-Operators'; EntityType = 'Group' }) } +) +Update-AzCommvaultRoleMapping -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Role $roles +``` + +Updates the role mapping so that the BackupOperator role is assigned to the specified Microsoft Entra group. + +## PARAMETERS + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +The list of role assignments mapping roles to Entra entities (users and groups) + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRoleAssignment[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRoleMapping + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/docs/Update-AzCommvaultStorage.md b/src/Commvault/Commvault.Autorest/docs/Update-AzCommvaultStorage.md new file mode 100644 index 000000000000..c5ecfca70d25 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/docs/Update-AzCommvaultStorage.md @@ -0,0 +1,247 @@ +--- +external help file: +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/update-azcommvaultstorage +schema: 2.0.0 +--- + +# Update-AzCommvaultStorage + +## SYNOPSIS +Update a Storage + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzCommvaultStorage -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-StorageClassType ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityCloudAccountExpanded +``` +Update-AzCommvaultStorage -CloudAccountInputObject -Name + [-StorageClassType ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzCommvaultStorage -InputObject [-StorageClassType ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update a Storage + +## EXAMPLES + +### Example 1: Change the class of a storage +```powershell +Update-AzCommvaultStorage -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name storage-hot -StorageClassType COLD +``` + +Changes the class of the storage to cold. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: UpdateViaIdentityCloudAccountExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Storage resource + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityCloudAccountExpanded +Aliases: StorageName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageClassType +The class of Commvault Storage + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IStorage + +## NOTES + +## RELATED LINKS + diff --git a/src/Commvault/Commvault.Autorest/examples/Backup-AzCommvaultProtectionGroup.md b/src/Commvault/Commvault.Autorest/examples/Backup-AzCommvaultProtectionGroup.md new file mode 100644 index 000000000000..25aa4941dc96 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Backup-AzCommvaultProtectionGroup.md @@ -0,0 +1,14 @@ +### Example 1: Run an ad-hoc backup of a virtual machine +```powershell +Backup-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms -BackupOptionBackupCopyImmediately -BackupOptionJobDescription 'Ad-hoc backup job' -BackupOptionNotifyUserOnJobCompletion -BackupOptionRunSnapShotBackup -VMList @{ VMGuid = '40000000-aaaa-4bbb-8ccc-000000000000' } +``` + +Starts an ad-hoc backup job for the specified virtual machine in the protection group. + +### Example 2: Run an ad-hoc backup by using a JSON request +```powershell +Backup-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms -JsonString '{"vmList":[{"vmGuid":"40000000-aaaa-4bbb-8ccc-000000000000"}],"backupOptions":{"backupLevel":"FULL","jobDescription":"Ad-hoc backup job","backupCopyImmediately":true,"runSnapShotBackup":true,"notifyUserOnJobCompletion":true}}' +``` + +Starts a full ad-hoc backup job by passing the request body as a JSON string. + diff --git a/src/Commvault/Commvault.Autorest/examples/Connect-AzCommvaultCloudAccountSaaS.md b/src/Commvault/Commvault.Autorest/examples/Connect-AzCommvaultCloudAccountSaaS.md new file mode 100644 index 000000000000..3698f2879d9e --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Connect-AzCommvaultCloudAccountSaaS.md @@ -0,0 +1,14 @@ +### Example 1: Link a SaaS resource to a cloud account +```powershell +Connect-AzCommvaultCloudAccountSaaS -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -SaaSResourceId '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Microsoft.SaaS/resources/commvault-saas' +``` + +Links the SaaS resource to the cloud account. + +### Example 2: Link a SaaS resource to a cloud account by using a JSON request +```powershell +Connect-AzCommvaultCloudAccountSaaS -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -JsonString '{"saaSResourceId":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Microsoft.SaaS/resources/commvault-saas"}' +``` + +Links the SaaS resource to the cloud account by passing the request body as a JSON string. + diff --git a/src/Commvault/Commvault.Autorest/examples/Disable-AzCommvaultStorageComplianceLock.md b/src/Commvault/Commvault.Autorest/examples/Disable-AzCommvaultStorageComplianceLock.md new file mode 100644 index 000000000000..ea76a71db436 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Disable-AzCommvaultStorageComplianceLock.md @@ -0,0 +1,8 @@ +### Example 1: Disable the compliance lock on a storage +```powershell +Disable-AzCommvaultStorageComplianceLock -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -StorageName storage-hot +``` + +Starts the multi-person authorization approval workflow to disable the compliance lock. +The compliance lock status changes to `DisablementPending` until the approval completes. + diff --git a/src/Commvault/Commvault.Autorest/examples/Enable-AzCommvaultStorageComplianceLock.md b/src/Commvault/Commvault.Autorest/examples/Enable-AzCommvaultStorageComplianceLock.md new file mode 100644 index 000000000000..67959e550025 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Enable-AzCommvaultStorageComplianceLock.md @@ -0,0 +1,7 @@ +### Example 1: Enable the compliance lock on a storage +```powershell +Enable-AzCommvaultStorageComplianceLock -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -StorageName storage-hot +``` + +Enables the compliance lock on the storage. + diff --git a/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultCloudAccount.md b/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultCloudAccount.md new file mode 100644 index 000000000000..967cdff89fac --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultCloudAccount.md @@ -0,0 +1,21 @@ +### Example 1: List the cloud accounts in a subscription +```powershell +Get-AzCommvaultCloudAccount +``` + +Lists all cloud accounts in the current subscription. + +### Example 2: List the cloud accounts in a resource group +```powershell +Get-AzCommvaultCloudAccount -ResourceGroupName rg-commvault +``` + +Lists the cloud accounts in the resource group. + +### Example 3: Get a cloud account +```powershell +Get-AzCommvaultCloudAccount -ResourceGroupName rg-commvault -Name cca-contoso +``` + +Gets the cloud account named cca-contoso. + diff --git a/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultCloudAccountLatestLinkedSaaS.md b/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultCloudAccountLatestLinkedSaaS.md new file mode 100644 index 000000000000..bb75d175b704 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultCloudAccountLatestLinkedSaaS.md @@ -0,0 +1,7 @@ +### Example 1: Get the latest linked SaaS of a cloud account +```powershell +Get-AzCommvaultCloudAccountLatestLinkedSaaS -ResourceGroupName rg-commvault -CloudAccountName cca-contoso +``` + +Gets the SaaS resource that was most recently linked to the cloud account. + diff --git a/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultPlan.md b/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultPlan.md new file mode 100644 index 000000000000..7039fe5ede4d --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultPlan.md @@ -0,0 +1,14 @@ +### Example 1: List the backup plans of a cloud account +```powershell +Get-AzCommvaultPlan -ResourceGroupName rg-commvault -CloudAccountName cca-contoso +``` + +Lists the backup plans of the cloud account. + +### Example 2: Get a backup plan +```powershell +Get-AzCommvaultPlan -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name plan-daily +``` + +Gets the backup plan named plan-daily. + diff --git a/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultProtectedItem.md b/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultProtectedItem.md new file mode 100644 index 000000000000..7573ad21fc97 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultProtectedItem.md @@ -0,0 +1,14 @@ +### Example 1: List the protected items of a protection group +```powershell +Get-AzCommvaultProtectedItem -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms +``` + +Lists the protected items in the protection group. + +### Example 2: Get a protected item +```powershell +Get-AzCommvaultProtectedItem -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -Name vm-app01 +``` + +Gets the protected item named vm-app01. + diff --git a/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultProtectedItemCount.md b/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultProtectedItemCount.md new file mode 100644 index 000000000000..1380ab9380a8 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultProtectedItemCount.md @@ -0,0 +1,14 @@ +### Example 1: Count the protected items of cloud accounts +```powershell +Get-AzCommvaultProtectedItemCount -ResourceId '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Commvault.ContentStore/cloudAccounts/cca-contoso', '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Commvault.ContentStore/cloudAccounts/cca-fabrikam' +``` + +Gets the number of protected items for each of the specified cloud accounts. + +### Example 2: Count the protected items by using a JSON request +```powershell +Get-AzCommvaultProtectedItemCount -JsonString '{"resourceIds":["/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Commvault.ContentStore/cloudAccounts/cca-contoso"]}' +``` + +Gets the number of protected items by passing the request body as a JSON string. + diff --git a/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultProtectedItemRestorePoint.md b/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultProtectedItemRestorePoint.md new file mode 100644 index 000000000000..60a4b55f4452 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultProtectedItemRestorePoint.md @@ -0,0 +1,7 @@ +### Example 1: Get the restore points of a protected item +```powershell +Get-AzCommvaultProtectedItemRestorePoint -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -ProtectedItemName vm-app01 +``` + +Gets the restore points that are available for the protected item. + diff --git a/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultProtectionGroup.md b/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultProtectionGroup.md new file mode 100644 index 000000000000..704298b2742c --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultProtectionGroup.md @@ -0,0 +1,14 @@ +### Example 1: List the protection groups of a cloud account +```powershell +Get-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso +``` + +Lists the protection groups of the cloud account. + +### Example 2: Get a protection group +```powershell +Get-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms +``` + +Gets the protection group named pg-prod-vms. + diff --git a/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultRoleMapping.md b/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultRoleMapping.md new file mode 100644 index 000000000000..c9e0719739d7 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultRoleMapping.md @@ -0,0 +1,8 @@ +### Example 1: Get the role mapping of a cloud account +```powershell +Get-AzCommvaultRoleMapping -ResourceGroupName rg-commvault -CloudAccountName cca-contoso +``` + +Gets the role mapping of the cloud account. +Each cloud account has a single role mapping that maps Commvault roles to Microsoft Entra users and groups. + diff --git a/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultStorage.md b/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultStorage.md new file mode 100644 index 000000000000..f5da0514d136 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultStorage.md @@ -0,0 +1,14 @@ +### Example 1: List the storages of a cloud account +```powershell +Get-AzCommvaultStorage -ResourceGroupName rg-commvault -CloudAccountName cca-contoso +``` + +Lists the storages of the cloud account. + +### Example 2: Get a storage +```powershell +Get-AzCommvaultStorage -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name storage-hot +``` + +Gets the storage named storage-hot. + diff --git a/src/Commvault/Commvault.Autorest/examples/Initialize-AzCommvaultSaaS.md b/src/Commvault/Commvault.Autorest/examples/Initialize-AzCommvaultSaaS.md new file mode 100644 index 000000000000..8e601a92424b --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Initialize-AzCommvaultSaaS.md @@ -0,0 +1,14 @@ +### Example 1: Activate a SaaS resource +```powershell +Initialize-AzCommvaultSaaS -SaasGuid '55555555-6666-7777-8888-999999999999' -PublisherId 'contoso-publisher' -ActivateSaaSRequestParamSaasResourceId '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Microsoft.SaaS/resources/commvault-saas' -UserFirstName 'John' -UserLastName 'Smith' -UserEmailAddress 'john.smith@contoso.com' -UserUpn 'john.smith@contoso.com' -CompanyName 'Contoso' +``` + +Activates the SaaS resource for the specified user and company. + +### Example 2: Activate a SaaS resource by using a JSON request +```powershell +Initialize-AzCommvaultSaaS -JsonString '{"saasGuid":"55555555-6666-7777-8888-999999999999","publisherId":"contoso-publisher","activateSaaSRequestParam":{"saasResourceId":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Microsoft.SaaS/resources/commvault-saas","user":{"firstName":"John","lastName":"Smith","emailAddress":"john.smith@contoso.com","upn":"john.smith@contoso.com"},"company":{"companyName":"Contoso"}}}' +``` + +Activates the SaaS resource by passing the request body as a JSON string. + diff --git a/src/Commvault/Commvault.Autorest/examples/New-AzCommvaultCloudAccount.md b/src/Commvault/Commvault.Autorest/examples/New-AzCommvaultCloudAccount.md new file mode 100644 index 000000000000..34775cef2159 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/New-AzCommvaultCloudAccount.md @@ -0,0 +1,25 @@ +### Example 1: Create a cloud account +```powershell +New-AzCommvaultCloudAccount -ResourceGroupName rg-commvault -Name cca-contoso -Location eastus -EnableSystemAssignedIdentity -MarketplaceSubscriptionId '00000000-0000-0000-0000-000000000000' -OfferDetailPublisherId 'contoso-publisher' -OfferDetailOfferId 'contoso-offer' -OfferDetailPlanId 'contoso-plan' -OfferDetailPlanName 'Contoso Plan' -OfferDetailTermUnit 'P1M' -OfferDetailTermId 'contoso-term' -UserFirstName 'John' -UserLastName 'Doe' -UserEmailAddress 'john.doe@contoso.com' -UserUpn 'john.doe@contoso.com' +``` + +Creates a cloud account with a system-assigned managed identity. + +### Example 2: Create a cloud account and assign roles to Microsoft Entra groups +```powershell +$roleAssignments = @( + @{ RoleName = 'BackupAdmin'; Entity = @(@{ Id = 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'; DisplayName = 'Tenant Admins'; EntityType = 'Group' }) }, + @{ RoleName = 'BackupOperator'; Entity = @(@{ Id = '44444444-5555-6666-7777-888888888888'; DisplayName = 'Ops Team'; EntityType = 'Group' }) } +) +New-AzCommvaultCloudAccount -ResourceGroupName rg-commvault -Name cca-contoso -Location eastus -EnableSystemAssignedIdentity -MarketplaceSubscriptionId '00000000-0000-0000-0000-000000000000' -OfferDetailPublisherId 'contoso-publisher' -OfferDetailOfferId 'contoso-offer' -OfferDetailPlanId 'contoso-plan' -OfferDetailPlanName 'Contoso Plan' -OfferDetailTermUnit 'P1M' -OfferDetailTermId 'contoso-term' -UserFirstName 'John' -UserLastName 'Doe' -UserEmailAddress 'john.doe@contoso.com' -UserUpn 'john.doe@contoso.com' -RoleAssignmentsOnCcaCreate $roleAssignments +``` + +Creates a cloud account and assigns the Commvault roles to the specified Microsoft Entra groups. + +### Example 3: Create a cloud account by using a JSON file +```powershell +New-AzCommvaultCloudAccount -ResourceGroupName rg-commvault -Name cca-contoso -JsonFilePath '.\cloud-account.json' +``` + +Creates a cloud account from the request body in the JSON file. + diff --git a/src/Commvault/Commvault.Autorest/examples/New-AzCommvaultPlan.md b/src/Commvault/Commvault.Autorest/examples/New-AzCommvaultPlan.md new file mode 100644 index 000000000000..10f4782de597 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/New-AzCommvaultPlan.md @@ -0,0 +1,16 @@ +### Example 1: Create a backup plan +```powershell +$storagePlan = @{ Name = 'primary'; StoragePoolId = 'storage-hot'; CopyName = 'primary-copy'; CopyPrecedence = 1; RetentionPeriod = 30; RetentionTime = 'monthly'; BackupRuleType = 'ALL_JOBS' } +$schedule = @{ BackupType = 'INCREMENTAL'; Frequency = 'daily'; RunsEvery = 1; Time = '22:00'; TimeZone = 'UTC' } +New-AzCommvaultPlan -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -PlanName plan-daily -Location eastus -StoragePlan $storagePlan -Schedule $schedule -RetentionNumberOfSnapshot 7 +``` + +Creates a backup plan that runs an incremental backup every day and keeps seven snapshots. + +### Example 2: Create a backup plan by using a JSON file +```powershell +New-AzCommvaultPlan -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -PlanName plan-daily -JsonFilePath '.\plan.json' +``` + +Creates a backup plan from the request body in the JSON file. + diff --git a/src/Commvault/Commvault.Autorest/examples/New-AzCommvaultProtectionGroup.md b/src/Commvault/Commvault.Autorest/examples/New-AzCommvaultProtectionGroup.md new file mode 100644 index 000000000000..9db11cafb3e1 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/New-AzCommvaultProtectionGroup.md @@ -0,0 +1,15 @@ +### Example 1: Create a protection group for specific virtual machines +```powershell +New-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -Plan plan-daily -ResourceManual '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-app/providers/Microsoft.Compute/virtualMachines/vm-app01' +``` + +Creates a protection group that protects the specified virtual machine with the backup plan plan-daily. + +### Example 2: Create a protection group that selects virtual machines by a rule +```powershell +$rule = @{ Property = 'resourceGroup'; Operator = 'contains'; Value = 'prod' } +New-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -Plan plan-daily -MatchRule $rule -MatchRuleMatchType 'all' +``` + +Creates a protection group that protects the virtual machines whose resource group name contains prod. + diff --git a/src/Commvault/Commvault.Autorest/examples/New-AzCommvaultRoleMapping.md b/src/Commvault/Commvault.Autorest/examples/New-AzCommvaultRoleMapping.md new file mode 100644 index 000000000000..d48c7e7ed309 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/New-AzCommvaultRoleMapping.md @@ -0,0 +1,18 @@ +### Example 1: Create the role mapping of a cloud account +```powershell +$roles = @( + @{ RoleName = 'BackupAdmin'; Entity = @(@{ Id = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890'; DisplayName = 'Backup Admins Group'; EntityType = 'Group' }) }, + @{ RoleName = 'BackupUser'; Entity = @(@{ Id = '22222222-3333-4444-5555-666666666666'; DisplayName = 'Jane Doe'; EntityType = 'User' }) } +) +New-AzCommvaultRoleMapping -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Role $roles +``` + +Maps the BackupAdmin and BackupUser roles to a Microsoft Entra group and user. + +### Example 2: Create the role mapping by using a JSON file +```powershell +New-AzCommvaultRoleMapping -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -JsonFilePath '.\role-mapping.json' +``` + +Creates the role mapping from the request body in the JSON file. + diff --git a/src/Commvault/Commvault.Autorest/examples/New-AzCommvaultStorage.md b/src/Commvault/Commvault.Autorest/examples/New-AzCommvaultStorage.md new file mode 100644 index 000000000000..096eb9d187d3 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/New-AzCommvaultStorage.md @@ -0,0 +1,14 @@ +### Example 1: Create a hot storage +```powershell +New-AzCommvaultStorage -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name storage-hot -Location eastus -StorageClassType HOT +``` + +Creates a hot storage in the East US region. + +### Example 2: Create a cold storage +```powershell +New-AzCommvaultStorage -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name storage-cold -Location eastus -StorageClassType COLD +``` + +Creates a cold storage in the East US region. + diff --git a/src/Commvault/Commvault.Autorest/examples/Remove-AzCommvaultCloudAccount.md b/src/Commvault/Commvault.Autorest/examples/Remove-AzCommvaultCloudAccount.md new file mode 100644 index 000000000000..2efc48dcddd2 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Remove-AzCommvaultCloudAccount.md @@ -0,0 +1,7 @@ +### Example 1: Delete a cloud account +```powershell +Remove-AzCommvaultCloudAccount -ResourceGroupName rg-commvault -Name cca-contoso +``` + +Deletes the cloud account named cca-contoso. + diff --git a/src/Commvault/Commvault.Autorest/examples/Remove-AzCommvaultPlan.md b/src/Commvault/Commvault.Autorest/examples/Remove-AzCommvaultPlan.md new file mode 100644 index 000000000000..5ca6f7340ee5 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Remove-AzCommvaultPlan.md @@ -0,0 +1,7 @@ +### Example 1: Delete a backup plan +```powershell +Remove-AzCommvaultPlan -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name plan-daily +``` + +Deletes the backup plan named plan-daily. + diff --git a/src/Commvault/Commvault.Autorest/examples/Remove-AzCommvaultProtectionGroup.md b/src/Commvault/Commvault.Autorest/examples/Remove-AzCommvaultProtectionGroup.md new file mode 100644 index 000000000000..2d26c36750e2 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Remove-AzCommvaultProtectionGroup.md @@ -0,0 +1,7 @@ +### Example 1: Delete a protection group +```powershell +Remove-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms +``` + +Deletes the protection group named pg-prod-vms. + diff --git a/src/Commvault/Commvault.Autorest/examples/Remove-AzCommvaultRoleMapping.md b/src/Commvault/Commvault.Autorest/examples/Remove-AzCommvaultRoleMapping.md new file mode 100644 index 000000000000..4aea99d7d310 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Remove-AzCommvaultRoleMapping.md @@ -0,0 +1,7 @@ +### Example 1: Delete the role mapping of a cloud account +```powershell +Remove-AzCommvaultRoleMapping -ResourceGroupName rg-commvault -CloudAccountName cca-contoso +``` + +Deletes the role mapping of the cloud account. + diff --git a/src/Commvault/Commvault.Autorest/examples/Remove-AzCommvaultStorage.md b/src/Commvault/Commvault.Autorest/examples/Remove-AzCommvaultStorage.md new file mode 100644 index 000000000000..5dfdb1e602ed --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Remove-AzCommvaultStorage.md @@ -0,0 +1,7 @@ +### Example 1: Delete a storage +```powershell +Remove-AzCommvaultStorage -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name storage-cold +``` + +Deletes the storage named storage-cold. + diff --git a/src/Commvault/Commvault.Autorest/examples/Restore-AzCommvaultProtectedItem.md b/src/Commvault/Commvault.Autorest/examples/Restore-AzCommvaultProtectedItem.md new file mode 100644 index 000000000000..4c300a4073d1 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Restore-AzCommvaultProtectedItem.md @@ -0,0 +1,14 @@ +### Example 1: Restore a protected item in place +```powershell +Restore-AzCommvaultProtectedItem -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -Name vm-app01 -InPlaceRestore -VMDestinationInfoVminfoList @{ SourceVMGuid = '40000000-aaaa-4bbb-8ccc-000000000000'; StorageAccountId = '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-restore/providers/Microsoft.Storage/storageAccounts/strestore01'; PowerOnVMAfterRestore = $true } +``` + +Restores the virtual machine in place and powers it on after the restore completes. + +### Example 2: Restore a protected item as a new virtual machine by using a JSON request +```powershell +Restore-AzCommvaultProtectedItem -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -Name vm-app01 -JsonString '{"inPlaceRestore":false,"restoreType":"VIRTUAL_MACHINE","vmDestinationInfo":{"vmInfoList":[{"sourceVmGuid":"40000000-aaaa-4bbb-8ccc-000000000000","name":"vm-app01-restored","resourceGroup":"rg-restore","region":"eastus","storageAccountId":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-restore/providers/Microsoft.Storage/storageAccounts/strestore01","networkId":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-restore/providers/Microsoft.Network/virtualNetworks/vnet-restore","subnetId":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-restore/providers/Microsoft.Network/virtualNetworks/vnet-restore/subnets/default","powerOnVmAfterRestore":true}]}}' +``` + +Restores the virtual machine as a new virtual machine in another resource group and region by passing the request body as a JSON string. + diff --git a/src/Commvault/Commvault.Autorest/examples/Restore-AzCommvaultProtectionGroup.md b/src/Commvault/Commvault.Autorest/examples/Restore-AzCommvaultProtectionGroup.md new file mode 100644 index 000000000000..14646577c8d2 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Restore-AzCommvaultProtectionGroup.md @@ -0,0 +1,14 @@ +### Example 1: Restore a protection group in place +```powershell +Restore-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms -InPlaceRestore -VMDestinationInfoVminfoList @{ SourceVMGuid = '40000000-aaaa-4bbb-8ccc-000000000000'; StorageAccountId = '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-restore/providers/Microsoft.Storage/storageAccounts/strestore01'; PowerOnVMAfterRestore = $true } +``` + +Restores the specified virtual machine of the protection group in place and powers it on after the restore completes. + +### Example 2: Restore a protection group by using a JSON file +```powershell +Restore-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms -JsonFilePath '.\restore-request.json' +``` + +Restores the protection group by using the request body in the JSON file. + diff --git a/src/Commvault/Commvault.Autorest/examples/Resume-AzCommvaultProtectionGroupBackup.md b/src/Commvault/Commvault.Autorest/examples/Resume-AzCommvaultProtectionGroupBackup.md new file mode 100644 index 000000000000..84aa918a3477 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Resume-AzCommvaultProtectionGroupBackup.md @@ -0,0 +1,7 @@ +### Example 1: Resume the backups of a protection group +```powershell +Resume-AzCommvaultProtectionGroupBackup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms +``` + +Resumes the scheduled backups of a protection group whose backups were stopped. + diff --git a/src/Commvault/Commvault.Autorest/examples/Stop-AzCommvaultProtectionGroupBackup.md b/src/Commvault/Commvault.Autorest/examples/Stop-AzCommvaultProtectionGroupBackup.md new file mode 100644 index 000000000000..3557bb43992d --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Stop-AzCommvaultProtectionGroupBackup.md @@ -0,0 +1,14 @@ +### Example 1: Stop the backups of a protection group +```powershell +Stop-AzCommvaultProtectionGroupBackup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -Reason 'Maintenance' -Comment 'Planned maintenance window' +``` + +Stops the scheduled backups of the protection group and records the reason and a comment. + +### Example 2: Stop the backups of a protection group by using a JSON request +```powershell +Stop-AzCommvaultProtectionGroupBackup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -JsonString '{"reason":"Maintenance","comment":"Planned maintenance window"}' +``` + +Stops the scheduled backups by passing the request body as a JSON string. + diff --git a/src/Commvault/Commvault.Autorest/examples/Sync-AzCommvaultStorage.md b/src/Commvault/Commvault.Autorest/examples/Sync-AzCommvaultStorage.md new file mode 100644 index 000000000000..5cf28dfd454b --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Sync-AzCommvaultStorage.md @@ -0,0 +1,7 @@ +### Example 1: Refresh a storage +```powershell +Sync-AzCommvaultStorage -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name storage-hot +``` + +Refreshes the storage so that its properties, such as the compliance lock status, match the current state on the partner side. + diff --git a/src/Commvault/Commvault.Autorest/examples/Update-AzCommvaultCloudAccount.md b/src/Commvault/Commvault.Autorest/examples/Update-AzCommvaultCloudAccount.md new file mode 100644 index 000000000000..3777d4e14280 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Update-AzCommvaultCloudAccount.md @@ -0,0 +1,14 @@ +### Example 1: Update the tags of a cloud account +```powershell +Update-AzCommvaultCloudAccount -ResourceGroupName rg-commvault -Name cca-contoso -Tag @{ Environment = 'Production' } +``` + +Updates the tags of the cloud account. + +### Example 2: Update the company details of a cloud account +```powershell +Update-AzCommvaultCloudAccount -ResourceGroupName rg-commvault -Name cca-contoso -CompanyName 'Contoso' -CompanyJobTitle 'Backup Operator' -CompanyCity 'Redmond' -CompanyState 'WA' -CompanyCountry 'USA' -CompanyPostalCode '98052' +``` + +Updates the company details of the cloud account. + diff --git a/src/Commvault/Commvault.Autorest/examples/Update-AzCommvaultPlan.md b/src/Commvault/Commvault.Autorest/examples/Update-AzCommvaultPlan.md new file mode 100644 index 000000000000..53800d8ad6f2 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Update-AzCommvaultPlan.md @@ -0,0 +1,15 @@ +### Example 1: Update the retention of a backup plan +```powershell +Update-AzCommvaultPlan -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name plan-daily -RetentionNumberOfSnapshot 14 +``` + +Changes the backup plan so that it keeps 14 snapshots. + +### Example 2: Update the schedule of a backup plan +```powershell +$schedule = @{ BackupType = 'INCREMENTAL'; Frequency = 'daily'; RunsEvery = 1; Time = '23:30'; TimeZone = 'UTC' } +Update-AzCommvaultPlan -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name plan-daily -Schedule $schedule +``` + +Changes the backup plan so that the daily incremental backup runs at 23:30 UTC. + diff --git a/src/Commvault/Commvault.Autorest/examples/Update-AzCommvaultProtectionGroup.md b/src/Commvault/Commvault.Autorest/examples/Update-AzCommvaultProtectionGroup.md new file mode 100644 index 000000000000..6803394cf4c9 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Update-AzCommvaultProtectionGroup.md @@ -0,0 +1,14 @@ +### Example 1: Change the backup plan of a protection group +```powershell +Update-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms -Plan plan-weekly +``` + +Changes the protection group to use the backup plan plan-weekly. + +### Example 2: Change the virtual machines of a protection group +```powershell +Update-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms -ResourceManual '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-app/providers/Microsoft.Compute/virtualMachines/vm-app02' +``` + +Changes the protection group so that it protects the specified virtual machine. + diff --git a/src/Commvault/Commvault.Autorest/examples/Update-AzCommvaultRoleMapping.md b/src/Commvault/Commvault.Autorest/examples/Update-AzCommvaultRoleMapping.md new file mode 100644 index 000000000000..8233be0c194e --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Update-AzCommvaultRoleMapping.md @@ -0,0 +1,10 @@ +### Example 1: Update the role mapping of a cloud account +```powershell +$roles = @( + @{ RoleName = 'BackupOperator'; Entity = @(@{ Id = '11111111-2222-3333-4444-555555555555'; DisplayName = 'Commvault-Operators'; EntityType = 'Group' }) } +) +Update-AzCommvaultRoleMapping -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Role $roles +``` + +Updates the role mapping so that the BackupOperator role is assigned to the specified Microsoft Entra group. + diff --git a/src/Commvault/Commvault.Autorest/examples/Update-AzCommvaultStorage.md b/src/Commvault/Commvault.Autorest/examples/Update-AzCommvaultStorage.md new file mode 100644 index 000000000000..c163c6e03b9f --- /dev/null +++ b/src/Commvault/Commvault.Autorest/examples/Update-AzCommvaultStorage.md @@ -0,0 +1,7 @@ +### Example 1: Change the class of a storage +```powershell +Update-AzCommvaultStorage -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name storage-hot -StorageClassType COLD +``` + +Changes the class of the storage to cold. + diff --git a/src/Commvault/Commvault.Autorest/generate-info.json b/src/Commvault/Commvault.Autorest/generate-info.json new file mode 100644 index 000000000000..c7ae4823c785 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/generate-info.json @@ -0,0 +1,3 @@ +{ + "generate_Id": "a8d0b7c8-6226-49eb-91b2-ddfbf39b0d94" +} diff --git a/src/Commvault/Commvault.Autorest/how-to.md b/src/Commvault/Commvault.Autorest/how-to.md new file mode 100644 index 000000000000..cdc67186e9f0 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/how-to.md @@ -0,0 +1,58 @@ +# How-To +This document describes how to develop for `Az.Commvault`. + +## Building `Az.Commvault` +To build, run the `build-module.ps1` at the root of the module directory. This will generate the proxy script cmdlets that are the cmdlets being exported by this module. After the build completes, the proxy script cmdlets will be output to the `exports` folder. To read more about the proxy script cmdlets, look at the [README.md](exports/README.md) in the `exports` folder. + +## Creating custom cmdlets +To add cmdlets that were not generated by the REST specification, use the `custom` folder. This folder allows you to add handwritten `.ps1` and `.cs` files. Currently, we support using `.ps1` scripts as new cmdlets or as additional low-level variants (via `ParameterSet`), and `.cs` files as low-level (variants) cmdlets that the exported script cmdlets call. We do not support exporting any `.cs` (dll) cmdlets directly. To read more about custom cmdlets, look at the [README.md](custom/README.md) in the `custom` folder. + +## Generating documentation +To generate documentation, the process is now integrated into the `build-module.ps1` script. If you don't want to run this process as part of `build-module.ps1`, you can provide the `-NoDocs` switch. If you want to run documentation generation after the build process, you may still run the `generate-help.ps1` script. Overall, the process will look at the documentation comments in the generated and custom cmdlets and types, and create `.md` files into the `docs` folder. Additionally, this pulls in any examples from the `examples` folder and adds them to the generated help markdown documents. To read more about examples, look at the [README.md](examples/README.md) in the `examples` folder. To read more about documentation, look at the [README.md](docs/README.md) in the `docs` folder. + +## Testing `Az.Commvault` +To test the cmdlets, we use [Pester](https://github.com/pester/Pester). Tests scripts (`.ps1`) should be added to the `test` folder. To execute the Pester tests, run the `test-module.ps1` script. This will run all tests in `playback` mode within the `test` folder. To read more about testing cmdlets, look at the [README.md](examples/README.md) in the `examples` folder. + +## Packing `Az.Commvault` +To pack `Az.Commvault` for distribution, run the `pack-module.ps1` script. This will take the contents of multiple directories and certain root-folder files to create a `.nupkg`. The structure of the `.nupkg` is created so it can be loaded part of a [PSRepository](https://learn.microsoft.com/powershell/module/powershellget/register-psrepository). Additionally, this package is in a format for distribution to the [PSGallery](https://www.powershellgallery.com/). For signing an Azure module, please contact the [Azure PowerShell](https://github.com/Azure/azure-powershell) team. + +## Module Script Details +There are multiple scripts created for performing different actions for developing `Az.Commvault`. +- `build-module.ps1` + - Builds the module DLL (`./bin/Az.Commvault.private.dll`), creates the exported cmdlets and documentation, generates custom cmdlet test stubs and exported cmdlet example stubs, and updates `./Az.Commvault.psd1` with Azure profile information. + - **Parameters**: [`Switch` parameters] + - `-Run`: After building, creates an isolated PowerShell session and loads `Az.Commvault`. + - `-Test`: After building, runs the `Pester` tests defined in the `test` folder. + - `-Docs`: After building, generates the Markdown documents for the modules into the `docs` folder. + - `-Pack`: After building, packages the module into a `.nupkg`. + - `-Code`: After building, opens a VSCode window with the module's directory and runs (see `-Run`) the module. + - `-Release`: Builds the module in `Release` configuration (as opposed to `Debug` configuration). + - `-NoDocs`: Supresses writing the documentation markdown files as part of the cmdlet exporting process. + - `-Debugger`: Used when attaching the debugger in Visual Studio to the PowerShell session, and running the build process without recompiling the DLL. This suppresses running the script as an isolated process. +- `run-module.ps1` + - Creates an isolated PowerShell session and loads `Az.Commvault` into the session. + - Same as `-Run` in `build-module.ps1`. + - **Parameters**: [`Switch` parameters] + - `-Code`: Opens a VSCode window with the module's directory. + - Same as `-Code` in `build-module.ps1`. +- `generate-help.ps1` + - Generates the Markdown documents for the modules into the `docs` folder. + - Same as `-Docs` in `build-module.ps1`. +- `test-module.ps1` + - Runs the `Pester` tests defined in the `test` folder. + - Same as `-Test` in `build-module.ps1`. +- `pack-module.ps1` + - Packages the module into a `.nupkg` for distribution. + - Same as `-Pack` in `build-module.ps1`. +- `generate-help.ps1` + - Generates the Markdown documents for the modules into the `docs` folder. + - Same as `-Docs` in `build-module.ps1`. + - This process is now integrated into `build-module.ps1` automatically. To disable, use `-NoDocs` when running `build-module.ps1`. +- `export-surface.ps1` + - Generates Markdown documents for both the cmdlet surface and the model (class) surface of the module. + - These files are placed into the `resources` folder. + - Used for investigating the surface of your module. These are *not* documentation for distribution. +- `check-dependencies.ps1` + - Used in `run-module.ps1` and `test-module.ps1` to verify dependent modules are available to run those tasks. + - It will download local (within the module's directory structure) versions of those modules as needed. + - This script *does not* need to be ran by-hand. \ No newline at end of file diff --git a/src/Commvault/Commvault.Autorest/resources/README.md b/src/Commvault/Commvault.Autorest/resources/README.md new file mode 100644 index 000000000000..736492341e3d --- /dev/null +++ b/src/Commvault/Commvault.Autorest/resources/README.md @@ -0,0 +1,11 @@ +# Resources +This directory can contain any additional resources for module that are not required at runtime. This directory **does not** get packaged with the module. If you have assets for custom implementation, place them into the `../custom` folder. + +## Info +- Modifiable: yes +- Generated: no +- Committed: yes +- Packaged: no + +## Purpose +Use this folder to put anything you want to keep around as part of the repository for the module, but is not something that is required for the module. For example, development files, packaged builds, or additional information. This is only intended to be used in repositories where the module's output directory is cleaned, but tangential resources for the module want to remain intact. \ No newline at end of file diff --git a/src/Commvault/Commvault.Autorest/test/Backup-AzCommvaultProtectionGroup.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Backup-AzCommvaultProtectionGroup.Tests.ps1 new file mode 100644 index 000000000000..45ddcebebb73 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Backup-AzCommvaultProtectionGroup.Tests.ps1 @@ -0,0 +1,49 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Backup-AzCommvaultProtectionGroup')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Backup-AzCommvaultProtectionGroup.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Backup-AzCommvaultProtectionGroup' { + It 'BackupViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'BackupViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'BackupViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'BackupExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Backup' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'BackupViaIdentityCloudAccountExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'BackupViaIdentityCloudAccount' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'BackupViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Connect-AzCommvaultCloudAccountSaaS.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Connect-AzCommvaultCloudAccountSaaS.Tests.ps1 new file mode 100644 index 000000000000..ab7b4899ecb8 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Connect-AzCommvaultCloudAccountSaaS.Tests.ps1 @@ -0,0 +1,41 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Connect-AzCommvaultCloudAccountSaaS')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Connect-AzCommvaultCloudAccountSaaS.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Connect-AzCommvaultCloudAccountSaaS' { + It 'LinkExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'LinkViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'LinkViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Link' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'LinkViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'LinkViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Disable-AzCommvaultStorageComplianceLock.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Disable-AzCommvaultStorageComplianceLock.Tests.ps1 new file mode 100644 index 000000000000..0fd4ececf027 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Disable-AzCommvaultStorageComplianceLock.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Disable-AzCommvaultStorageComplianceLock')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Disable-AzCommvaultStorageComplianceLock.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Disable-AzCommvaultStorageComplianceLock' { + It 'Disable' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DisableViaIdentityCloudAccount' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DisableViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Enable-AzCommvaultStorageComplianceLock.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Enable-AzCommvaultStorageComplianceLock.Tests.ps1 new file mode 100644 index 000000000000..e15376e0d9a5 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Enable-AzCommvaultStorageComplianceLock.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Enable-AzCommvaultStorageComplianceLock')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Enable-AzCommvaultStorageComplianceLock.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Enable-AzCommvaultStorageComplianceLock' { + It 'Enable' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'EnableViaIdentityCloudAccount' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'EnableViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultCloudAccount.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultCloudAccount.Tests.ps1 new file mode 100644 index 000000000000..b5ad51074869 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultCloudAccount.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzCommvaultCloudAccount')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzCommvaultCloudAccount.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzCommvaultCloudAccount' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'List1' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultCloudAccountLatestLinkedSaaS.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultCloudAccountLatestLinkedSaaS.Tests.ps1 new file mode 100644 index 000000000000..b2b6e130e524 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultCloudAccountLatestLinkedSaaS.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzCommvaultCloudAccountLatestLinkedSaaS')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzCommvaultCloudAccountLatestLinkedSaaS.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzCommvaultCloudAccountLatestLinkedSaaS' { + It 'Latest' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'LatestViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultPlan.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultPlan.Tests.ps1 new file mode 100644 index 000000000000..2c0ce52123e5 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultPlan.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzCommvaultPlan')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzCommvaultPlan.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzCommvaultPlan' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityCloudAccount' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultProtectedItem.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultProtectedItem.Tests.ps1 new file mode 100644 index 000000000000..ad748aa536a4 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultProtectedItem.Tests.ps1 @@ -0,0 +1,37 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzCommvaultProtectedItem')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzCommvaultProtectedItem.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzCommvaultProtectedItem' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityProtectionGroup' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityCloudAccount' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultProtectedItemCount.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultProtectedItemCount.Tests.ps1 new file mode 100644 index 000000000000..cb06fbe90444 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultProtectedItemCount.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzCommvaultProtectedItemCount')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzCommvaultProtectedItemCount.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzCommvaultProtectedItemCount' { + It 'CountExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Count' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CountViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CountViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultProtectedItemRestorePoint.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultProtectedItemRestorePoint.Tests.ps1 new file mode 100644 index 000000000000..f5763553bdbb --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultProtectedItemRestorePoint.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzCommvaultProtectedItemRestorePoint')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzCommvaultProtectedItemRestorePoint.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzCommvaultProtectedItemRestorePoint' { + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityProtectionGroup' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityCloudAccount' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultProtectionGroup.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultProtectionGroup.Tests.ps1 new file mode 100644 index 000000000000..3d4e6ebe765a --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultProtectionGroup.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzCommvaultProtectionGroup')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzCommvaultProtectionGroup.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzCommvaultProtectionGroup' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityCloudAccount' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultRoleMapping.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultRoleMapping.Tests.ps1 new file mode 100644 index 000000000000..80e22dfe352b --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultRoleMapping.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzCommvaultRoleMapping')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzCommvaultRoleMapping.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzCommvaultRoleMapping' { + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultStorage.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultStorage.Tests.ps1 new file mode 100644 index 000000000000..18db7713e6fa --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultStorage.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzCommvaultStorage')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzCommvaultStorage.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzCommvaultStorage' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityCloudAccount' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Initialize-AzCommvaultSaaS.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Initialize-AzCommvaultSaaS.Tests.ps1 new file mode 100644 index 000000000000..830cb568b7c7 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Initialize-AzCommvaultSaaS.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Initialize-AzCommvaultSaaS')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Initialize-AzCommvaultSaaS.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Initialize-AzCommvaultSaaS' { + It 'ActivateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Activate' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'ActivateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'ActivateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/New-AzCommvaultCloudAccount.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/New-AzCommvaultCloudAccount.Tests.ps1 new file mode 100644 index 000000000000..0db95d99bf81 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/New-AzCommvaultCloudAccount.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'New-AzCommvaultCloudAccount')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'New-AzCommvaultCloudAccount.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'New-AzCommvaultCloudAccount' { + It 'CreateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/New-AzCommvaultPlan.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/New-AzCommvaultPlan.Tests.ps1 new file mode 100644 index 000000000000..e37c1eabe793 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/New-AzCommvaultPlan.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'New-AzCommvaultPlan')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'New-AzCommvaultPlan.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'New-AzCommvaultPlan' { + It 'CreateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaIdentityCloudAccountExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/New-AzCommvaultProtectionGroup.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/New-AzCommvaultProtectionGroup.Tests.ps1 new file mode 100644 index 000000000000..88894eef45f3 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/New-AzCommvaultProtectionGroup.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'New-AzCommvaultProtectionGroup')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'New-AzCommvaultProtectionGroup.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'New-AzCommvaultProtectionGroup' { + It 'CreateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaIdentityCloudAccountExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/New-AzCommvaultRoleMapping.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/New-AzCommvaultRoleMapping.Tests.ps1 new file mode 100644 index 000000000000..090f95c2637f --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/New-AzCommvaultRoleMapping.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'New-AzCommvaultRoleMapping')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'New-AzCommvaultRoleMapping.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'New-AzCommvaultRoleMapping' { + It 'CreateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/New-AzCommvaultStorage.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/New-AzCommvaultStorage.Tests.ps1 new file mode 100644 index 000000000000..bf478c805960 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/New-AzCommvaultStorage.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'New-AzCommvaultStorage')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'New-AzCommvaultStorage.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'New-AzCommvaultStorage' { + It 'CreateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaIdentityCloudAccountExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/README.md b/src/Commvault/Commvault.Autorest/test/README.md new file mode 100644 index 000000000000..1969200c6a09 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/README.md @@ -0,0 +1,17 @@ +# Test +This directory contains the [Pester](https://www.powershellgallery.com/packages/Pester) tests to run for the module. We use Pester as it is the unofficial standard for PowerShell unit testing. Test stubs for custom cmdlets (created in `../custom`) will be generated into this folder when `build-module.ps1` is ran. These test stubs will fail automatically, to indicate that tests should be written for custom cmdlets. + +## Info +- Modifiable: yes +- Generated: partial +- Committed: yes +- Packaged: no + +## Details +We allow three testing modes: *live*, *record*, and *playback*. These can be selected using the `-Live`, `-Record`, and `-Playback` switches respectively on the `test-module.ps1` script. This script will run through any `.Tests.ps1` scripts in the `test` folder. If you choose the *record* mode, it will create a `.Recording.json` file of the REST calls between the client and server. Then, when you choose *playback* mode, it will use the `.Recording.json` file to mock the communication between server and client. The *live* mode runs the same as the *record* mode; however, it doesn't create the `.Recording.json` file. + +## Purpose +Custom cmdlets generally encompass additional functionality not described in the REST specification, or combines functionality generated from the REST spec. To validate this functionality continues to operate as intended, creating tests that can be ran and re-ran against custom cmdlets is part of the framework. + +## Usage +To execute tests, run the `test-module.ps1`. To write tests, [this example](https://github.com/pester/Pester/blob/8b9cf4248315e44f1ac6673be149f7e0d7f10466/Examples/Planets/Get-Planet.Tests.ps1#L1) from the Pester repository is very useful for getting started. \ No newline at end of file diff --git a/src/Commvault/Commvault.Autorest/test/Remove-AzCommvaultCloudAccount.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Remove-AzCommvaultCloudAccount.Tests.ps1 new file mode 100644 index 000000000000..d42d0a356570 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Remove-AzCommvaultCloudAccount.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Remove-AzCommvaultCloudAccount')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Remove-AzCommvaultCloudAccount.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Remove-AzCommvaultCloudAccount' { + It 'Delete' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Remove-AzCommvaultPlan.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Remove-AzCommvaultPlan.Tests.ps1 new file mode 100644 index 000000000000..0b1253f2c9ac --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Remove-AzCommvaultPlan.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Remove-AzCommvaultPlan')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Remove-AzCommvaultPlan.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Remove-AzCommvaultPlan' { + It 'Delete' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentityCloudAccount' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Remove-AzCommvaultProtectionGroup.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Remove-AzCommvaultProtectionGroup.Tests.ps1 new file mode 100644 index 000000000000..6d9ff24c91fb --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Remove-AzCommvaultProtectionGroup.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Remove-AzCommvaultProtectionGroup')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Remove-AzCommvaultProtectionGroup.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Remove-AzCommvaultProtectionGroup' { + It 'Delete' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentityCloudAccount' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Remove-AzCommvaultRoleMapping.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Remove-AzCommvaultRoleMapping.Tests.ps1 new file mode 100644 index 000000000000..83df800667d6 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Remove-AzCommvaultRoleMapping.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Remove-AzCommvaultRoleMapping')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Remove-AzCommvaultRoleMapping.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Remove-AzCommvaultRoleMapping' { + It 'Delete' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Remove-AzCommvaultStorage.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Remove-AzCommvaultStorage.Tests.ps1 new file mode 100644 index 000000000000..66197379f451 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Remove-AzCommvaultStorage.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Remove-AzCommvaultStorage')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Remove-AzCommvaultStorage.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Remove-AzCommvaultStorage' { + It 'Delete' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentityCloudAccount' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Restore-AzCommvaultProtectedItem.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Restore-AzCommvaultProtectedItem.Tests.ps1 new file mode 100644 index 000000000000..237e260bef25 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Restore-AzCommvaultProtectedItem.Tests.ps1 @@ -0,0 +1,57 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Restore-AzCommvaultProtectedItem')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Restore-AzCommvaultProtectedItem.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Restore-AzCommvaultProtectedItem' { + It 'RestoreViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'RestoreViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'RestoreViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'RestoreExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Restore' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'RestoreViaIdentityProtectionGroupExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'RestoreViaIdentityProtectionGroup' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'RestoreViaIdentityCloudAccountExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'RestoreViaIdentityCloudAccount' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'RestoreViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Restore-AzCommvaultProtectionGroup.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Restore-AzCommvaultProtectionGroup.Tests.ps1 new file mode 100644 index 000000000000..bb01abf9d0e0 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Restore-AzCommvaultProtectionGroup.Tests.ps1 @@ -0,0 +1,49 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Restore-AzCommvaultProtectionGroup')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Restore-AzCommvaultProtectionGroup.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Restore-AzCommvaultProtectionGroup' { + It 'RestoreViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'RestoreViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'RestoreViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'RestoreExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Restore' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'RestoreViaIdentityCloudAccountExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'RestoreViaIdentityCloudAccount' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'RestoreViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Resume-AzCommvaultProtectionGroupBackup.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Resume-AzCommvaultProtectionGroupBackup.Tests.ps1 new file mode 100644 index 000000000000..ad5e4a481789 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Resume-AzCommvaultProtectionGroupBackup.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Resume-AzCommvaultProtectionGroupBackup')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Resume-AzCommvaultProtectionGroupBackup.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Resume-AzCommvaultProtectionGroupBackup' { + It 'Resume' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'ResumeViaIdentityCloudAccount' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'ResumeViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Stop-AzCommvaultProtectionGroupBackup.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Stop-AzCommvaultProtectionGroupBackup.Tests.ps1 new file mode 100644 index 000000000000..6eb3b5462229 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Stop-AzCommvaultProtectionGroupBackup.Tests.ps1 @@ -0,0 +1,49 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Stop-AzCommvaultProtectionGroupBackup')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Stop-AzCommvaultProtectionGroupBackup.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Stop-AzCommvaultProtectionGroupBackup' { + It 'StopExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'StopViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'StopViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Stop' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'StopViaIdentityCloudAccountExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'StopViaIdentityCloudAccount' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'StopViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'StopViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Sync-AzCommvaultStorage.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Sync-AzCommvaultStorage.Tests.ps1 new file mode 100644 index 000000000000..e63fe00dd6da --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Sync-AzCommvaultStorage.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Sync-AzCommvaultStorage')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Sync-AzCommvaultStorage.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Sync-AzCommvaultStorage' { + It 'Refresh' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'RefreshViaIdentityCloudAccount' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'RefreshViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Update-AzCommvaultCloudAccount.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Update-AzCommvaultCloudAccount.Tests.ps1 new file mode 100644 index 000000000000..495259523744 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Update-AzCommvaultCloudAccount.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Update-AzCommvaultCloudAccount')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Update-AzCommvaultCloudAccount.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Update-AzCommvaultCloudAccount' { + It 'UpdateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Update-AzCommvaultPlan.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Update-AzCommvaultPlan.Tests.ps1 new file mode 100644 index 000000000000..fc3aed971ed8 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Update-AzCommvaultPlan.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Update-AzCommvaultPlan')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Update-AzCommvaultPlan.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Update-AzCommvaultPlan' { + It 'UpdateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityCloudAccountExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Update-AzCommvaultProtectionGroup.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Update-AzCommvaultProtectionGroup.Tests.ps1 new file mode 100644 index 000000000000..f552ff5f715a --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Update-AzCommvaultProtectionGroup.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Update-AzCommvaultProtectionGroup')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Update-AzCommvaultProtectionGroup.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Update-AzCommvaultProtectionGroup' { + It 'UpdateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityCloudAccountExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Update-AzCommvaultRoleMapping.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Update-AzCommvaultRoleMapping.Tests.ps1 new file mode 100644 index 000000000000..0f9e53bafa2b --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Update-AzCommvaultRoleMapping.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Update-AzCommvaultRoleMapping')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Update-AzCommvaultRoleMapping.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Update-AzCommvaultRoleMapping' { + It 'UpdateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/Update-AzCommvaultStorage.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Update-AzCommvaultStorage.Tests.ps1 new file mode 100644 index 000000000000..a2a259536986 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/Update-AzCommvaultStorage.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Update-AzCommvaultStorage')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Update-AzCommvaultStorage.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Update-AzCommvaultStorage' { + It 'UpdateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityCloudAccountExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Commvault/Commvault.Autorest/test/loadEnv.ps1 b/src/Commvault/Commvault.Autorest/test/loadEnv.ps1 new file mode 100644 index 000000000000..6a7c385c6b7d --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/loadEnv.ps1 @@ -0,0 +1,29 @@ +# ---------------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# http://www.apache.org/licenses/LICENSE-2.0 +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code +# is regenerated. +# ---------------------------------------------------------------------------------- +$envFile = 'env.json' +if ($TestMode -eq 'live') { + $envFile = 'localEnv.json' +} + +if (Test-Path -Path (Join-Path $PSScriptRoot $envFile)) { + $envFilePath = Join-Path $PSScriptRoot $envFile +} else { + $envFilePath = Join-Path $PSScriptRoot '..\$envFile' +} +$env = @{} +if (Test-Path -Path $envFilePath) { + $env = Get-Content (Join-Path $PSScriptRoot $envFile) | ConvertFrom-Json + $PSDefaultParameterValues=@{"*:Tenant"=$env.Tenant} +} \ No newline at end of file diff --git a/src/Commvault/Commvault.Autorest/test/utils.ps1 b/src/Commvault/Commvault.Autorest/test/utils.ps1 new file mode 100644 index 000000000000..f8497fbd7da0 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/test/utils.ps1 @@ -0,0 +1,56 @@ +function RandomString([bool]$allChars, [int32]$len) { + if ($allChars) { + return -join ((33..126) | Get-Random -Count $len | % {[char]$_}) + } else { + return -join ((48..57) + (97..122) | Get-Random -Count $len | % {[char]$_}) + } +} +function Start-TestSleep { + [CmdletBinding(DefaultParameterSetName = 'SleepBySeconds')] + param( + [parameter(Mandatory = $true, Position = 0, ParameterSetName = 'SleepBySeconds')] + [ValidateRange(0.0, 2147483.0)] + [double] $Seconds, + + [parameter(Mandatory = $true, ParameterSetName = 'SleepByMilliseconds')] + [ValidateRange('NonNegative')] + [Alias('ms')] + [int] $Milliseconds + ) + + if ($TestMode -ne 'playback') { + switch ($PSCmdlet.ParameterSetName) { + 'SleepBySeconds' { + Start-Sleep -Seconds $Seconds + } + 'SleepByMilliseconds' { + Start-Sleep -Milliseconds $Milliseconds + } + } + } +} + +$env = @{} +if ($UsePreviousConfigForRecord) { + $previousEnv = Get-Content (Join-Path $PSScriptRoot 'env.json') | ConvertFrom-Json + $previousEnv.psobject.properties | Foreach-Object { $env[$_.Name] = $_.Value } +} +# Add script method called AddWithCache to $env, when useCache is set true, it will try to get the value from the $env first. +# example: $val = $env.AddWithCache('key', $val, $true) +$env | Add-Member -Type ScriptMethod -Value { param( [string]$key, [object]$val, [bool]$useCache) if ($this.Contains($key) -and $useCache) { return $this[$key] } else { $this[$key] = $val; return $val } } -Name 'AddWithCache' +function setupEnv() { + # Preload subscriptionId and tenant from context, which will be used in test + # as default. You could change them if needed. + $env.SubscriptionId = (Get-AzContext).Subscription.Id + $env.Tenant = (Get-AzContext).Tenant.Id + # For any resources you created for test, you should add it to $env here. + $envFile = 'env.json' + if ($TestMode -eq 'live') { + $envFile = 'localEnv.json' + } + set-content -Path (Join-Path $PSScriptRoot $envFile) -Value (ConvertTo-Json $env) +} +function cleanupEnv() { + # Clean resources you create for testing +} + diff --git a/src/Commvault/Commvault.Autorest/utils/Get-SubscriptionIdTestSafe.ps1 b/src/Commvault/Commvault.Autorest/utils/Get-SubscriptionIdTestSafe.ps1 new file mode 100644 index 000000000000..5319862d3372 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/utils/Get-SubscriptionIdTestSafe.ps1 @@ -0,0 +1,7 @@ +param() +if ($env:AzPSAutorestTestPlaybackMode) { + $loadEnvPath = Join-Path $PSScriptRoot '..' 'test' 'loadEnv.ps1' + . ($loadEnvPath) + return $env.SubscriptionId +} +return (Get-AzContext).Subscription.Id \ No newline at end of file diff --git a/src/Commvault/Commvault.Autorest/utils/Unprotect-SecureString.ps1 b/src/Commvault/Commvault.Autorest/utils/Unprotect-SecureString.ps1 new file mode 100644 index 000000000000..cb05b51a6220 --- /dev/null +++ b/src/Commvault/Commvault.Autorest/utils/Unprotect-SecureString.ps1 @@ -0,0 +1,16 @@ +#This script converts securestring to plaintext + +param( + [Parameter(Mandatory, ValueFromPipeline)] + [System.Security.SecureString] + ${SecureString} +) + +$ssPtr = [System.Runtime.InteropServices.Marshal]::SecureStringToBSTR($SecureString) +try { + $plaintext = [System.Runtime.InteropServices.Marshal]::PtrToStringBSTR($ssPtr) +} finally { + [System.Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ssPtr) +} + +return $plaintext \ No newline at end of file diff --git a/src/Commvault/Commvault.sln b/src/Commvault/Commvault.sln new file mode 100644 index 000000000000..d024679ed123 --- /dev/null +++ b/src/Commvault/Commvault.sln @@ -0,0 +1,74 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.0.31903.59 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Accounts", "Accounts", "{9371A383-DC64-4F17-9D08-E50EFD5C7093}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Accounts", "..\Accounts\Accounts\Accounts.csproj", "{8FB61EF4-1304-47F6-9539-721A82C0629A}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AssemblyLoading", "..\Accounts\AssemblyLoading\AssemblyLoading.csproj", "{EC1EEB1C-71D5-4F9E-B849-17B01EBBAD22}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authentication", "..\Accounts\Authentication\Authentication.csproj", "{6EF06E91-A3D0-43B5-B6BE-D2E40A43522C}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authentication.ResourceManager", "..\Accounts\Authentication.ResourceManager\Authentication.ResourceManager.csproj", "{2356D3D5-BB89-4736-9E40-F5D355DA91F7}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AuthenticationAssemblyLoadContext", "..\Accounts\AuthenticationAssemblyLoadContext\AuthenticationAssemblyLoadContext.csproj", "{4F1A4165-9D88-4785-9E41-A7A05E0D49BA}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authenticators", "..\Accounts\Authenticators\Authenticators.csproj", "{E44DD7D5-AE7B-418A-AD3E-CB82C1126E62}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Commvault", "Commvault\Commvault.csproj", "{20B0AEC1-6E6E-416A-B776-07AEFB1648DF}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.Commvault", "..\..\generated\Commvault\Commvault.Autorest\Az.Commvault.csproj", "{7904EA98-5880-4BFB-A295-AA515AE16DF8}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {8FB61EF4-1304-47F6-9539-721A82C0629A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {8FB61EF4-1304-47F6-9539-721A82C0629A}.Debug|Any CPU.Build.0 = Debug|Any CPU + {8FB61EF4-1304-47F6-9539-721A82C0629A}.Release|Any CPU.ActiveCfg = Release|Any CPU + {8FB61EF4-1304-47F6-9539-721A82C0629A}.Release|Any CPU.Build.0 = Release|Any CPU + {EC1EEB1C-71D5-4F9E-B849-17B01EBBAD22}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {EC1EEB1C-71D5-4F9E-B849-17B01EBBAD22}.Debug|Any CPU.Build.0 = Debug|Any CPU + {EC1EEB1C-71D5-4F9E-B849-17B01EBBAD22}.Release|Any CPU.ActiveCfg = Release|Any CPU + {EC1EEB1C-71D5-4F9E-B849-17B01EBBAD22}.Release|Any CPU.Build.0 = Release|Any CPU + {6EF06E91-A3D0-43B5-B6BE-D2E40A43522C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {6EF06E91-A3D0-43B5-B6BE-D2E40A43522C}.Debug|Any CPU.Build.0 = Debug|Any CPU + {6EF06E91-A3D0-43B5-B6BE-D2E40A43522C}.Release|Any CPU.ActiveCfg = Release|Any CPU + {6EF06E91-A3D0-43B5-B6BE-D2E40A43522C}.Release|Any CPU.Build.0 = Release|Any CPU + {2356D3D5-BB89-4736-9E40-F5D355DA91F7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {2356D3D5-BB89-4736-9E40-F5D355DA91F7}.Debug|Any CPU.Build.0 = Debug|Any CPU + {2356D3D5-BB89-4736-9E40-F5D355DA91F7}.Release|Any CPU.ActiveCfg = Release|Any CPU + {2356D3D5-BB89-4736-9E40-F5D355DA91F7}.Release|Any CPU.Build.0 = Release|Any CPU + {4F1A4165-9D88-4785-9E41-A7A05E0D49BA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {4F1A4165-9D88-4785-9E41-A7A05E0D49BA}.Debug|Any CPU.Build.0 = Debug|Any CPU + {4F1A4165-9D88-4785-9E41-A7A05E0D49BA}.Release|Any CPU.ActiveCfg = Release|Any CPU + {4F1A4165-9D88-4785-9E41-A7A05E0D49BA}.Release|Any CPU.Build.0 = Release|Any CPU + {E44DD7D5-AE7B-418A-AD3E-CB82C1126E62}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {E44DD7D5-AE7B-418A-AD3E-CB82C1126E62}.Debug|Any CPU.Build.0 = Debug|Any CPU + {E44DD7D5-AE7B-418A-AD3E-CB82C1126E62}.Release|Any CPU.ActiveCfg = Release|Any CPU + {E44DD7D5-AE7B-418A-AD3E-CB82C1126E62}.Release|Any CPU.Build.0 = Release|Any CPU + {20B0AEC1-6E6E-416A-B776-07AEFB1648DF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {20B0AEC1-6E6E-416A-B776-07AEFB1648DF}.Debug|Any CPU.Build.0 = Debug|Any CPU + {20B0AEC1-6E6E-416A-B776-07AEFB1648DF}.Release|Any CPU.ActiveCfg = Release|Any CPU + {20B0AEC1-6E6E-416A-B776-07AEFB1648DF}.Release|Any CPU.Build.0 = Release|Any CPU + {7904EA98-5880-4BFB-A295-AA515AE16DF8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {7904EA98-5880-4BFB-A295-AA515AE16DF8}.Debug|Any CPU.Build.0 = Debug|Any CPU + {7904EA98-5880-4BFB-A295-AA515AE16DF8}.Release|Any CPU.ActiveCfg = Release|Any CPU + {7904EA98-5880-4BFB-A295-AA515AE16DF8}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(NestedProjects) = preSolution + {8FB61EF4-1304-47F6-9539-721A82C0629A} = {9371A383-DC64-4F17-9D08-E50EFD5C7093} + {EC1EEB1C-71D5-4F9E-B849-17B01EBBAD22} = {9371A383-DC64-4F17-9D08-E50EFD5C7093} + {6EF06E91-A3D0-43B5-B6BE-D2E40A43522C} = {9371A383-DC64-4F17-9D08-E50EFD5C7093} + {2356D3D5-BB89-4736-9E40-F5D355DA91F7} = {9371A383-DC64-4F17-9D08-E50EFD5C7093} + {4F1A4165-9D88-4785-9E41-A7A05E0D49BA} = {9371A383-DC64-4F17-9D08-E50EFD5C7093} + {E44DD7D5-AE7B-418A-AD3E-CB82C1126E62} = {9371A383-DC64-4F17-9D08-E50EFD5C7093} + EndGlobalSection +EndGlobal diff --git a/src/Commvault/Commvault/Az.Commvault.psd1 b/src/Commvault/Commvault/Az.Commvault.psd1 new file mode 100644 index 000000000000..8f3da774eefd --- /dev/null +++ b/src/Commvault/Commvault/Az.Commvault.psd1 @@ -0,0 +1,154 @@ +# +# Module manifest for module 'Az.Commvault' +# +# Generated by: Microsoft Corporation +# +# Generated on: 10/26/2026 +# + +@{ + +# Script module or binary module file associated with this manifest. +# RootModule = '' + +# Version number of this module. +ModuleVersion = '0.1.0' + +# Supported PSEditions +CompatiblePSEditions = 'Core', 'Desktop' + +# ID used to uniquely identify this module +GUID = 'accceef6-8113-453a-a31c-4f2ce57893d6' + +# Author of this module +Author = 'Microsoft Corporation' + +# Company or vendor of this module +CompanyName = 'Microsoft Corporation' + +# Copyright statement for this module +Copyright = 'Microsoft Corporation. All rights reserved.' + +# Description of the functionality provided by this module +Description = 'Microsoft Azure PowerShell: Commvault cmdlets' + +# Minimum version of the PowerShell engine required by this module +PowerShellVersion = '5.1' + +# Name of the PowerShell host required by this module +# PowerShellHostName = '' + +# Minimum version of the PowerShell host required by this module +# PowerShellHostVersion = '' + +# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only. +DotNetFrameworkVersion = '4.7.2' + +# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only. +# ClrVersion = '' + +# Processor architecture (None, X86, Amd64) required by this module +# ProcessorArchitecture = '' + +# Modules that must be imported into the global environment prior to importing this module +RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '5.5.3'; }) + +# Assemblies that must be loaded prior to importing this module +RequiredAssemblies = 'Commvault.Autorest/bin/Az.Commvault.private.dll' + +# Script files (.ps1) that are run in the caller's environment prior to importing this module. +ScriptsToProcess = @() + +# Type files (.ps1xml) to be loaded when importing this module +TypesToProcess = @() + +# Format files (.ps1xml) to be loaded when importing this module +FormatsToProcess = 'Commvault.Autorest/Az.Commvault.format.ps1xml' + +# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess +NestedModules = @('Commvault.Autorest/Az.Commvault.psm1') + +# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. +FunctionsToExport = 'Backup-AzCommvaultProtectionGroup', + 'Connect-AzCommvaultCloudAccountSaaS', + 'Disable-AzCommvaultStorageComplianceLock', + 'Enable-AzCommvaultStorageComplianceLock', + 'Get-AzCommvaultCloudAccount', + 'Get-AzCommvaultCloudAccountLatestLinkedSaaS', + 'Get-AzCommvaultPlan', 'Get-AzCommvaultProtectedItem', + 'Get-AzCommvaultProtectedItemCount', + 'Get-AzCommvaultProtectedItemRestorePoint', + 'Get-AzCommvaultProtectionGroup', 'Get-AzCommvaultRoleMapping', + 'Get-AzCommvaultStorage', 'Initialize-AzCommvaultSaaS', + 'New-AzCommvaultCloudAccount', 'New-AzCommvaultPlan', + 'New-AzCommvaultProtectionGroup', 'New-AzCommvaultRoleMapping', + 'New-AzCommvaultStorage', 'Remove-AzCommvaultCloudAccount', + 'Remove-AzCommvaultPlan', 'Remove-AzCommvaultProtectionGroup', + 'Remove-AzCommvaultRoleMapping', 'Remove-AzCommvaultStorage', + 'Restore-AzCommvaultProtectedItem', + 'Restore-AzCommvaultProtectionGroup', + 'Resume-AzCommvaultProtectionGroupBackup', + 'Stop-AzCommvaultProtectionGroupBackup', 'Sync-AzCommvaultStorage', + 'Update-AzCommvaultCloudAccount', 'Update-AzCommvaultPlan', + 'Update-AzCommvaultProtectionGroup', + 'Update-AzCommvaultRoleMapping', 'Update-AzCommvaultStorage' + +# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. +CmdletsToExport = @() + +# Variables to export from this module +# VariablesToExport = @() + +# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export. +AliasesToExport = @() + +# DSC resources to export from this module +# DscResourcesToExport = @() + +# List of all modules packaged with this module +# ModuleList = @() + +# List of all files packaged with this module +# FileList = @() + +# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. +PrivateData = @{ + + PSData = @{ + + # Tags applied to this module. These help with module discovery in online galleries. + Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'Commvault' + + # A URL to the license for this module. + LicenseUri = 'https://aka.ms/azps-license' + + # A URL to the main website for this project. + ProjectUri = 'https://github.com/Azure/azure-powershell' + + # A URL to an icon representing this module. + # IconUri = '' + + # ReleaseNotes of this module + # ReleaseNotes = '' + + # Prerelease string of this module + # Prerelease = '' + + # Flag to indicate whether the module requires explicit user acceptance for install/update/save + # RequireLicenseAcceptance = $false + + # External dependent modules of this module + # ExternalModuleDependencies = @() + + } # End of PSData hashtable + +} # End of PrivateData hashtable + +# HelpInfo URI of this module +# HelpInfoURI = '' + +# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. +# DefaultCommandPrefix = '' + +} + diff --git a/src/Commvault/Commvault/ChangeLog.md b/src/Commvault/Commvault/ChangeLog.md new file mode 100644 index 000000000000..d7fb5cc9dc72 --- /dev/null +++ b/src/Commvault/Commvault/ChangeLog.md @@ -0,0 +1,30 @@ + +## Upcoming Release + +## Version 0.1.0 +* First preview release for module Az.Commvault + - Added cmdlets to manage Commvault cloud accounts: `New-AzCommvaultCloudAccount`, `Get-AzCommvaultCloudAccount`, `Update-AzCommvaultCloudAccount` and `Remove-AzCommvaultCloudAccount` + - Added `Initialize-AzCommvaultSaaS`, `Connect-AzCommvaultCloudAccountSaaS` and `Get-AzCommvaultCloudAccountLatestLinkedSaaS` cmdlets to activate and link the Commvault SaaS + - Added cmdlets to manage backup plans (`*-AzCommvaultPlan`), storages (`*-AzCommvaultStorage`) and the role mapping (`*-AzCommvaultRoleMapping`) of a cloud account + - Added `Enable-AzCommvaultStorageComplianceLock`, `Disable-AzCommvaultStorageComplianceLock` and `Sync-AzCommvaultStorage` cmdlets to manage the compliance lock and refresh a storage + - Added cmdlets to manage protection groups (`*-AzCommvaultProtectionGroup`) and to run, stop and resume backups and restores: `Backup-AzCommvaultProtectionGroup`, `Stop-AzCommvaultProtectionGroupBackup`, `Resume-AzCommvaultProtectionGroupBackup`, `Restore-AzCommvaultProtectionGroup` and `Restore-AzCommvaultProtectedItem` + - Added `Get-AzCommvaultProtectedItem`, `Get-AzCommvaultProtectedItemCount` and `Get-AzCommvaultProtectedItemRestorePoint` cmdlets to inspect protected items and restore points + diff --git a/src/Commvault/Commvault/Commvault.csproj b/src/Commvault/Commvault/Commvault.csproj new file mode 100644 index 000000000000..33eadeb9dfc9 --- /dev/null +++ b/src/Commvault/Commvault/Commvault.csproj @@ -0,0 +1,28 @@ + + + + + + + Commvault + + + + netstandard2.0 + $(AzAssemblyPrefix)$(PsModuleName) + $(AzAssemblyPrefix)$(PsModuleName) + true + false + $(RepoArtifacts)$(Configuration)\Az.$(PsModuleName)\ + $(OutputPath) + + + + + + + + + + + diff --git a/src/Commvault/Commvault/Properties/AssemblyInfo.cs b/src/Commvault/Commvault/Properties/AssemblyInfo.cs new file mode 100644 index 000000000000..b62bb74f3f89 --- /dev/null +++ b/src/Commvault/Commvault/Properties/AssemblyInfo.cs @@ -0,0 +1,28 @@ +// ---------------------------------------------------------------------------------- +// +// Copyright Microsoft Corporation +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// ---------------------------------------------------------------------------------- + +using System; +using System.Reflection; +using System.Runtime.InteropServices; + +[assembly: AssemblyTitle("Microsoft Azure PowerShell - Commvault")] +[assembly: AssemblyCompany(Microsoft.WindowsAzure.Commands.Common.AzurePowerShell.AssemblyCompany)] +[assembly: AssemblyProduct(Microsoft.WindowsAzure.Commands.Common.AzurePowerShell.AssemblyProduct)] +[assembly: AssemblyCopyright(Microsoft.WindowsAzure.Commands.Common.AzurePowerShell.AssemblyCopyright)] + +[assembly: ComVisible(false)] +[assembly: CLSCompliant(false)] +[assembly: Guid("c1e854a3-a057-41f2-b78b-15e48a9ac9b0")] +[assembly: AssemblyVersion("0.1.0")] +[assembly: AssemblyFileVersion("0.1.0")] diff --git a/src/Commvault/Commvault/help/Az.Commvault.md b/src/Commvault/Commvault/help/Az.Commvault.md new file mode 100644 index 000000000000..88634dce62a4 --- /dev/null +++ b/src/Commvault/Commvault/help/Az.Commvault.md @@ -0,0 +1,119 @@ +--- +Module Name: Az.Commvault +Module Guid: accceef6-8113-453a-a31c-4f2ce57893d6 +Download Help Link: https://learn.microsoft.com/powershell/module/az.commvault +Help Version: 1.0.0.0 +Locale: en-US +--- + +# Az.Commvault Module +## Description +Microsoft Azure PowerShell: Commvault cmdlets + +## Az.Commvault Cmdlets +### [Backup-AzCommvaultProtectionGroup](Backup-AzCommvaultProtectionGroup.md) +Ad-hoc backup of protected items resource in given protection group. + +### [Connect-AzCommvaultCloudAccountSaaS](Connect-AzCommvaultCloudAccountSaaS.md) +Links a new SaaS to the cloud account. + +### [Disable-AzCommvaultStorageComplianceLock](Disable-AzCommvaultStorageComplianceLock.md) +Disable compliance lock on the storage. +Initiates an out-of-band multi-person authorization (MPA) email approval workflow on the partner side. +The storage compliance lock status transitions to 'DisablementPending' immediately; once the MPA approval completes, the status becomes 'Disabled' (observable via the refresh action). + +### [Enable-AzCommvaultStorageComplianceLock](Enable-AzCommvaultStorageComplianceLock.md) +Enable compliance lock on the storage. +Synchronous operation. + +### [Get-AzCommvaultCloudAccount](Get-AzCommvaultCloudAccount.md) +Get a CloudAccount + +### [Get-AzCommvaultCloudAccountLatestLinkedSaaS](Get-AzCommvaultCloudAccountLatestLinkedSaaS.md) +Returns the latest SaaS linked to the cloud account. + +### [Get-AzCommvaultPlan](Get-AzCommvaultPlan.md) +Get a CommvaultPlan + +### [Get-AzCommvaultProtectedItem](Get-AzCommvaultProtectedItem.md) +Get a ProtectedItem + +### [Get-AzCommvaultProtectedItemCount](Get-AzCommvaultProtectedItemCount.md) +Gets the count of protected items for provided CCA resource IDs across subscriptions. + +### [Get-AzCommvaultProtectedItemRestorePoint](Get-AzCommvaultProtectedItemRestorePoint.md) +Gets the restore points that are available for a protected item. + +### [Get-AzCommvaultProtectionGroup](Get-AzCommvaultProtectionGroup.md) +Get a ProtectionGroup + +### [Get-AzCommvaultRoleMapping](Get-AzCommvaultRoleMapping.md) +Get a RoleMapping + +### [Get-AzCommvaultStorage](Get-AzCommvaultStorage.md) +Get a Storage + +### [Initialize-AzCommvaultSaaS](Initialize-AzCommvaultSaaS.md) +Resolve the token to get the SaaS resource ID and activate the SaaS resource + +### [New-AzCommvaultCloudAccount](New-AzCommvaultCloudAccount.md) +Create a CloudAccount + +### [New-AzCommvaultPlan](New-AzCommvaultPlan.md) +Create a CommvaultPlan + +### [New-AzCommvaultProtectionGroup](New-AzCommvaultProtectionGroup.md) +Create a ProtectionGroup + +### [New-AzCommvaultRoleMapping](New-AzCommvaultRoleMapping.md) +Create a RoleMapping + +### [New-AzCommvaultStorage](New-AzCommvaultStorage.md) +Create a Storage + +### [Remove-AzCommvaultCloudAccount](Remove-AzCommvaultCloudAccount.md) +Delete a CloudAccount + +### [Remove-AzCommvaultPlan](Remove-AzCommvaultPlan.md) +Delete a CommvaultPlan + +### [Remove-AzCommvaultProtectionGroup](Remove-AzCommvaultProtectionGroup.md) +Delete a ProtectionGroup + +### [Remove-AzCommvaultRoleMapping](Remove-AzCommvaultRoleMapping.md) +Delete a RoleMapping + +### [Remove-AzCommvaultStorage](Remove-AzCommvaultStorage.md) +Delete a Storage + +### [Restore-AzCommvaultProtectedItem](Restore-AzCommvaultProtectedItem.md) +Restore resource for a protected item. + +### [Restore-AzCommvaultProtectionGroup](Restore-AzCommvaultProtectionGroup.md) +Restore resource for a protected items in given protection group. + +### [Resume-AzCommvaultProtectionGroupBackup](Resume-AzCommvaultProtectionGroupBackup.md) +Resume Backup for a Protection Group. + +### [Stop-AzCommvaultProtectionGroupBackup](Stop-AzCommvaultProtectionGroupBackup.md) +Stop Backup for a Protection Group + +### [Sync-AzCommvaultStorage](Sync-AzCommvaultStorage.md) +Refresh storage state from partner. +Fetches latest compliance lock status from Commvault and refresh the ARM resource. + +### [Update-AzCommvaultCloudAccount](Update-AzCommvaultCloudAccount.md) +Update a CloudAccount + +### [Update-AzCommvaultPlan](Update-AzCommvaultPlan.md) +Update a CommvaultPlan + +### [Update-AzCommvaultProtectionGroup](Update-AzCommvaultProtectionGroup.md) +Update a ProtectionGroup + +### [Update-AzCommvaultRoleMapping](Update-AzCommvaultRoleMapping.md) +Update a RoleMapping + +### [Update-AzCommvaultStorage](Update-AzCommvaultStorage.md) +Update a Storage + diff --git a/src/Commvault/Commvault/help/Backup-AzCommvaultProtectionGroup.md b/src/Commvault/Commvault/help/Backup-AzCommvaultProtectionGroup.md new file mode 100644 index 000000000000..279aed8abaf1 --- /dev/null +++ b/src/Commvault/Commvault/help/Backup-AzCommvaultProtectionGroup.md @@ -0,0 +1,385 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/backup-azcommvaultprotectiongroup +schema: 2.0.0 +--- + +# Backup-AzCommvaultProtectionGroup + +## SYNOPSIS +Ad-hoc backup of protected items resource in given protection group. + +## SYNTAX + +### BackupViaIdentity (Default) +``` +Backup-AzCommvaultProtectionGroup -InputObject -Request + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### BackupViaJsonString +``` +Backup-AzCommvaultProtectionGroup -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### BackupViaJsonFilePath +``` +Backup-AzCommvaultProtectionGroup -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### BackupExpanded +``` +Backup-AzCommvaultProtectionGroup -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-BackupOptionBackupCopyImmediately] -BackupOptionJobDescription + [-BackupOptionNotifyUserOnJobCompletion] [-BackupOptionRunSnapShotBackup] -VMList + [-BackupOptionBackupLevel ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### Backup +``` +Backup-AzCommvaultProtectionGroup -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] -Request [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### BackupViaIdentityCloudAccountExpanded +``` +Backup-AzCommvaultProtectionGroup -Name -CloudAccountInputObject + [-BackupOptionBackupCopyImmediately] -BackupOptionJobDescription + [-BackupOptionNotifyUserOnJobCompletion] [-BackupOptionRunSnapShotBackup] -VMList + [-BackupOptionBackupLevel ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### BackupViaIdentityCloudAccount +``` +Backup-AzCommvaultProtectionGroup -Name -CloudAccountInputObject + -Request [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### BackupViaIdentityExpanded +``` +Backup-AzCommvaultProtectionGroup -InputObject [-BackupOptionBackupCopyImmediately] + -BackupOptionJobDescription [-BackupOptionNotifyUserOnJobCompletion] [-BackupOptionRunSnapShotBackup] + -VMList [-BackupOptionBackupLevel ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Ad-hoc backup of protected items resource in given protection group. + +## EXAMPLES + +### Example 1: Run an ad-hoc backup of a virtual machine +```powershell +Backup-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms -BackupOptionBackupCopyImmediately -BackupOptionJobDescription 'Ad-hoc backup job' -BackupOptionNotifyUserOnJobCompletion -BackupOptionRunSnapShotBackup -VMList @{ VMGuid = '40000000-aaaa-4bbb-8ccc-000000000000' } +``` + +Starts an ad-hoc backup job for the specified virtual machine in the protection group. + +### Example 2: Run an ad-hoc backup by using a JSON request +```powershell +Backup-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms -JsonString '{"vmList":[{"vmGuid":"40000000-aaaa-4bbb-8ccc-000000000000"}],"backupOptions":{"backupLevel":"FULL","jobDescription":"Ad-hoc backup job","backupCopyImmediately":true,"runSnapShotBackup":true,"notifyUserOnJobCompletion":true}}' +``` + +Starts a full ad-hoc backup job by passing the request body as a JSON string. + +## PARAMETERS + +### -BackupOptionBackupCopyImmediately +Indicates whether to run backup immediately or not for the VM + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: BackupExpanded, BackupViaIdentityCloudAccountExpanded, BackupViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupOptionBackupLevel +Indicates whether to stop backup or not for the VM + +```yaml +Type: System.String +Parameter Sets: BackupExpanded, BackupViaIdentityCloudAccountExpanded, BackupViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupOptionJobDescription +The name of the backup job to be shown in Commvault + +```yaml +Type: System.String +Parameter Sets: BackupExpanded, BackupViaIdentityCloudAccountExpanded, BackupViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupOptionNotifyUserOnJobCompletion +Indicates whether to notify the user on job completion + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: BackupExpanded, BackupViaIdentityCloudAccountExpanded, BackupViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupOptionRunSnapShotBackup +Indicates whether to run snapshot backup or not for the VM, if false, it will run regular backup + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: BackupExpanded, BackupViaIdentityCloudAccountExpanded, BackupViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: BackupViaIdentityCloudAccountExpanded, BackupViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: BackupViaJsonString, BackupViaJsonFilePath, BackupExpanded, Backup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: BackupViaIdentity, BackupViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Backup operation + +```yaml +Type: System.String +Parameter Sets: BackupViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Backup operation + +```yaml +Type: System.String +Parameter Sets: BackupViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the ProtectionGroup resource + +```yaml +Type: System.String +Parameter Sets: BackupViaJsonString, BackupViaJsonFilePath, BackupExpanded, Backup, BackupViaIdentityCloudAccountExpanded, BackupViaIdentityCloudAccount +Aliases: ProtectionGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Request +The properties of BackupProtectionGroupRequest + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IBackupProtectionGroupRequest +Parameter Sets: BackupViaIdentity, Backup, BackupViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: BackupViaJsonString, BackupViaJsonFilePath, BackupExpanded, Backup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: BackupViaJsonString, BackupViaJsonFilePath, BackupExpanded, Backup +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMList +The vm list details. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IVMListItem[] +Parameter Sets: BackupExpanded, BackupViaIdentityCloudAccountExpanded, BackupViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IBackupProtectionGroupRequest + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IBackupProtectionGroupResponse + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Connect-AzCommvaultCloudAccountSaaS.md b/src/Commvault/Commvault/help/Connect-AzCommvaultCloudAccountSaaS.md new file mode 100644 index 000000000000..1ff63323031d --- /dev/null +++ b/src/Commvault/Commvault/help/Connect-AzCommvaultCloudAccountSaaS.md @@ -0,0 +1,292 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/connect-azcommvaultcloudaccountsaas +schema: 2.0.0 +--- + +# Connect-AzCommvaultCloudAccountSaaS + +## SYNOPSIS +Links a new SaaS to the cloud account. + +## SYNTAX + +### LinkExpanded (Default) +``` +Connect-AzCommvaultCloudAccountSaaS -CloudAccountName -ResourceGroupName + [-SubscriptionId ] [-SaaSResourceId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### LinkViaJsonString +``` +Connect-AzCommvaultCloudAccountSaaS -CloudAccountName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### LinkViaJsonFilePath +``` +Connect-AzCommvaultCloudAccountSaaS -CloudAccountName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### Link +``` +Connect-AzCommvaultCloudAccountSaaS -CloudAccountName -ResourceGroupName + [-SubscriptionId ] -Body [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### LinkViaIdentityExpanded +``` +Connect-AzCommvaultCloudAccountSaaS -InputObject [-SaaSResourceId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### LinkViaIdentity +``` +Connect-AzCommvaultCloudAccountSaaS -InputObject -Body + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Links a new SaaS to the cloud account. + +## EXAMPLES + +### Example 1: Link a SaaS resource to a cloud account +```powershell +Connect-AzCommvaultCloudAccountSaaS -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -SaaSResourceId '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Microsoft.SaaS/resources/commvault-saas' +``` + +Links the SaaS resource to the cloud account. + +### Example 2: Link a SaaS resource to a cloud account by using a JSON request +```powershell +Connect-AzCommvaultCloudAccountSaaS -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -JsonString '{"saaSResourceId":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Microsoft.SaaS/resources/commvault-saas"}' +``` + +Links the SaaS resource to the cloud account by passing the request body as a JSON string. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +SaaS-related data properties + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ISaaSData +Parameter Sets: Link, LinkViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: LinkExpanded, LinkViaJsonString, LinkViaJsonFilePath, Link +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: LinkViaIdentityExpanded, LinkViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Link operation + +```yaml +Type: System.String +Parameter Sets: LinkViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Link operation + +```yaml +Type: System.String +Parameter Sets: LinkViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: LinkExpanded, LinkViaJsonString, LinkViaJsonFilePath, Link +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SaaSResourceId +SaaS resource id + +```yaml +Type: System.String +Parameter Sets: LinkExpanded, LinkViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: LinkExpanded, LinkViaJsonString, LinkViaJsonFilePath, Link +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ISaaSData + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICloudAccount + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Disable-AzCommvaultStorageComplianceLock.md b/src/Commvault/Commvault/help/Disable-AzCommvaultStorageComplianceLock.md new file mode 100644 index 000000000000..b773eae79e4f --- /dev/null +++ b/src/Commvault/Commvault/help/Disable-AzCommvaultStorageComplianceLock.md @@ -0,0 +1,205 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/disable-azcommvaultstoragecompliancelock +schema: 2.0.0 +--- + +# Disable-AzCommvaultStorageComplianceLock + +## SYNOPSIS +Disable compliance lock on the storage. +Initiates an out-of-band multi-person authorization (MPA) email approval workflow on the partner side. +The storage compliance lock status transitions to 'DisablementPending' immediately; once the MPA approval completes, the status becomes 'Disabled' (observable via the refresh action). + +## SYNTAX + +### Disable (Default) +``` +Disable-AzCommvaultStorageComplianceLock -CloudAccountName -ResourceGroupName + -StorageName [-SubscriptionId ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### DisableViaIdentityCloudAccount +``` +Disable-AzCommvaultStorageComplianceLock -StorageName -CloudAccountInputObject + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### DisableViaIdentity +``` +Disable-AzCommvaultStorageComplianceLock -InputObject [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Disable compliance lock on the storage. +Initiates an out-of-band multi-person authorization (MPA) email approval workflow on the partner side. +The storage compliance lock status transitions to 'DisablementPending' immediately; once the MPA approval completes, the status becomes 'Disabled' (observable via the refresh action). + +## EXAMPLES + +### Example 1: Disable the compliance lock on a storage +```powershell +Disable-AzCommvaultStorageComplianceLock -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -StorageName storage-hot +``` + +Starts the multi-person authorization approval workflow to disable the compliance lock. +The compliance lock status changes to `DisablementPending` until the approval completes. + +## PARAMETERS + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: DisableViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Disable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: DisableViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Disable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageName +Name of the Storage resource + +```yaml +Type: System.String +Parameter Sets: Disable, DisableViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Disable +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IStorage + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Enable-AzCommvaultStorageComplianceLock.md b/src/Commvault/Commvault/help/Enable-AzCommvaultStorageComplianceLock.md new file mode 100644 index 000000000000..56d86ad97dbe --- /dev/null +++ b/src/Commvault/Commvault/help/Enable-AzCommvaultStorageComplianceLock.md @@ -0,0 +1,202 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/enable-azcommvaultstoragecompliancelock +schema: 2.0.0 +--- + +# Enable-AzCommvaultStorageComplianceLock + +## SYNOPSIS +Enable compliance lock on the storage. +Synchronous operation. + +## SYNTAX + +### Enable (Default) +``` +Enable-AzCommvaultStorageComplianceLock -CloudAccountName -ResourceGroupName + -StorageName [-SubscriptionId ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### EnableViaIdentityCloudAccount +``` +Enable-AzCommvaultStorageComplianceLock -StorageName -CloudAccountInputObject + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### EnableViaIdentity +``` +Enable-AzCommvaultStorageComplianceLock -InputObject [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Enable compliance lock on the storage. +Synchronous operation. + +## EXAMPLES + +### Example 1: Enable the compliance lock on a storage +```powershell +Enable-AzCommvaultStorageComplianceLock -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -StorageName storage-hot +``` + +Enables the compliance lock on the storage. + +## PARAMETERS + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: EnableViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Enable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: EnableViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Enable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageName +Name of the Storage resource + +```yaml +Type: System.String +Parameter Sets: Enable, EnableViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Enable +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IStorage + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Get-AzCommvaultCloudAccount.md b/src/Commvault/Commvault/help/Get-AzCommvaultCloudAccount.md new file mode 100644 index 000000000000..64a0527fe253 --- /dev/null +++ b/src/Commvault/Commvault/help/Get-AzCommvaultCloudAccount.md @@ -0,0 +1,158 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultcloudaccount +schema: 2.0.0 +--- + +# Get-AzCommvaultCloudAccount + +## SYNOPSIS +Get a CloudAccount + +## SYNTAX + +### List (Default) +``` +Get-AzCommvaultCloudAccount [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzCommvaultCloudAccount -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### List1 +``` +Get-AzCommvaultCloudAccount -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzCommvaultCloudAccount -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get a CloudAccount + +## EXAMPLES + +### Example 1: List the cloud accounts in a subscription +```powershell +Get-AzCommvaultCloudAccount +``` + +Lists all cloud accounts in the current subscription. + +### Example 2: List the cloud accounts in a resource group +```powershell +Get-AzCommvaultCloudAccount -ResourceGroupName rg-commvault +``` + +Lists the cloud accounts in the resource group. + +### Example 3: Get a cloud account +```powershell +Get-AzCommvaultCloudAccount -ResourceGroupName rg-commvault -Name cca-contoso +``` + +Gets the cloud account named cca-contoso. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: CloudAccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICloudAccount + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Get-AzCommvaultCloudAccountLatestLinkedSaaS.md b/src/Commvault/Commvault/help/Get-AzCommvaultCloudAccountLatestLinkedSaaS.md new file mode 100644 index 000000000000..338c9eb0aaae --- /dev/null +++ b/src/Commvault/Commvault/help/Get-AzCommvaultCloudAccountLatestLinkedSaaS.md @@ -0,0 +1,133 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultcloudaccountlatestlinkedsaas +schema: 2.0.0 +--- + +# Get-AzCommvaultCloudAccountLatestLinkedSaaS + +## SYNOPSIS +Returns the latest SaaS linked to the cloud account. + +## SYNTAX + +### Latest (Default) +``` +Get-AzCommvaultCloudAccountLatestLinkedSaaS -CloudAccountName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### LatestViaIdentity +``` +Get-AzCommvaultCloudAccountLatestLinkedSaaS -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Returns the latest SaaS linked to the cloud account. + +## EXAMPLES + +### Example 1: Get the latest linked SaaS of a cloud account +```powershell +Get-AzCommvaultCloudAccountLatestLinkedSaaS -ResourceGroupName rg-commvault -CloudAccountName cca-contoso +``` + +Gets the SaaS resource that was most recently linked to the cloud account. + +## PARAMETERS + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Latest +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: LatestViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Latest +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Latest +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ILatestLinkedSaaSResponse + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Get-AzCommvaultPlan.md b/src/Commvault/Commvault/help/Get-AzCommvaultPlan.md new file mode 100644 index 000000000000..96879945abc0 --- /dev/null +++ b/src/Commvault/Commvault/help/Get-AzCommvaultPlan.md @@ -0,0 +1,182 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultplan +schema: 2.0.0 +--- + +# Get-AzCommvaultPlan + +## SYNOPSIS +Get a CommvaultPlan + +## SYNTAX + +### List (Default) +``` +Get-AzCommvaultPlan -CloudAccountName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzCommvaultPlan -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentityCloudAccount +``` +Get-AzCommvaultPlan -Name -CloudAccountInputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzCommvaultPlan -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get a CommvaultPlan + +## EXAMPLES + +### Example 1: List the backup plans of a cloud account +```powershell +Get-AzCommvaultPlan -ResourceGroupName rg-commvault -CloudAccountName cca-contoso +``` + +Lists the backup plans of the cloud account. + +### Example 2: Get a backup plan +```powershell +Get-AzCommvaultPlan -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name plan-daily +``` + +Gets the backup plan named plan-daily. + +## PARAMETERS + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Plan resource + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityCloudAccount +Aliases: PlanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultPlan + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Get-AzCommvaultProtectedItem.md b/src/Commvault/Commvault/help/Get-AzCommvaultProtectedItem.md new file mode 100644 index 000000000000..6e60fb257ca8 --- /dev/null +++ b/src/Commvault/Commvault/help/Get-AzCommvaultProtectedItem.md @@ -0,0 +1,220 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultprotecteditem +schema: 2.0.0 +--- + +# Get-AzCommvaultProtectedItem + +## SYNOPSIS +Get a ProtectedItem + +## SYNTAX + +### List (Default) +``` +Get-AzCommvaultProtectedItem -CloudAccountName -ProtectionGroupName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzCommvaultProtectedItem -CloudAccountName -Name -ProtectionGroupName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentityProtectionGroup +``` +Get-AzCommvaultProtectedItem -Name -ProtectionGroupInputObject + [-DefaultProfile ] [] +``` + +### GetViaIdentityCloudAccount +``` +Get-AzCommvaultProtectedItem -Name -ProtectionGroupName + -CloudAccountInputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzCommvaultProtectedItem -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get a ProtectedItem + +## EXAMPLES + +### Example 1: List the protected items of a protection group +```powershell +Get-AzCommvaultProtectedItem -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms +``` + +Lists the protected items in the protection group. + +### Example 2: Get a protected item +```powershell +Get-AzCommvaultProtectedItem -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -Name vm-app01 +``` + +Gets the protected item named vm-app01. + +## PARAMETERS + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The protectedItem Id, name of 2 protected items can be same under a PG if they belong to different resource group or even different data source types VM/DB/AKS, etc; and name is mandatory in Azure Typespec, hence using name parameter for id in Commvault In case of Vm it will be vmGuid + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityProtectionGroup, GetViaIdentityCloudAccount +Aliases: ProtectedItemName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionGroupInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentityProtectionGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProtectionGroupName +Name of the ProtectionGroup resource + +```yaml +Type: System.String +Parameter Sets: List, Get, GetViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IProtectedItem + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Get-AzCommvaultProtectedItemCount.md b/src/Commvault/Commvault/help/Get-AzCommvaultProtectedItemCount.md new file mode 100644 index 000000000000..ce3925aeb6d3 --- /dev/null +++ b/src/Commvault/Commvault/help/Get-AzCommvaultProtectedItemCount.md @@ -0,0 +1,149 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultprotecteditemcount +schema: 2.0.0 +--- + +# Get-AzCommvaultProtectedItemCount + +## SYNOPSIS +Gets the count of protected items for provided CCA resource IDs across subscriptions. + +## SYNTAX + +### CountExpanded (Default) +``` +Get-AzCommvaultProtectedItemCount -ResourceId [-DefaultProfile ] + [] +``` + +### Count +``` +Get-AzCommvaultProtectedItemCount -Body [-DefaultProfile ] + [] +``` + +### CountViaJsonFilePath +``` +Get-AzCommvaultProtectedItemCount -JsonFilePath [-DefaultProfile ] + [] +``` + +### CountViaJsonString +``` +Get-AzCommvaultProtectedItemCount -JsonString [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets the count of protected items for provided CCA resource IDs across subscriptions. + +## EXAMPLES + +### Example 1: Count the protected items of cloud accounts +```powershell +Get-AzCommvaultProtectedItemCount -ResourceId '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Commvault.ContentStore/cloudAccounts/cca-contoso', '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Commvault.ContentStore/cloudAccounts/cca-fabrikam' +``` + +Gets the number of protected items for each of the specified cloud accounts. + +### Example 2: Count the protected items by using a JSON request +```powershell +Get-AzCommvaultProtectedItemCount -JsonString '{"resourceIds":["/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Commvault.ContentStore/cloudAccounts/cca-contoso"]}' +``` + +Gets the number of protected items by passing the request body as a JSON string. + +## PARAMETERS + +### -Body +Request to count protected items for the provided CCA resource IDs across subscriptions. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICountProtectedItemsRequest +Parameter Sets: Count +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Count operation + +```yaml +Type: System.String +Parameter Sets: CountViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Count operation + +```yaml +Type: System.String +Parameter Sets: CountViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The list of CCA resource IDs. + +```yaml +Type: System.String[] +Parameter Sets: CountExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICountProtectedItemsRequest + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICountProtectedItemsResponse + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Get-AzCommvaultProtectedItemRestorePoint.md b/src/Commvault/Commvault/help/Get-AzCommvaultProtectedItemRestorePoint.md new file mode 100644 index 000000000000..7da8d19257d1 --- /dev/null +++ b/src/Commvault/Commvault/help/Get-AzCommvaultProtectedItemRestorePoint.md @@ -0,0 +1,207 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultprotecteditemrestorepoint +schema: 2.0.0 +--- + +# Get-AzCommvaultProtectedItemRestorePoint + +## SYNOPSIS +Gets the restore points that are available for a protected item. + +## SYNTAX + +### Get (Default) +``` +Get-AzCommvaultProtectedItemRestorePoint -CloudAccountName -ProtectedItemName + -ProtectionGroupName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentityProtectionGroup +``` +Get-AzCommvaultProtectedItemRestorePoint -ProtectedItemName + -ProtectionGroupInputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentityCloudAccount +``` +Get-AzCommvaultProtectedItemRestorePoint -ProtectedItemName -ProtectionGroupName + -CloudAccountInputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzCommvaultProtectedItemRestorePoint -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets the restore points that are available for a protected item. + +## EXAMPLES + +### Example 1: Get the restore points of a protected item +```powershell +Get-AzCommvaultProtectedItemRestorePoint -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -ProtectedItemName vm-app01 +``` + +Gets the restore points that are available for the protected item. + +## PARAMETERS + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProtectedItemName +The protectedItem Id, name of 2 protected items can be same under a PG if they belong to different resource group or even different data source types VM/DB/AKS, etc; and name is mandatory in Azure Typespec, hence using name parameter for id in Commvault In case of Vm it will be vmGuid + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityProtectionGroup, GetViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionGroupInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentityProtectionGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProtectionGroupName +Name of the ProtectionGroup resource + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRestorePoints + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Get-AzCommvaultProtectionGroup.md b/src/Commvault/Commvault/help/Get-AzCommvaultProtectionGroup.md new file mode 100644 index 000000000000..913aece01eaa --- /dev/null +++ b/src/Commvault/Commvault/help/Get-AzCommvaultProtectionGroup.md @@ -0,0 +1,183 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultprotectiongroup +schema: 2.0.0 +--- + +# Get-AzCommvaultProtectionGroup + +## SYNOPSIS +Get a ProtectionGroup + +## SYNTAX + +### List (Default) +``` +Get-AzCommvaultProtectionGroup -CloudAccountName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzCommvaultProtectionGroup -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentityCloudAccount +``` +Get-AzCommvaultProtectionGroup -Name -CloudAccountInputObject + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzCommvaultProtectionGroup -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get a ProtectionGroup + +## EXAMPLES + +### Example 1: List the protection groups of a cloud account +```powershell +Get-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso +``` + +Lists the protection groups of the cloud account. + +### Example 2: Get a protection group +```powershell +Get-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms +``` + +Gets the protection group named pg-prod-vms. + +## PARAMETERS + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the ProtectionGroup resource + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityCloudAccount +Aliases: ProtectionGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IProtectionGroup + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Get-AzCommvaultRoleMapping.md b/src/Commvault/Commvault/help/Get-AzCommvaultRoleMapping.md new file mode 100644 index 000000000000..9981082861f4 --- /dev/null +++ b/src/Commvault/Commvault/help/Get-AzCommvaultRoleMapping.md @@ -0,0 +1,133 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultrolemapping +schema: 2.0.0 +--- + +# Get-AzCommvaultRoleMapping + +## SYNOPSIS +Get a RoleMapping + +## SYNTAX + +### Get (Default) +``` +Get-AzCommvaultRoleMapping -CloudAccountName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzCommvaultRoleMapping -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get a RoleMapping + +## EXAMPLES + +### Example 1: Get the role mapping of a cloud account +```powershell +Get-AzCommvaultRoleMapping -ResourceGroupName rg-commvault -CloudAccountName cca-contoso +``` + +Gets the role mapping of the cloud account. +Each cloud account has a single role mapping that maps Commvault roles to Microsoft Entra users and groups. + +## PARAMETERS + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRoleMapping + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Get-AzCommvaultStorage.md b/src/Commvault/Commvault/help/Get-AzCommvaultStorage.md new file mode 100644 index 000000000000..2c4b8d92a9bc --- /dev/null +++ b/src/Commvault/Commvault/help/Get-AzCommvaultStorage.md @@ -0,0 +1,182 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/get-azcommvaultstorage +schema: 2.0.0 +--- + +# Get-AzCommvaultStorage + +## SYNOPSIS +Get a Storage + +## SYNTAX + +### List (Default) +``` +Get-AzCommvaultStorage -CloudAccountName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzCommvaultStorage -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentityCloudAccount +``` +Get-AzCommvaultStorage -Name -CloudAccountInputObject + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzCommvaultStorage -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get a Storage + +## EXAMPLES + +### Example 1: List the storages of a cloud account +```powershell +Get-AzCommvaultStorage -ResourceGroupName rg-commvault -CloudAccountName cca-contoso +``` + +Lists the storages of the cloud account. + +### Example 2: Get a storage +```powershell +Get-AzCommvaultStorage -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name storage-hot +``` + +Gets the storage named storage-hot. + +## PARAMETERS + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Storage resource + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityCloudAccount +Aliases: StorageName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IStorage + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Initialize-AzCommvaultSaaS.md b/src/Commvault/Commvault/help/Initialize-AzCommvaultSaaS.md new file mode 100644 index 000000000000..4d99c51ebb86 --- /dev/null +++ b/src/Commvault/Commvault/help/Initialize-AzCommvaultSaaS.md @@ -0,0 +1,457 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/initialize-azcommvaultsaas +schema: 2.0.0 +--- + +# Initialize-AzCommvaultSaaS + +## SYNOPSIS +Resolve the token to get the SaaS resource ID and activate the SaaS resource + +## SYNTAX + +### ActivateExpanded (Default) +``` +Initialize-AzCommvaultSaaS [-SubscriptionId ] -SaasGuid + [-ActivateSaaSRequestParamSaasResourceId ] [-CompanyCity ] [-CompanyCountry ] + [-CompanyJobTitle ] [-CompanyName ] [-CompanyPostalCode ] [-CompanyState ] + [-CompanyStreet ] [-CompanyWebsite ] [-PublisherId ] [-UserEmailAddress ] + [-UserFirstName ] [-UserLastName ] [-UserPhoneNumber ] [-UserUpn ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### Activate +``` +Initialize-AzCommvaultSaaS [-SubscriptionId ] -Body + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### ActivateViaJsonFilePath +``` +Initialize-AzCommvaultSaaS [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### ActivateViaJsonString +``` +Initialize-AzCommvaultSaaS [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Resolve the token to get the SaaS resource ID and activate the SaaS resource + +## EXAMPLES + +### Example 1: Activate a SaaS resource +```powershell +Initialize-AzCommvaultSaaS -SaasGuid '55555555-6666-7777-8888-999999999999' -PublisherId 'contoso-publisher' -ActivateSaaSRequestParamSaasResourceId '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Microsoft.SaaS/resources/commvault-saas' -UserFirstName 'John' -UserLastName 'Smith' -UserEmailAddress 'john.smith@contoso.com' -UserUpn 'john.smith@contoso.com' -CompanyName 'Contoso' +``` + +Activates the SaaS resource for the specified user and company. + +### Example 2: Activate a SaaS resource by using a JSON request +```powershell +Initialize-AzCommvaultSaaS -JsonString '{"saasGuid":"55555555-6666-7777-8888-999999999999","publisherId":"contoso-publisher","activateSaaSRequestParam":{"saasResourceId":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Microsoft.SaaS/resources/commvault-saas","user":{"firstName":"John","lastName":"Smith","emailAddress":"john.smith@contoso.com","upn":"john.smith@contoso.com"},"company":{"companyName":"Contoso"}}}' +``` + +Activates the SaaS resource by passing the request body as a JSON string. + +## PARAMETERS + +### -ActivateSaaSRequestParamSaasResourceId +Optional Marketplace SaaS resource identifier + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +SaaS guid for Activate and Validate SaaS Resource + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IActivateSaaSParameterRequest +Parameter Sets: Activate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CompanyCity +City of the company address. + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyCountry +Country of the company address. + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyJobTitle +Job title + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyName +Company name + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyPostalCode +Postal code + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyState +State or province of the company address. + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyStreet +Street address + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyWebsite +Company website + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Activate operation + +```yaml +Type: System.String +Parameter Sets: ActivateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Activate operation + +```yaml +Type: System.String +Parameter Sets: ActivateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublisherId +Optional publisher identifier + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SaasGuid +SaaS guid for Activate and Validate SaaS Resource + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserEmailAddress +Email address of the user + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserFirstName +First name of the user + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserLastName +Last name of the user + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPhoneNumber +User's phone number + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserUpn +User's principal name + +```yaml +Type: System.String +Parameter Sets: ActivateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IActivateSaaSParameterRequest + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ISaaSResourceDetailsResponse + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/New-AzCommvaultCloudAccount.md b/src/Commvault/Commvault/help/New-AzCommvaultCloudAccount.md new file mode 100644 index 000000000000..ee7210870ee2 --- /dev/null +++ b/src/Commvault/Commvault/help/New-AzCommvaultCloudAccount.md @@ -0,0 +1,632 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/new-azcommvaultcloudaccount +schema: 2.0.0 +--- + +# New-AzCommvaultCloudAccount + +## SYNOPSIS +Create a CloudAccount + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzCommvaultCloudAccount -Name -ResourceGroupName [-SubscriptionId ] + -Location [-CompanyCity ] [-CompanyCountry ] [-CompanyJobTitle ] + [-CompanyName ] [-CompanyPostalCode ] [-CompanyState ] [-CompanyStreet ] + [-CompanyWebsite ] [-EnableSystemAssignedIdentity] [-MarketplaceSaasResourceId ] + [-MarketplaceSubscriptionId ] [-OfferDetailOfferId ] [-OfferDetailPlanId ] + [-OfferDetailPlanName ] [-OfferDetailPublisherId ] [-OfferDetailTermId ] + [-OfferDetailTermUnit ] [-RoleAssignmentsOnCcaCreate ] [-Tag ] + [-UserAssignedIdentity ] [-UserEmailAddress ] [-UserFirstName ] + [-UserLastName ] [-UserPhoneNumber ] [-UserUpn ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzCommvaultCloudAccount -Name -ResourceGroupName [-SubscriptionId ] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonString +``` +New-AzCommvaultCloudAccount -Name -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Create a CloudAccount + +## EXAMPLES + +### Example 1: Create a cloud account +```powershell +New-AzCommvaultCloudAccount -ResourceGroupName rg-commvault -Name cca-contoso -Location eastus -EnableSystemAssignedIdentity -MarketplaceSubscriptionId '00000000-0000-0000-0000-000000000000' -OfferDetailPublisherId 'contoso-publisher' -OfferDetailOfferId 'contoso-offer' -OfferDetailPlanId 'contoso-plan' -OfferDetailPlanName 'Contoso Plan' -OfferDetailTermUnit 'P1M' -OfferDetailTermId 'contoso-term' -UserFirstName 'John' -UserLastName 'Doe' -UserEmailAddress 'john.doe@contoso.com' -UserUpn 'john.doe@contoso.com' +``` + +Creates a cloud account with a system-assigned managed identity. + +### Example 2: Create a cloud account and assign roles to Microsoft Entra groups +```powershell +$roleAssignments = @( + @{ RoleName = 'BackupAdmin'; Entity = @(@{ Id = 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'; DisplayName = 'Tenant Admins'; EntityType = 'Group' }) }, + @{ RoleName = 'BackupOperator'; Entity = @(@{ Id = '44444444-5555-6666-7777-888888888888'; DisplayName = 'Ops Team'; EntityType = 'Group' }) } +) +New-AzCommvaultCloudAccount -ResourceGroupName rg-commvault -Name cca-contoso -Location eastus -EnableSystemAssignedIdentity -MarketplaceSubscriptionId '00000000-0000-0000-0000-000000000000' -OfferDetailPublisherId 'contoso-publisher' -OfferDetailOfferId 'contoso-offer' -OfferDetailPlanId 'contoso-plan' -OfferDetailPlanName 'Contoso Plan' -OfferDetailTermUnit 'P1M' -OfferDetailTermId 'contoso-term' -UserFirstName 'John' -UserLastName 'Doe' -UserEmailAddress 'john.doe@contoso.com' -UserUpn 'john.doe@contoso.com' -RoleAssignmentsOnCcaCreate $roleAssignments +``` + +Creates a cloud account and assigns the Commvault roles to the specified Microsoft Entra groups. + +### Example 3: Create a cloud account by using a JSON file +```powershell +New-AzCommvaultCloudAccount -ResourceGroupName rg-commvault -Name cca-contoso -JsonFilePath '.\cloud-account.json' +``` + +Creates a cloud account from the request body in the JSON file. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyCity +City of the company address. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyCountry +Country of the company address. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyJobTitle +Job title + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyName +Company name + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyPostalCode +Postal code + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyState +State or province of the company address. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyStreet +Street address + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyWebsite +Company website + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketplaceSaasResourceId +Marketplace SaaS Resource Id + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketplaceSubscriptionId +Azure subscription id for the the marketplace offer is purchased from + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CloudAccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailOfferId +Offer Id for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailPlanId +Plan Id for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailPlanName +Plan Name for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailPublisherId +Publisher Id for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailTermId +Plan Display Name for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailTermUnit +Plan Display Name for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleAssignmentsOnCcaCreate +Role assignments to provision during CCA creation. +Each entry maps a Commvault role to its assigned Entra principals. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRoleAssignment[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserEmailAddress +Email address of the user + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserFirstName +First name of the user + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserLastName +Last name of the user + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPhoneNumber +User's phone number + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserUpn +User's principal name + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICloudAccount + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/New-AzCommvaultPlan.md b/src/Commvault/Commvault/help/New-AzCommvaultPlan.md new file mode 100644 index 000000000000..cefe79469d65 --- /dev/null +++ b/src/Commvault/Commvault/help/New-AzCommvaultPlan.md @@ -0,0 +1,325 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/new-azcommvaultplan +schema: 2.0.0 +--- + +# New-AzCommvaultPlan + +## SYNOPSIS +Create a CommvaultPlan + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzCommvaultPlan -PlanName -CloudAccountName -ResourceGroupName + [-SubscriptionId ] [-Location ] [-RetentionNumberOfSnapshot ] [-Schedule ] + [-StoragePlan ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonString +``` +New-AzCommvaultPlan -PlanName -CloudAccountName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzCommvaultPlan -PlanName -CloudAccountName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaIdentityCloudAccountExpanded +``` +New-AzCommvaultPlan -PlanName -CloudAccountInputObject [-Location ] + [-RetentionNumberOfSnapshot ] [-Schedule ] [-StoragePlan ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Create a CommvaultPlan + +## EXAMPLES + +### Example 1: Create a backup plan +```powershell +$storagePlan = @{ Name = 'primary'; StoragePoolId = 'storage-hot'; CopyName = 'primary-copy'; CopyPrecedence = 1; RetentionPeriod = 30; RetentionTime = 'monthly'; BackupRuleType = 'ALL_JOBS' } +$schedule = @{ BackupType = 'INCREMENTAL'; Frequency = 'daily'; RunsEvery = 1; Time = '22:00'; TimeZone = 'UTC' } +New-AzCommvaultPlan -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -PlanName plan-daily -Location eastus -StoragePlan $storagePlan -Schedule $schedule -RetentionNumberOfSnapshot 7 +``` + +Creates a backup plan that runs an incremental backup every day and keeps seven snapshots. + +### Example 2: Create a backup plan by using a JSON file +```powershell +New-AzCommvaultPlan -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -PlanName plan-daily -JsonFilePath '.\plan.json' +``` + +Creates a backup plan from the request body in the JSON file. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the Commvault Plan + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanName +Name of the Plan resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionNumberOfSnapshot +Number of Snapshots + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded, CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Schedule +The Commvault Plan Schedule + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ISchedule[] +Parameter Sets: CreateExpanded, CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePlan +The storage plans associated with the Commvault Plan + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IStoragePlan[] +Parameter Sets: CreateExpanded, CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultPlan + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/New-AzCommvaultProtectionGroup.md b/src/Commvault/Commvault/help/New-AzCommvaultProtectionGroup.md new file mode 100644 index 000000000000..74ce55a0a6ab --- /dev/null +++ b/src/Commvault/Commvault/help/New-AzCommvaultProtectionGroup.md @@ -0,0 +1,324 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/new-azcommvaultprotectiongroup +schema: 2.0.0 +--- + +# New-AzCommvaultProtectionGroup + +## SYNOPSIS +Create a ProtectionGroup + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzCommvaultProtectionGroup -ProtectionGroupName -CloudAccountName + -ResourceGroupName [-SubscriptionId ] [-MatchRule ] [-MatchRuleMatchType ] + [-Plan ] [-ResourceManual ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonString +``` +New-AzCommvaultProtectionGroup -ProtectionGroupName -CloudAccountName + -ResourceGroupName [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzCommvaultProtectionGroup -ProtectionGroupName -CloudAccountName + -ResourceGroupName [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### CreateViaIdentityCloudAccountExpanded +``` +New-AzCommvaultProtectionGroup -ProtectionGroupName -CloudAccountInputObject + [-MatchRule ] [-MatchRuleMatchType ] [-Plan ] [-ResourceManual ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Create a ProtectionGroup + +## EXAMPLES + +### Example 1: Create a protection group for specific virtual machines +```powershell +New-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -Plan plan-daily -ResourceManual '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-app/providers/Microsoft.Compute/virtualMachines/vm-app01' +``` + +Creates a protection group that protects the specified virtual machine with the backup plan plan-daily. + +### Example 2: Create a protection group that selects virtual machines by a rule +```powershell +$rule = @{ Property = 'resourceGroup'; Operator = 'contains'; Value = 'prod' } +New-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -Plan plan-daily -MatchRule $rule -MatchRuleMatchType 'all' +``` + +Creates a protection group that protects the virtual machines whose resource group name contains prod. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchRule +rules to match + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRule[] +Parameter Sets: CreateExpanded, CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchRuleMatchType +match Type all or any + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Plan +The Commvault Plan to be associated with the Protection Group + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionGroupName +Name of the ProtectionGroup resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceManual +The items to be protected under Protection Group + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded, CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IProtectionGroup + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/New-AzCommvaultRoleMapping.md b/src/Commvault/Commvault/help/New-AzCommvaultRoleMapping.md new file mode 100644 index 000000000000..bc7a42de8aff --- /dev/null +++ b/src/Commvault/Commvault/help/New-AzCommvaultRoleMapping.md @@ -0,0 +1,211 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/new-azcommvaultrolemapping +schema: 2.0.0 +--- + +# New-AzCommvaultRoleMapping + +## SYNOPSIS +Create a RoleMapping + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzCommvaultRoleMapping -CloudAccountName -ResourceGroupName [-SubscriptionId ] + [-Role ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzCommvaultRoleMapping -CloudAccountName -ResourceGroupName [-SubscriptionId ] + -JsonFilePath [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### CreateViaJsonString +``` +New-AzCommvaultRoleMapping -CloudAccountName -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Create a RoleMapping + +## EXAMPLES + +### Example 1: Create the role mapping of a cloud account +```powershell +$roles = @( + @{ RoleName = 'BackupAdmin'; Entity = @(@{ Id = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890'; DisplayName = 'Backup Admins Group'; EntityType = 'Group' }) }, + @{ RoleName = 'BackupUser'; Entity = @(@{ Id = '22222222-3333-4444-5555-666666666666'; DisplayName = 'Jane Doe'; EntityType = 'User' }) } +) +New-AzCommvaultRoleMapping -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Role $roles +``` + +Maps the BackupAdmin and BackupUser roles to a Microsoft Entra group and user. + +### Example 2: Create the role mapping by using a JSON file +```powershell +New-AzCommvaultRoleMapping -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -JsonFilePath '.\role-mapping.json' +``` + +Creates the role mapping from the request body in the JSON file. + +## PARAMETERS + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +The list of role assignments mapping roles to Entra entities (users and groups) + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRoleAssignment[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRoleMapping + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/New-AzCommvaultStorage.md b/src/Commvault/Commvault/help/New-AzCommvaultStorage.md new file mode 100644 index 000000000000..913b09548ab4 --- /dev/null +++ b/src/Commvault/Commvault/help/New-AzCommvaultStorage.md @@ -0,0 +1,291 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/new-azcommvaultstorage +schema: 2.0.0 +--- + +# New-AzCommvaultStorage + +## SYNOPSIS +Create a Storage + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzCommvaultStorage -Name -CloudAccountName -ResourceGroupName + [-SubscriptionId ] [-Location ] [-StorageClassType ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonString +``` +New-AzCommvaultStorage -Name -CloudAccountName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzCommvaultStorage -Name -CloudAccountName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaIdentityCloudAccountExpanded +``` +New-AzCommvaultStorage -Name -CloudAccountInputObject [-Location ] + [-StorageClassType ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Create a Storage + +## EXAMPLES + +### Example 1: Create a hot storage +```powershell +New-AzCommvaultStorage -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name storage-hot -Location eastus -StorageClassType HOT +``` + +Creates a hot storage in the East US region. + +### Example 2: Create a cold storage +```powershell +New-AzCommvaultStorage -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name storage-cold -Location eastus -StorageClassType COLD +``` + +Creates a cold storage in the East US region. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the Commvault Storage + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Storage resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageClassType +The class of Commvault Storage + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityCloudAccountExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IStorage + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Remove-AzCommvaultCloudAccount.md b/src/Commvault/Commvault/help/Remove-AzCommvaultCloudAccount.md new file mode 100644 index 000000000000..2620e1788657 --- /dev/null +++ b/src/Commvault/Commvault/help/Remove-AzCommvaultCloudAccount.md @@ -0,0 +1,209 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/remove-azcommvaultcloudaccount +schema: 2.0.0 +--- + +# Remove-AzCommvaultCloudAccount + +## SYNOPSIS +Delete a CloudAccount + +## SYNTAX + +### Delete (Default) +``` +Remove-AzCommvaultCloudAccount -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzCommvaultCloudAccount -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Delete a CloudAccount + +## EXAMPLES + +### Example 1: Delete a cloud account +```powershell +Remove-AzCommvaultCloudAccount -ResourceGroupName rg-commvault -Name cca-contoso +``` + +Deletes the cloud account named cca-contoso. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: CloudAccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Remove-AzCommvaultPlan.md b/src/Commvault/Commvault/help/Remove-AzCommvaultPlan.md new file mode 100644 index 000000000000..bf6c4b356128 --- /dev/null +++ b/src/Commvault/Commvault/help/Remove-AzCommvaultPlan.md @@ -0,0 +1,246 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/remove-azcommvaultplan +schema: 2.0.0 +--- + +# Remove-AzCommvaultPlan + +## SYNOPSIS +Delete a CommvaultPlan + +## SYNTAX + +### Delete (Default) +``` +Remove-AzCommvaultPlan -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentityCloudAccount +``` +Remove-AzCommvaultPlan -Name -CloudAccountInputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzCommvaultPlan -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Delete a CommvaultPlan + +## EXAMPLES + +### Example 1: Delete a backup plan +```powershell +Remove-AzCommvaultPlan -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name plan-daily +``` + +Deletes the backup plan named plan-daily. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: DeleteViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Plan resource + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityCloudAccount +Aliases: PlanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Remove-AzCommvaultProtectionGroup.md b/src/Commvault/Commvault/help/Remove-AzCommvaultProtectionGroup.md new file mode 100644 index 000000000000..9dee6b1a51dc --- /dev/null +++ b/src/Commvault/Commvault/help/Remove-AzCommvaultProtectionGroup.md @@ -0,0 +1,246 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/remove-azcommvaultprotectiongroup +schema: 2.0.0 +--- + +# Remove-AzCommvaultProtectionGroup + +## SYNOPSIS +Delete a ProtectionGroup + +## SYNTAX + +### Delete (Default) +``` +Remove-AzCommvaultProtectionGroup -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentityCloudAccount +``` +Remove-AzCommvaultProtectionGroup -Name -CloudAccountInputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzCommvaultProtectionGroup -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Delete a ProtectionGroup + +## EXAMPLES + +### Example 1: Delete a protection group +```powershell +Remove-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms +``` + +Deletes the protection group named pg-prod-vms. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: DeleteViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the ProtectionGroup resource + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityCloudAccount +Aliases: ProtectionGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Remove-AzCommvaultRoleMapping.md b/src/Commvault/Commvault/help/Remove-AzCommvaultRoleMapping.md new file mode 100644 index 000000000000..cf5db8acb8ec --- /dev/null +++ b/src/Commvault/Commvault/help/Remove-AzCommvaultRoleMapping.md @@ -0,0 +1,179 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/remove-azcommvaultrolemapping +schema: 2.0.0 +--- + +# Remove-AzCommvaultRoleMapping + +## SYNOPSIS +Delete a RoleMapping + +## SYNTAX + +### Delete (Default) +``` +Remove-AzCommvaultRoleMapping -CloudAccountName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzCommvaultRoleMapping -InputObject [-DefaultProfile ] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Delete a RoleMapping + +## EXAMPLES + +### Example 1: Delete the role mapping of a cloud account +```powershell +Remove-AzCommvaultRoleMapping -ResourceGroupName rg-commvault -CloudAccountName cca-contoso +``` + +Deletes the role mapping of the cloud account. + +## PARAMETERS + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Remove-AzCommvaultStorage.md b/src/Commvault/Commvault/help/Remove-AzCommvaultStorage.md new file mode 100644 index 000000000000..4fa809a80ed6 --- /dev/null +++ b/src/Commvault/Commvault/help/Remove-AzCommvaultStorage.md @@ -0,0 +1,246 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/remove-azcommvaultstorage +schema: 2.0.0 +--- + +# Remove-AzCommvaultStorage + +## SYNOPSIS +Delete a Storage + +## SYNTAX + +### Delete (Default) +``` +Remove-AzCommvaultStorage -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentityCloudAccount +``` +Remove-AzCommvaultStorage -Name -CloudAccountInputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzCommvaultStorage -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Delete a Storage + +## EXAMPLES + +### Example 1: Delete a storage +```powershell +Remove-AzCommvaultStorage -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name storage-cold +``` + +Deletes the storage named storage-cold. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: DeleteViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Storage resource + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityCloudAccount +Aliases: StorageName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Restore-AzCommvaultProtectedItem.md b/src/Commvault/Commvault/help/Restore-AzCommvaultProtectedItem.md new file mode 100644 index 000000000000..0255a279ac22 --- /dev/null +++ b/src/Commvault/Commvault/help/Restore-AzCommvaultProtectedItem.md @@ -0,0 +1,396 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/restore-azcommvaultprotecteditem +schema: 2.0.0 +--- + +# Restore-AzCommvaultProtectedItem + +## SYNOPSIS +Restore resource for a protected item. + +## SYNTAX + +### RestoreViaIdentity (Default) +``` +Restore-AzCommvaultProtectedItem -InputObject -Request + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### RestoreViaJsonString +``` +Restore-AzCommvaultProtectedItem -CloudAccountName -Name -ProtectionGroupName + -ResourceGroupName [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### RestoreViaJsonFilePath +``` +Restore-AzCommvaultProtectedItem -CloudAccountName -Name -ProtectionGroupName + -ResourceGroupName [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### RestoreExpanded +``` +Restore-AzCommvaultProtectedItem -CloudAccountName -Name -ProtectionGroupName + -ResourceGroupName [-SubscriptionId ] [-InPlaceRestore] + -VMDestinationInfoVminfoList [-RestoreType ] [-ToTime ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### Restore +``` +Restore-AzCommvaultProtectedItem -CloudAccountName -Name -ProtectionGroupName + -ResourceGroupName [-SubscriptionId ] -Request + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### RestoreViaIdentityProtectionGroupExpanded +``` +Restore-AzCommvaultProtectedItem -Name -ProtectionGroupInputObject + [-InPlaceRestore] -VMDestinationInfoVminfoList [-RestoreType ] [-ToTime ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### RestoreViaIdentityProtectionGroup +``` +Restore-AzCommvaultProtectedItem -Name -ProtectionGroupInputObject + -Request [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### RestoreViaIdentityCloudAccountExpanded +``` +Restore-AzCommvaultProtectedItem -Name -ProtectionGroupName + -CloudAccountInputObject [-InPlaceRestore] -VMDestinationInfoVminfoList + [-RestoreType ] [-ToTime ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### RestoreViaIdentityCloudAccount +``` +Restore-AzCommvaultProtectedItem -Name -ProtectionGroupName + -CloudAccountInputObject -Request + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### RestoreViaIdentityExpanded +``` +Restore-AzCommvaultProtectedItem -InputObject [-InPlaceRestore] + -VMDestinationInfoVminfoList [-RestoreType ] [-ToTime ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Restore resource for a protected item. + +## EXAMPLES + +### Example 1: Restore a protected item in place +```powershell +Restore-AzCommvaultProtectedItem -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -Name vm-app01 -InPlaceRestore -VMDestinationInfoVminfoList @{ SourceVMGuid = '40000000-aaaa-4bbb-8ccc-000000000000'; StorageAccountId = '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-restore/providers/Microsoft.Storage/storageAccounts/strestore01'; PowerOnVMAfterRestore = $true } +``` + +Restores the virtual machine in place and powers it on after the restore completes. + +### Example 2: Restore a protected item as a new virtual machine by using a JSON request +```powershell +Restore-AzCommvaultProtectedItem -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -Name vm-app01 -JsonString '{"inPlaceRestore":false,"restoreType":"VIRTUAL_MACHINE","vmDestinationInfo":{"vmInfoList":[{"sourceVmGuid":"40000000-aaaa-4bbb-8ccc-000000000000","name":"vm-app01-restored","resourceGroup":"rg-restore","region":"eastus","storageAccountId":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-restore/providers/Microsoft.Storage/storageAccounts/strestore01","networkId":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-restore/providers/Microsoft.Network/virtualNetworks/vnet-restore","subnetId":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-restore/providers/Microsoft.Network/virtualNetworks/vnet-restore/subnets/default","powerOnVmAfterRestore":true}]}}' +``` + +Restores the virtual machine as a new virtual machine in another resource group and region by passing the request body as a JSON string. + +## PARAMETERS + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: RestoreViaIdentityCloudAccountExpanded, RestoreViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: RestoreViaJsonString, RestoreViaJsonFilePath, RestoreExpanded, Restore +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InPlaceRestore +Check whether inplace or out of place restore. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RestoreExpanded, RestoreViaIdentityProtectionGroupExpanded, RestoreViaIdentityCloudAccountExpanded, RestoreViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: RestoreViaIdentity, RestoreViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Restore operation + +```yaml +Type: System.String +Parameter Sets: RestoreViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Restore operation + +```yaml +Type: System.String +Parameter Sets: RestoreViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The protectedItem Id, name of 2 protected items can be same under a PG if they belong to different resource group or even different data source types VM/DB/AKS, etc; and name is mandatory in Azure Typespec, hence using name parameter for id in Commvault In case of Vm it will be vmGuid + +```yaml +Type: System.String +Parameter Sets: RestoreViaJsonString, RestoreViaJsonFilePath, RestoreExpanded, Restore, RestoreViaIdentityProtectionGroupExpanded, RestoreViaIdentityProtectionGroup, RestoreViaIdentityCloudAccountExpanded, RestoreViaIdentityCloudAccount +Aliases: ProtectedItemName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionGroupInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: RestoreViaIdentityProtectionGroupExpanded, RestoreViaIdentityProtectionGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProtectionGroupName +Name of the ProtectionGroup resource + +```yaml +Type: System.String +Parameter Sets: RestoreViaJsonString, RestoreViaJsonFilePath, RestoreExpanded, Restore, RestoreViaIdentityCloudAccountExpanded, RestoreViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Request +The properties of RestoreProtectionItemRequest + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRestoreProtectionItemRequest +Parameter Sets: RestoreViaIdentity, Restore, RestoreViaIdentityProtectionGroup, RestoreViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: RestoreViaJsonString, RestoreViaJsonFilePath, RestoreExpanded, Restore +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreType +Type of Restore + +```yaml +Type: System.String +Parameter Sets: RestoreExpanded, RestoreViaIdentityProtectionGroupExpanded, RestoreViaIdentityCloudAccountExpanded, RestoreViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: RestoreViaJsonString, RestoreViaJsonFilePath, RestoreExpanded, Restore +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ToTime +Time to restore + +```yaml +Type: System.String +Parameter Sets: RestoreExpanded, RestoreViaIdentityProtectionGroupExpanded, RestoreViaIdentityCloudAccountExpanded, RestoreViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMDestinationInfoVminfoList +List of information on VMs + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IVMInfo[] +Parameter Sets: RestoreExpanded, RestoreViaIdentityProtectionGroupExpanded, RestoreViaIdentityCloudAccountExpanded, RestoreViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRestoreProtectionItemRequest + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRestoreProtectionItemResponse + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Restore-AzCommvaultProtectionGroup.md b/src/Commvault/Commvault/help/Restore-AzCommvaultProtectionGroup.md new file mode 100644 index 000000000000..6d7af6addb8c --- /dev/null +++ b/src/Commvault/Commvault/help/Restore-AzCommvaultProtectionGroup.md @@ -0,0 +1,351 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/restore-azcommvaultprotectiongroup +schema: 2.0.0 +--- + +# Restore-AzCommvaultProtectionGroup + +## SYNOPSIS +Restore resource for a protected items in given protection group. + +## SYNTAX + +### RestoreViaIdentity (Default) +``` +Restore-AzCommvaultProtectionGroup -InputObject -Request + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### RestoreViaJsonString +``` +Restore-AzCommvaultProtectionGroup -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### RestoreViaJsonFilePath +``` +Restore-AzCommvaultProtectionGroup -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### RestoreExpanded +``` +Restore-AzCommvaultProtectionGroup -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-InPlaceRestore] -VMDestinationInfoVminfoList [-RestoreType ] + [-ToTime ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### Restore +``` +Restore-AzCommvaultProtectionGroup -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] -Request [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### RestoreViaIdentityCloudAccountExpanded +``` +Restore-AzCommvaultProtectionGroup -Name -CloudAccountInputObject + [-InPlaceRestore] -VMDestinationInfoVminfoList [-RestoreType ] [-ToTime ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### RestoreViaIdentityCloudAccount +``` +Restore-AzCommvaultProtectionGroup -Name -CloudAccountInputObject + -Request [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### RestoreViaIdentityExpanded +``` +Restore-AzCommvaultProtectionGroup -InputObject [-InPlaceRestore] + -VMDestinationInfoVminfoList [-RestoreType ] [-ToTime ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Restore resource for a protected items in given protection group. + +## EXAMPLES + +### Example 1: Restore a protection group in place +```powershell +Restore-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms -InPlaceRestore -VMDestinationInfoVminfoList @{ SourceVMGuid = '40000000-aaaa-4bbb-8ccc-000000000000'; StorageAccountId = '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-restore/providers/Microsoft.Storage/storageAccounts/strestore01'; PowerOnVMAfterRestore = $true } +``` + +Restores the specified virtual machine of the protection group in place and powers it on after the restore completes. + +### Example 2: Restore a protection group by using a JSON file +```powershell +Restore-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms -JsonFilePath '.\restore-request.json' +``` + +Restores the protection group by using the request body in the JSON file. + +## PARAMETERS + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: RestoreViaIdentityCloudAccountExpanded, RestoreViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: RestoreViaJsonString, RestoreViaJsonFilePath, RestoreExpanded, Restore +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InPlaceRestore +Check whether inplace or out of place restore. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RestoreExpanded, RestoreViaIdentityCloudAccountExpanded, RestoreViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: RestoreViaIdentity, RestoreViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Restore operation + +```yaml +Type: System.String +Parameter Sets: RestoreViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Restore operation + +```yaml +Type: System.String +Parameter Sets: RestoreViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the ProtectionGroup resource + +```yaml +Type: System.String +Parameter Sets: RestoreViaJsonString, RestoreViaJsonFilePath, RestoreExpanded, Restore, RestoreViaIdentityCloudAccountExpanded, RestoreViaIdentityCloudAccount +Aliases: ProtectionGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Request +The properties of RestoreProtectionItemRequest + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRestoreProtectionItemRequest +Parameter Sets: RestoreViaIdentity, Restore, RestoreViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: RestoreViaJsonString, RestoreViaJsonFilePath, RestoreExpanded, Restore +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreType +Type of Restore + +```yaml +Type: System.String +Parameter Sets: RestoreExpanded, RestoreViaIdentityCloudAccountExpanded, RestoreViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: RestoreViaJsonString, RestoreViaJsonFilePath, RestoreExpanded, Restore +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ToTime +Time to restore + +```yaml +Type: System.String +Parameter Sets: RestoreExpanded, RestoreViaIdentityCloudAccountExpanded, RestoreViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMDestinationInfoVminfoList +List of information on VMs + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IVMInfo[] +Parameter Sets: RestoreExpanded, RestoreViaIdentityCloudAccountExpanded, RestoreViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRestoreProtectionItemRequest + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRestoreProtectionItemResponse + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Resume-AzCommvaultProtectionGroupBackup.md b/src/Commvault/Commvault/help/Resume-AzCommvaultProtectionGroupBackup.md new file mode 100644 index 000000000000..a1f4da1e85c6 --- /dev/null +++ b/src/Commvault/Commvault/help/Resume-AzCommvaultProtectionGroupBackup.md @@ -0,0 +1,216 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/resume-azcommvaultprotectiongroupbackup +schema: 2.0.0 +--- + +# Resume-AzCommvaultProtectionGroupBackup + +## SYNOPSIS +Resume Backup for a Protection Group. + +## SYNTAX + +### Resume (Default) +``` +Resume-AzCommvaultProtectionGroupBackup -CloudAccountName -ProtectionGroupName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### ResumeViaIdentityCloudAccount +``` +Resume-AzCommvaultProtectionGroupBackup -ProtectionGroupName + -CloudAccountInputObject [-DefaultProfile ] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### ResumeViaIdentity +``` +Resume-AzCommvaultProtectionGroupBackup -InputObject [-DefaultProfile ] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Resume Backup for a Protection Group. + +## EXAMPLES + +### Example 1: Resume the backups of a protection group +```powershell +Resume-AzCommvaultProtectionGroupBackup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms +``` + +Resumes the scheduled backups of a protection group whose backups were stopped. + +## PARAMETERS + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: ResumeViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Resume +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: ResumeViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionGroupName +Name of the ProtectionGroup resource + +```yaml +Type: System.String +Parameter Sets: Resume, ResumeViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Resume +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Resume +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Stop-AzCommvaultProtectionGroupBackup.md b/src/Commvault/Commvault/help/Stop-AzCommvaultProtectionGroupBackup.md new file mode 100644 index 000000000000..5ad2eb4cf07c --- /dev/null +++ b/src/Commvault/Commvault/help/Stop-AzCommvaultProtectionGroupBackup.md @@ -0,0 +1,370 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/stop-azcommvaultprotectiongroupbackup +schema: 2.0.0 +--- + +# Stop-AzCommvaultProtectionGroupBackup + +## SYNOPSIS +Stop Backup for a Protection Group + +## SYNTAX + +### StopExpanded (Default) +``` +Stop-AzCommvaultProtectionGroupBackup -CloudAccountName -ProtectionGroupName + -ResourceGroupName [-SubscriptionId ] -Reason [-Comment ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +### StopViaJsonString +``` +Stop-AzCommvaultProtectionGroupBackup -CloudAccountName -ProtectionGroupName + -ResourceGroupName [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### StopViaJsonFilePath +``` +Stop-AzCommvaultProtectionGroupBackup -CloudAccountName -ProtectionGroupName + -ResourceGroupName [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### Stop +``` +Stop-AzCommvaultProtectionGroupBackup -CloudAccountName -ProtectionGroupName + -ResourceGroupName [-SubscriptionId ] -Request + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +### StopViaIdentityCloudAccountExpanded +``` +Stop-AzCommvaultProtectionGroupBackup -ProtectionGroupName + -CloudAccountInputObject -Reason [-Comment ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +### StopViaIdentityCloudAccount +``` +Stop-AzCommvaultProtectionGroupBackup -ProtectionGroupName + -CloudAccountInputObject -Request + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +### StopViaIdentityExpanded +``` +Stop-AzCommvaultProtectionGroupBackup -InputObject -Reason [-Comment ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +### StopViaIdentity +``` +Stop-AzCommvaultProtectionGroupBackup -InputObject + -Request [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Stop Backup for a Protection Group + +## EXAMPLES + +### Example 1: Stop the backups of a protection group +```powershell +Stop-AzCommvaultProtectionGroupBackup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -Reason 'Maintenance' -Comment 'Planned maintenance window' +``` + +Stops the scheduled backups of the protection group and records the reason and a comment. + +### Example 2: Stop the backups of a protection group by using a JSON request +```powershell +Stop-AzCommvaultProtectionGroupBackup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -ProtectionGroupName pg-prod-vms -JsonString '{"reason":"Maintenance","comment":"Planned maintenance window"}' +``` + +Stops the scheduled backups by passing the request body as a JSON string. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: StopViaIdentityCloudAccountExpanded, StopViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: StopExpanded, StopViaJsonString, StopViaJsonFilePath, Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +Any further comments + +```yaml +Type: System.String +Parameter Sets: StopExpanded, StopViaIdentityCloudAccountExpanded, StopViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: StopViaIdentityExpanded, StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Stop operation + +```yaml +Type: System.String +Parameter Sets: StopViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Stop operation + +```yaml +Type: System.String +Parameter Sets: StopViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionGroupName +Name of the ProtectionGroup resource + +```yaml +Type: System.String +Parameter Sets: StopExpanded, StopViaJsonString, StopViaJsonFilePath, Stop, StopViaIdentityCloudAccountExpanded, StopViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reason +The reason for stopping the backup + +```yaml +Type: System.String +Parameter Sets: StopExpanded, StopViaIdentityCloudAccountExpanded, StopViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Request +The properties of StopBackupProtectionGroupRequest + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IStopBackupProtectionGroupRequest +Parameter Sets: Stop, StopViaIdentityCloudAccount, StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: StopExpanded, StopViaJsonString, StopViaJsonFilePath, Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: StopExpanded, StopViaJsonString, StopViaJsonFilePath, Stop +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IStopBackupProtectionGroupRequest + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Sync-AzCommvaultStorage.md b/src/Commvault/Commvault/help/Sync-AzCommvaultStorage.md new file mode 100644 index 000000000000..60bed7f1f7c4 --- /dev/null +++ b/src/Commvault/Commvault/help/Sync-AzCommvaultStorage.md @@ -0,0 +1,202 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/sync-azcommvaultstorage +schema: 2.0.0 +--- + +# Sync-AzCommvaultStorage + +## SYNOPSIS +Refresh storage state from partner. +Fetches latest compliance lock status from Commvault and refresh the ARM resource. + +## SYNTAX + +### Refresh (Default) +``` +Sync-AzCommvaultStorage -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +### RefreshViaIdentityCloudAccount +``` +Sync-AzCommvaultStorage -Name -CloudAccountInputObject + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### RefreshViaIdentity +``` +Sync-AzCommvaultStorage -InputObject [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Refresh storage state from partner. +Fetches latest compliance lock status from Commvault and refresh the ARM resource. + +## EXAMPLES + +### Example 1: Refresh a storage +```powershell +Sync-AzCommvaultStorage -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name storage-hot +``` + +Refreshes the storage so that its properties, such as the compliance lock status, match the current state on the partner side. + +## PARAMETERS + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: RefreshViaIdentityCloudAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: Refresh +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: RefreshViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Storage resource + +```yaml +Type: System.String +Parameter Sets: Refresh, RefreshViaIdentityCloudAccount +Aliases: StorageName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Refresh +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Refresh +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IStorage + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Update-AzCommvaultCloudAccount.md b/src/Commvault/Commvault/help/Update-AzCommvaultCloudAccount.md new file mode 100644 index 000000000000..51199450de7c --- /dev/null +++ b/src/Commvault/Commvault/help/Update-AzCommvaultCloudAccount.md @@ -0,0 +1,577 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/update-azcommvaultcloudaccount +schema: 2.0.0 +--- + +# Update-AzCommvaultCloudAccount + +## SYNOPSIS +Update a CloudAccount + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzCommvaultCloudAccount -Name -ResourceGroupName [-SubscriptionId ] + [-CompanyCity ] [-CompanyCountry ] [-CompanyJobTitle ] [-CompanyName ] + [-CompanyPostalCode ] [-CompanyState ] [-CompanyStreet ] [-CompanyWebsite ] + [-EnableSystemAssignedIdentity ] [-MarketplaceSaasResourceId ] + [-MarketplaceSubscriptionId ] [-OfferDetailOfferId ] [-OfferDetailPlanId ] + [-OfferDetailPlanName ] [-OfferDetailPublisherId ] [-OfferDetailTermId ] + [-OfferDetailTermUnit ] [-Tag ] [-UserAssignedIdentity ] + [-UserEmailAddress ] [-UserFirstName ] [-UserLastName ] [-UserPhoneNumber ] + [-UserUpn ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzCommvaultCloudAccount -InputObject [-CompanyCity ] + [-CompanyCountry ] [-CompanyJobTitle ] [-CompanyName ] [-CompanyPostalCode ] + [-CompanyState ] [-CompanyStreet ] [-CompanyWebsite ] + [-EnableSystemAssignedIdentity ] [-MarketplaceSaasResourceId ] + [-MarketplaceSubscriptionId ] [-OfferDetailOfferId ] [-OfferDetailPlanId ] + [-OfferDetailPlanName ] [-OfferDetailPublisherId ] [-OfferDetailTermId ] + [-OfferDetailTermUnit ] [-Tag ] [-UserAssignedIdentity ] + [-UserEmailAddress ] [-UserFirstName ] [-UserLastName ] [-UserPhoneNumber ] + [-UserUpn ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Update a CloudAccount + +## EXAMPLES + +### Example 1: Update the tags of a cloud account +```powershell +Update-AzCommvaultCloudAccount -ResourceGroupName rg-commvault -Name cca-contoso -Tag @{ Environment = 'Production' } +``` + +Updates the tags of the cloud account. + +### Example 2: Update the company details of a cloud account +```powershell +Update-AzCommvaultCloudAccount -ResourceGroupName rg-commvault -Name cca-contoso -CompanyName 'Contoso' -CompanyJobTitle 'Backup Operator' -CompanyCity 'Redmond' -CompanyState 'WA' -CompanyCountry 'USA' -CompanyPostalCode '98052' +``` + +Updates the company details of the cloud account. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyCity +City of the company address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyCountry +Country of the company address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyJobTitle +Job title + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyName +Company name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyPostalCode +Postal code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyState +State or province of the company address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyStreet +Street address + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyWebsite +Company website + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MarketplaceSaasResourceId +Marketplace SaaS Resource Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketplaceSubscriptionId +Azure subscription id for the the marketplace offer is purchased from + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: CloudAccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailOfferId +Offer Id for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailPlanId +Plan Id for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailPlanName +Plan Name for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailPublisherId +Publisher Id for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailTermId +Plan Display Name for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailTermUnit +Plan Display Name for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserEmailAddress +Email address of the user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserFirstName +First name of the user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserLastName +Last name of the user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPhoneNumber +User's phone number + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserUpn +User's principal name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICloudAccount + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Update-AzCommvaultPlan.md b/src/Commvault/Commvault/help/Update-AzCommvaultPlan.md new file mode 100644 index 000000000000..f3ad7728caf8 --- /dev/null +++ b/src/Commvault/Commvault/help/Update-AzCommvaultPlan.md @@ -0,0 +1,271 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/update-azcommvaultplan +schema: 2.0.0 +--- + +# Update-AzCommvaultPlan + +## SYNOPSIS +Update a CommvaultPlan + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzCommvaultPlan -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-RetentionNumberOfSnapshot ] [-Schedule ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### UpdateViaIdentityCloudAccountExpanded +``` +Update-AzCommvaultPlan -Name -CloudAccountInputObject + [-RetentionNumberOfSnapshot ] [-Schedule ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzCommvaultPlan -InputObject [-RetentionNumberOfSnapshot ] + [-Schedule ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Update a CommvaultPlan + +## EXAMPLES + +### Example 1: Update the retention of a backup plan +```powershell +Update-AzCommvaultPlan -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name plan-daily -RetentionNumberOfSnapshot 14 +``` + +Changes the backup plan so that it keeps 14 snapshots. + +### Example 2: Update the schedule of a backup plan +```powershell +$schedule = @{ BackupType = 'INCREMENTAL'; Frequency = 'daily'; RunsEvery = 1; Time = '23:30'; TimeZone = 'UTC' } +Update-AzCommvaultPlan -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name plan-daily -Schedule $schedule +``` + +Changes the backup plan so that the daily incremental backup runs at 23:30 UTC. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: UpdateViaIdentityCloudAccountExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Plan resource + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityCloudAccountExpanded +Aliases: PlanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionNumberOfSnapshot +Number of Snapshots + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Schedule +The Commvault Plan Schedule + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ISchedule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultPlan + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Update-AzCommvaultProtectionGroup.md b/src/Commvault/Commvault/help/Update-AzCommvaultProtectionGroup.md new file mode 100644 index 000000000000..3531eb282e54 --- /dev/null +++ b/src/Commvault/Commvault/help/Update-AzCommvaultProtectionGroup.md @@ -0,0 +1,301 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/update-azcommvaultprotectiongroup +schema: 2.0.0 +--- + +# Update-AzCommvaultProtectionGroup + +## SYNOPSIS +Update a ProtectionGroup + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzCommvaultProtectionGroup -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-MatchRule ] [-MatchRuleMatchType ] [-Plan ] + [-ResourceManual ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityCloudAccountExpanded +``` +Update-AzCommvaultProtectionGroup -Name -CloudAccountInputObject + [-MatchRule ] [-MatchRuleMatchType ] [-Plan ] [-ResourceManual ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzCommvaultProtectionGroup -InputObject [-MatchRule ] + [-MatchRuleMatchType ] [-Plan ] [-ResourceManual ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Update a ProtectionGroup + +## EXAMPLES + +### Example 1: Change the backup plan of a protection group +```powershell +Update-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms -Plan plan-weekly +``` + +Changes the protection group to use the backup plan plan-weekly. + +### Example 2: Change the virtual machines of a protection group +```powershell +Update-AzCommvaultProtectionGroup -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name pg-prod-vms -ResourceManual '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-app/providers/Microsoft.Compute/virtualMachines/vm-app02' +``` + +Changes the protection group so that it protects the specified virtual machine. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: UpdateViaIdentityCloudAccountExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MatchRule +rules to match + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchRuleMatchType +match Type all or any + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the ProtectionGroup resource + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityCloudAccountExpanded +Aliases: ProtectionGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Plan +The Commvault Plan to be associated with the Protection Group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceManual +The items to be protected under Protection Group + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IProtectionGroup + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Update-AzCommvaultRoleMapping.md b/src/Commvault/Commvault/help/Update-AzCommvaultRoleMapping.md new file mode 100644 index 000000000000..6ec23162b2a4 --- /dev/null +++ b/src/Commvault/Commvault/help/Update-AzCommvaultRoleMapping.md @@ -0,0 +1,182 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/update-azcommvaultrolemapping +schema: 2.0.0 +--- + +# Update-AzCommvaultRoleMapping + +## SYNOPSIS +Update a RoleMapping + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzCommvaultRoleMapping -CloudAccountName -ResourceGroupName [-SubscriptionId ] + [-Role ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzCommvaultRoleMapping -InputObject [-Role ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Update a RoleMapping + +## EXAMPLES + +### Example 1: Update the role mapping of a cloud account +```powershell +$roles = @( + @{ RoleName = 'BackupOperator'; Entity = @(@{ Id = '11111111-2222-3333-4444-555555555555'; DisplayName = 'Commvault-Operators'; EntityType = 'Group' }) } +) +Update-AzCommvaultRoleMapping -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Role $roles +``` + +Updates the role mapping so that the BackupOperator role is assigned to the specified Microsoft Entra group. + +## PARAMETERS + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +The list of role assignments mapping roles to Entra entities (users and groups) + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRoleAssignment[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IRoleMapping + +## NOTES + +## RELATED LINKS diff --git a/src/Commvault/Commvault/help/Update-AzCommvaultStorage.md b/src/Commvault/Commvault/help/Update-AzCommvaultStorage.md new file mode 100644 index 000000000000..f11161cca3a1 --- /dev/null +++ b/src/Commvault/Commvault/help/Update-AzCommvaultStorage.md @@ -0,0 +1,247 @@ +--- +external help file: Az.Commvault-help.xml +Module Name: Az.Commvault +online version: https://learn.microsoft.com/powershell/module/az.commvault/update-azcommvaultstorage +schema: 2.0.0 +--- + +# Update-AzCommvaultStorage + +## SYNOPSIS +Update a Storage + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzCommvaultStorage -CloudAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-StorageClassType ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityCloudAccountExpanded +``` +Update-AzCommvaultStorage -Name -CloudAccountInputObject + [-StorageClassType ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzCommvaultStorage -InputObject [-StorageClassType ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Update a Storage + +## EXAMPLES + +### Example 1: Change the class of a storage +```powershell +Update-AzCommvaultStorage -ResourceGroupName rg-commvault -CloudAccountName cca-contoso -Name storage-hot -StorageClassType COLD +``` + +Changes the class of the storage to cold. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAccountInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: UpdateViaIdentityCloudAccountExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CloudAccountName +Name of the Cloud Account resource + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Storage resource + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityCloudAccountExpanded +Aliases: StorageName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageClassType +The class of Commvault Storage + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICommvaultIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.IStorage + +## NOTES + +## RELATED LINKS diff --git a/tools/CreateMappings_rules.json b/tools/CreateMappings_rules.json index d11431e5c86a..5856998d4628 100644 --- a/tools/CreateMappings_rules.json +++ b/tools/CreateMappings_rules.json @@ -1039,5 +1039,9 @@ { "module": "RedHatOpenShiftHcp", "alias": "RedHatOpenShiftHcp" + }, + { + "alias": "Commvault", + "module": "Commvault" } ] From c3cdf631f3bf9ca1a53ec80b9374224cf02e5e09 Mon Sep 17 00:00:00 2001 From: Saurabh Jaiswal Date: Tue, 27 Oct 2026 02:17:14 +0530 Subject: [PATCH 2/2] [Az.Commvault] Fix Test pipeline failure and address review comments - Remove the unexpanded Count parameter set of Get-AzCommvaultProtectedItemCount. A parameter set named Count makes ParameterSets.Count return the set instead of a number, which crashes the test coverage analysis and failed every Test job. - Move the initial release notes under Upcoming Release so the release tooling picks up the module. - Describe the protected item count as a total across the specified cloud accounts, matching the single count in the API response. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- src/Commvault/Commvault.Autorest/README.md | 9 +++++++ .../docs/Get-AzCommvaultProtectedItemCount.md | 25 +------------------ .../Get-AzCommvaultProtectedItemCount.md | 2 +- ...et-AzCommvaultProtectedItemCount.Tests.ps1 | 4 --- src/Commvault/Commvault/ChangeLog.md | 2 -- .../help/Get-AzCommvaultProtectedItemCount.md | 25 +------------------ 6 files changed, 12 insertions(+), 55 deletions(-) diff --git a/src/Commvault/Commvault.Autorest/README.md b/src/Commvault/Commvault.Autorest/README.md index fdd423f5b6db..a28b6f58c745 100644 --- a/src/Commvault/Commvault.Autorest/README.md +++ b/src/Commvault/Commvault.Autorest/README.md @@ -96,6 +96,15 @@ directive: set: verb: Get subject: ProtectedItemCount + # The body parameter set of this action is named exactly "Count". The test coverage analysis of the Azure PowerShell + # pipeline reads ParameterSets.Count of every parameter, which returns that parameter set instead of a number and + # fails every Test job. Remove the unexpanded set, as for the other cmdlets; -ResourceId, -JsonString and + # -JsonFilePath remain. + - where: + verb: Get + subject: ProtectedItemCount + variant: ^Count$ + remove: true # POST actions without a mapped verb are generated as Invoke-*. Use approved verbs that describe the action. - where: diff --git a/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultProtectedItemCount.md b/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultProtectedItemCount.md index ca26a921a5b0..067bc9dbb95b 100644 --- a/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultProtectedItemCount.md +++ b/src/Commvault/Commvault.Autorest/docs/Get-AzCommvaultProtectedItemCount.md @@ -17,12 +17,6 @@ Gets the count of protected items for provided CCA resource IDs across subscript Get-AzCommvaultProtectedItemCount -ResourceId [-DefaultProfile ] [] ``` -### Count -``` -Get-AzCommvaultProtectedItemCount -Body [-DefaultProfile ] - [] -``` - ### CountViaJsonFilePath ``` Get-AzCommvaultProtectedItemCount -JsonFilePath [-DefaultProfile ] [] @@ -43,7 +37,7 @@ Gets the count of protected items for provided CCA resource IDs across subscript Get-AzCommvaultProtectedItemCount -ResourceId '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Commvault.ContentStore/cloudAccounts/cca-contoso', '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Commvault.ContentStore/cloudAccounts/cca-fabrikam' ``` -Gets the number of protected items for each of the specified cloud accounts. +Gets the number of protected items across the specified cloud accounts. ### Example 2: Count the protected items by using a JSON request ```powershell @@ -54,21 +48,6 @@ Gets the number of protected items by passing the request body as a JSON string. ## PARAMETERS -### -Body -Request to count protected items for the provided CCA resource IDs across subscriptions. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICountProtectedItemsRequest -Parameter Sets: Count -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -DefaultProfile The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. @@ -135,8 +114,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICountProtectedItemsRequest - ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICountProtectedItemsResponse diff --git a/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultProtectedItemCount.md b/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultProtectedItemCount.md index 1380ab9380a8..c34d4f0a1256 100644 --- a/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultProtectedItemCount.md +++ b/src/Commvault/Commvault.Autorest/examples/Get-AzCommvaultProtectedItemCount.md @@ -3,7 +3,7 @@ Get-AzCommvaultProtectedItemCount -ResourceId '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Commvault.ContentStore/cloudAccounts/cca-contoso', '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Commvault.ContentStore/cloudAccounts/cca-fabrikam' ``` -Gets the number of protected items for each of the specified cloud accounts. +Gets the number of protected items across the specified cloud accounts. ### Example 2: Count the protected items by using a JSON request ```powershell diff --git a/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultProtectedItemCount.Tests.ps1 b/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultProtectedItemCount.Tests.ps1 index cb06fbe90444..4d750c1e96d4 100644 --- a/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultProtectedItemCount.Tests.ps1 +++ b/src/Commvault/Commvault.Autorest/test/Get-AzCommvaultProtectedItemCount.Tests.ps1 @@ -19,10 +19,6 @@ Describe 'Get-AzCommvaultProtectedItemCount' { { throw [System.NotImplementedException] } | Should -Not -Throw } - It 'Count' -skip { - { throw [System.NotImplementedException] } | Should -Not -Throw - } - It 'CountViaJsonFilePath' -skip { { throw [System.NotImplementedException] } | Should -Not -Throw } diff --git a/src/Commvault/Commvault/ChangeLog.md b/src/Commvault/Commvault/ChangeLog.md index d7fb5cc9dc72..ec97fb6a6028 100644 --- a/src/Commvault/Commvault/ChangeLog.md +++ b/src/Commvault/Commvault/ChangeLog.md @@ -18,8 +18,6 @@ - Additional information about change #1 --> ## Upcoming Release - -## Version 0.1.0 * First preview release for module Az.Commvault - Added cmdlets to manage Commvault cloud accounts: `New-AzCommvaultCloudAccount`, `Get-AzCommvaultCloudAccount`, `Update-AzCommvaultCloudAccount` and `Remove-AzCommvaultCloudAccount` - Added `Initialize-AzCommvaultSaaS`, `Connect-AzCommvaultCloudAccountSaaS` and `Get-AzCommvaultCloudAccountLatestLinkedSaaS` cmdlets to activate and link the Commvault SaaS diff --git a/src/Commvault/Commvault/help/Get-AzCommvaultProtectedItemCount.md b/src/Commvault/Commvault/help/Get-AzCommvaultProtectedItemCount.md index ce3925aeb6d3..f34fa6ac3fb3 100644 --- a/src/Commvault/Commvault/help/Get-AzCommvaultProtectedItemCount.md +++ b/src/Commvault/Commvault/help/Get-AzCommvaultProtectedItemCount.md @@ -18,12 +18,6 @@ Get-AzCommvaultProtectedItemCount -ResourceId [-DefaultProfile ] ``` -### Count -``` -Get-AzCommvaultProtectedItemCount -Body [-DefaultProfile ] - [] -``` - ### CountViaJsonFilePath ``` Get-AzCommvaultProtectedItemCount -JsonFilePath [-DefaultProfile ] @@ -46,7 +40,7 @@ Gets the count of protected items for provided CCA resource IDs across subscript Get-AzCommvaultProtectedItemCount -ResourceId '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Commvault.ContentStore/cloudAccounts/cca-contoso', '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-commvault/providers/Commvault.ContentStore/cloudAccounts/cca-fabrikam' ``` -Gets the number of protected items for each of the specified cloud accounts. +Gets the number of protected items across the specified cloud accounts. ### Example 2: Count the protected items by using a JSON request ```powershell @@ -57,21 +51,6 @@ Gets the number of protected items by passing the request body as a JSON string. ## PARAMETERS -### -Body -Request to count protected items for the provided CCA resource IDs across subscriptions. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICountProtectedItemsRequest -Parameter Sets: Count -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -DefaultProfile The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. @@ -138,8 +117,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICountProtectedItemsRequest - ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Commvault.Models.ICountProtectedItemsResponse