diff --git a/src/DataProtection/DataProtection.Autorest/README.md b/src/DataProtection/DataProtection.Autorest/README.md index 55834d66f670..3dde069a0d35 100644 --- a/src/DataProtection/DataProtection.Autorest/README.md +++ b/src/DataProtection/DataProtection.Autorest/README.md @@ -3,7 +3,6 @@ This directory contains the PowerShell module for the DataProtection service. --- - ## Info - Modifiable: yes - Generated: all diff --git a/src/DataProtection/DataProtection.Autorest/help/Edit-AzDataProtectionPolicyRetentionRuleClientObject.md b/src/DataProtection/DataProtection.Autorest/help/Edit-AzDataProtectionPolicyRetentionRuleClientObject.md index 0c921c96e168..4b3d08a0946e 100644 --- a/src/DataProtection/DataProtection.Autorest/help/Edit-AzDataProtectionPolicyRetentionRuleClientObject.md +++ b/src/DataProtection/DataProtection.Autorest/help/Edit-AzDataProtectionPolicyRetentionRuleClientObject.md @@ -111,7 +111,7 @@ Accept wildcard characters: False Specifies whether to modify an existing LifeCycle. ```yaml -Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: AddRetention Aliases: diff --git a/src/DataProtection/DataProtection.Autorest/help/New-AzDataProtectionBackupConfigurationClientObject.md b/src/DataProtection/DataProtection.Autorest/help/New-AzDataProtectionBackupConfigurationClientObject.md index 3741b47a7d9c..03d2548e1e3e 100644 --- a/src/DataProtection/DataProtection.Autorest/help/New-AzDataProtectionBackupConfigurationClientObject.md +++ b/src/DataProtection/DataProtection.Autorest/help/New-AzDataProtectionBackupConfigurationClientObject.md @@ -139,7 +139,7 @@ Boolean parameter to decide whether cluster scope resources are included for bac By default this is taken as true. ```yaml -Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -200,7 +200,7 @@ Boolean parameter to decide whether snapshot volumes are included for backup. By default this is taken as true. ```yaml -Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/src/DataProtection/DataProtection.Autorest/help/New-AzDataProtectionRestoreConfigurationClientObject.md b/src/DataProtection/DataProtection.Autorest/help/New-AzDataProtectionRestoreConfigurationClientObject.md index 17f98f611e4f..9ff4d9c33ea6 100644 --- a/src/DataProtection/DataProtection.Autorest/help/New-AzDataProtectionRestoreConfigurationClientObject.md +++ b/src/DataProtection/DataProtection.Autorest/help/New-AzDataProtectionRestoreConfigurationClientObject.md @@ -109,7 +109,7 @@ Boolean parameter to decide whether cluster scope resources are included for res By default this is taken as true. ```yaml -Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/src/DataProtection/DataProtection/Az.DataProtection.psd1 b/src/DataProtection/DataProtection/Az.DataProtection.psd1 index d1a6684a24b7..a36de8e730a3 100644 --- a/src/DataProtection/DataProtection/Az.DataProtection.psd1 +++ b/src/DataProtection/DataProtection/Az.DataProtection.psd1 @@ -3,7 +3,7 @@ # # Generated by: Microsoft Corporation # -# Generated on: 12/27/2023 +# Generated on: 3/17/2024 # @{ @@ -51,16 +51,16 @@ DotNetFrameworkVersion = '4.7.2' # ProcessorArchitecture = '' # Modules that must be imported into the global environment prior to importing this module -RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '2.15.0'; }) +RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '2.16.0'; }) # Assemblies that must be loaded prior to importing this module RequiredAssemblies = 'DataProtection.Autorest/bin/Az.DataProtection.private.dll' # Script files (.ps1) that are run in the caller's environment prior to importing this module. -# ScriptsToProcess = @() +ScriptsToProcess = @() # Type files (.ps1xml) to be loaded when importing this module -# TypesToProcess = @() +TypesToProcess = @() # Format files (.ps1xml) to be loaded when importing this module FormatsToProcess = 'DataProtection.Autorest/Az.DataProtection.format.ps1xml' @@ -143,7 +143,7 @@ PrivateData = @{ PSData = @{ # Tags applied to this module. These help with module discovery in online galleries. - Tags = 'Azure','ResourceManager','ARM','PSModule','DataProtection' + Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'DataProtection' # A URL to the license for this module. LicenseUri = 'https://aka.ms/azps-license' @@ -168,7 +168,7 @@ PrivateData = @{ } # End of PSData hashtable - } # End of PrivateData hashtable +} # End of PrivateData hashtable # HelpInfo URI of this module # HelpInfoURI = '' diff --git a/src/DataProtection/DataProtection/help/Az.DataProtection.md b/src/DataProtection/DataProtection/help/Az.DataProtection.md index 0baba0d714dc..30ed576a240a 100644 --- a/src/DataProtection/DataProtection/help/Az.DataProtection.md +++ b/src/DataProtection/DataProtection/help/Az.DataProtection.md @@ -36,7 +36,7 @@ Gets a backup policy belonging to a backup vault Returns resource collection belonging to a subscription. ### [Get-AzDataProtectionJob](Get-AzDataProtectionJob.md) -Gets a job with id in a backup vault +Gets or lists jobs in a backup vault ### [Get-AzDataProtectionOperation](Get-AzDataProtectionOperation.md) Returns the list of available operations. @@ -116,6 +116,9 @@ This operation will resume protection for a stopped backup instance ### [Search-AzDataProtectionBackupInstanceInAzGraph](Search-AzDataProtectionBackupInstanceInAzGraph.md) Searches for Backup instances in Azure Resource Graph and retrieves the expected entries +### [Search-AzDataProtectionBackupVaultInAzGraph](Search-AzDataProtectionBackupVaultInAzGraph.md) +Searches for Backup vaults in Azure Resource Graph and retrieves the expected entries + ### [Search-AzDataProtectionJobInAzGraph](Search-AzDataProtectionJobInAzGraph.md) Searches for Backup Jobs in Azure Resource Graph and retrieves the expected entries diff --git a/src/DataProtection/DataProtection/help/Backup-AzDataProtectionBackupInstanceAdhoc.md b/src/DataProtection/DataProtection/help/Backup-AzDataProtectionBackupInstanceAdhoc.md index d8dbb840fafa..aaaf53e6c564 100644 --- a/src/DataProtection/DataProtection/help/Backup-AzDataProtectionBackupInstanceAdhoc.md +++ b/src/DataProtection/DataProtection/help/Backup-AzDataProtectionBackupInstanceAdhoc.md @@ -16,15 +16,15 @@ Trigger adhoc backup ``` Backup-AzDataProtectionBackupInstanceAdhoc -BackupInstanceName -ResourceGroupName [-SubscriptionId ] -VaultName -BackupRuleOptionRuleName - [-TriggerOptionRetentionTagOverride ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] - [-Confirm] [] + [-TriggerOptionRetentionTagOverride ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### BackupViaIdentityExpanded ``` Backup-AzDataProtectionBackupInstanceAdhoc -InputObject -BackupRuleOptionRuleName [-TriggerOptionRetentionTagOverride ] [-DefaultProfile ] - [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -152,6 +152,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -254,30 +269,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IOperationJobExtendedInfo +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IOperationJobExtendedInfo ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[BackupInstanceName ]`: The name of the backup instance. - - `[BackupPolicyName ]`: - - `[Id ]`: Resource identity path - - `[JobId ]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). - - `[Location ]`: The location in which uniqueness will be verified. - - `[OperationId ]`: - - `[RecoveryPointId ]`: - - `[RequestName ]`: - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceGuardProxyName ]`: name of the resource guard proxy - - `[ResourceGuardsName ]`: The name of ResourceGuard - - `[SubscriptionId ]`: The ID of the target subscription. The value must be an UUID. - - `[VaultName ]`: The name of the backup vault. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Edit-AzDataProtectionPolicyRetentionRuleClientObject.md b/src/DataProtection/DataProtection/help/Edit-AzDataProtectionPolicyRetentionRuleClientObject.md index 120c0b632cbf..32d2fc1183df 100644 --- a/src/DataProtection/DataProtection/help/Edit-AzDataProtectionPolicyRetentionRuleClientObject.md +++ b/src/DataProtection/DataProtection/help/Edit-AzDataProtectionPolicyRetentionRuleClientObject.md @@ -15,13 +15,14 @@ Adds or removes Retention Rule to existing Policy ### RemoveRetention (Default) ``` Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy -Name - [-RemoveRule] [] + [-RemoveRule] [-ProgressAction ] [] ``` ### AddRetention ``` Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy -Name - -IsDefault -LifeCycles [-OverwriteLifeCycle ] [] + -IsDefault -LifeCycles [-OverwriteLifeCycle ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -139,6 +140,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RemoveRule Specifies whether to remove the retention rule. @@ -161,46 +177,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IBackupPolicy +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IBackupPolicy ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`LIFECYCLES `: Life cycles associated with the retention rule. - - `DeleteAfterDuration `: Duration of deletion after given timespan - - `DeleteAfterObjectType `: Type of the specific object - used for deserializing - - `SourceDataStoreObjectType `: Type of Datasource object, used to initialize the right inherited type - - `SourceDataStoreType `: type of datastore; Operational/Vault/Archive - - `[TargetDataStoreCopySetting ]`: - - `CopyAfterObjectType `: Type of the specific object - used for deserializing - - `DataStoreObjectType `: Type of Datasource object, used to initialize the right inherited type - - `DataStoreType `: type of datastore; Operational/Vault/Archive - -`POLICY `: Backup Policy Object - - `DatasourceType `: Type of datasource for the backup management - - `ObjectType `: - - `PolicyRule `: Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc - - `Name `: - - `ObjectType `: - - `DataStoreObjectType `: Type of Datasource object, used to initialize the right inherited type - - `DataStoreType `: type of datastore; Operational/Vault/Archive - - `TriggerObjectType `: Type of the specific object - used for deserializing - - `Lifecycle `: - - `DeleteAfterDuration `: Duration of deletion after given timespan - - `DeleteAfterObjectType `: Type of the specific object - used for deserializing - - `SourceDataStoreObjectType `: Type of Datasource object, used to initialize the right inherited type - - `SourceDataStoreType `: type of datastore; Operational/Vault/Archive - - `[TargetDataStoreCopySetting ]`: - - `CopyAfterObjectType `: Type of the specific object - used for deserializing - - `DataStoreObjectType `: Type of Datasource object, used to initialize the right inherited type - - `DataStoreType `: type of datastore; Operational/Vault/Archive - - `[BackupParameterObjectType ]`: Type of the specific object - used for deserializing - - `[IsDefault ]`: - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Edit-AzDataProtectionPolicyTagClientObject.md b/src/DataProtection/DataProtection/help/Edit-AzDataProtectionPolicyTagClientObject.md index 7b230c475015..c20aa6a7519f 100644 --- a/src/DataProtection/DataProtection/help/Edit-AzDataProtectionPolicyTagClientObject.md +++ b/src/DataProtection/DataProtection/help/Edit-AzDataProtectionPolicyTagClientObject.md @@ -15,13 +15,13 @@ Adds or removes schedule tag in an existing backup policy. ### RemoveTag (Default) ``` Edit-AzDataProtectionPolicyTagClientObject -Policy -Name [-RemoveRule] - [] + [-ProgressAction ] [] ``` ### updateTag ``` Edit-AzDataProtectionPolicyTagClientObject -Policy -Name - -Criteria [] + -Criteria [-ProgressAction ] [] ``` ## DESCRIPTION @@ -106,6 +106,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RemoveRule Specify whether to remove the tag from the given policy object. @@ -128,47 +143,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IBackupPolicy +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IBackupPolicy ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`CRITERIA `: Criterias to be associated with the schedule tag. - - `ObjectType `: Type of the specific object - used for deserializing - - `[AbsoluteCriterion ]`: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" and should be part of AbsoluteMarker enum - - `[DaysOfMonth ]`: This is day of the month from 1 to 28 other wise last of month - - `[Date ]`: Date of the month - - `[IsLast ]`: Whether Date is last date of month - - `[DaysOfTheWeek ]`: It should be Sunday/Monday/T..../Saturday - - `[MonthsOfYear ]`: It should be January/February/....../December - - `[ScheduleTime ]`: List of schedule times for backup - - `[WeeksOfTheMonth ]`: It should be First/Second/Third/Fourth/Last - -`POLICY `: Backup Policy Object. - - `DatasourceType `: Type of datasource for the backup management - - `ObjectType `: - - `PolicyRule `: Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc - - `Name `: - - `ObjectType `: - - `DataStoreObjectType `: Type of Datasource object, used to initialize the right inherited type - - `DataStoreType `: type of datastore; Operational/Vault/Archive - - `TriggerObjectType `: Type of the specific object - used for deserializing - - `Lifecycle `: - - `DeleteAfterDuration `: Duration of deletion after given timespan - - `DeleteAfterObjectType `: Type of the specific object - used for deserializing - - `SourceDataStoreObjectType `: Type of Datasource object, used to initialize the right inherited type - - `SourceDataStoreType `: type of datastore; Operational/Vault/Archive - - `[TargetDataStoreCopySetting ]`: - - `CopyAfterObjectType `: Type of the specific object - used for deserializing - - `DataStoreObjectType `: Type of Datasource object, used to initialize the right inherited type - - `DataStoreType `: type of datastore; Operational/Vault/Archive - - `[BackupParameterObjectType ]`: Type of the specific object - used for deserializing - - `[IsDefault ]`: - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Edit-AzDataProtectionPolicyTriggerClientObject.md b/src/DataProtection/DataProtection/help/Edit-AzDataProtectionPolicyTriggerClientObject.md index 3e201c300424..b6a639394680 100644 --- a/src/DataProtection/DataProtection/help/Edit-AzDataProtectionPolicyTriggerClientObject.md +++ b/src/DataProtection/DataProtection/help/Edit-AzDataProtectionPolicyTriggerClientObject.md @@ -14,13 +14,14 @@ Updates Backup schedule of an existing backup policy. ### RemoveBackupSchedule (Default) ``` -Edit-AzDataProtectionPolicyTriggerClientObject -Policy [-RemoveSchedule] [] +Edit-AzDataProtectionPolicyTriggerClientObject -Policy [-RemoveSchedule] + [-ProgressAction ] [] ``` ### ModifyBackupSchedule ``` Edit-AzDataProtectionPolicyTriggerClientObject -Policy -Schedule - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -60,6 +61,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RemoveSchedule Specifies whether to remove the backup Schedule. @@ -97,36 +113,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IBackupPolicy +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IBackupPolicy ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`POLICY `: Backup Policy object. - - `DatasourceType `: Type of datasource for the backup management - - `ObjectType `: - - `PolicyRule `: Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc - - `Name `: - - `ObjectType `: - - `DataStoreObjectType `: Type of Datasource object, used to initialize the right inherited type - - `DataStoreType `: type of datastore; Operational/Vault/Archive - - `TriggerObjectType `: Type of the specific object - used for deserializing - - `Lifecycle `: - - `DeleteAfterDuration `: Duration of deletion after given timespan - - `DeleteAfterObjectType `: Type of the specific object - used for deserializing - - `SourceDataStoreObjectType `: Type of Datasource object, used to initialize the right inherited type - - `SourceDataStoreType `: type of datastore; Operational/Vault/Archive - - `[TargetDataStoreCopySetting ]`: - - `CopyAfterObjectType `: Type of the specific object - used for deserializing - - `DataStoreObjectType `: Type of Datasource object, used to initialize the right inherited type - - `DataStoreType `: type of datastore; Operational/Vault/Archive - - `[BackupParameterObjectType ]`: Type of the specific object - used for deserializing - - `[IsDefault ]`: - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Find-AzDataProtectionRestorableTimeRange.md b/src/DataProtection/DataProtection/help/Find-AzDataProtectionRestorableTimeRange.md index ea783a2002c2..3e760f6c4065 100644 --- a/src/DataProtection/DataProtection/help/Find-AzDataProtectionRestorableTimeRange.md +++ b/src/DataProtection/DataProtection/help/Find-AzDataProtectionRestorableTimeRange.md @@ -15,8 +15,8 @@ Finds the valid recovery point in time ranges for the restore. ``` Find-AzDataProtectionRestorableTimeRange -BackupInstanceName -ResourceGroupName -VaultName [-SubscriptionId ] -SourceDataStoreType - [-EndTime ] [-StartTime ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + [-EndTime ] [-StartTime ] [-DefaultProfile ] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -93,6 +93,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -209,10 +224,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IAzureBackupFindRestorableTimeRangesResponseResource +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IAzureBackupFindRestorableTimeRangesResponseResource ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Get-AzDataProtectionBackupInstance.md b/src/DataProtection/DataProtection/help/Get-AzDataProtectionBackupInstance.md index 7a300852d04d..357a4445c624 100644 --- a/src/DataProtection/DataProtection/help/Get-AzDataProtectionBackupInstance.md +++ b/src/DataProtection/DataProtection/help/Get-AzDataProtectionBackupInstance.md @@ -15,19 +15,19 @@ Gets a backup instance with name in a backup vault ### List (Default) ``` Get-AzDataProtectionBackupInstance -ResourceGroupName [-SubscriptionId ] -VaultName - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzDataProtectionBackupInstance -Name -ResourceGroupName [-SubscriptionId ] - -VaultName [-DefaultProfile ] [] + -VaultName [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentity ``` Get-AzDataProtectionBackupInstance -InputObject [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -111,6 +111,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -167,30 +182,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IBackupInstanceResource +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IBackupInstanceResource ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[BackupInstanceName ]`: The name of the backup instance. - - `[BackupPolicyName ]`: - - `[Id ]`: Resource identity path - - `[JobId ]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). - - `[Location ]`: The location in which uniqueness will be verified. - - `[OperationId ]`: - - `[RecoveryPointId ]`: - - `[RequestName ]`: - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceGuardProxyName ]`: name of the resource guard proxy - - `[ResourceGuardsName ]`: The name of ResourceGuard - - `[SubscriptionId ]`: The ID of the target subscription. The value must be an UUID. - - `[VaultName ]`: The name of the backup vault. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Get-AzDataProtectionBackupPolicy.md b/src/DataProtection/DataProtection/help/Get-AzDataProtectionBackupPolicy.md index 9f81b1666915..4bfa305713ae 100644 --- a/src/DataProtection/DataProtection/help/Get-AzDataProtectionBackupPolicy.md +++ b/src/DataProtection/DataProtection/help/Get-AzDataProtectionBackupPolicy.md @@ -15,19 +15,19 @@ Gets a backup policy belonging to a backup vault ### List (Default) ``` Get-AzDataProtectionBackupPolicy -ResourceGroupName [-SubscriptionId ] -VaultName - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzDataProtectionBackupPolicy -Name -ResourceGroupName [-SubscriptionId ] - -VaultName [-DefaultProfile ] [] + -VaultName [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentity ``` Get-AzDataProtectionBackupPolicy -InputObject [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -111,6 +111,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -167,30 +182,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IBaseBackupPolicyResource +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IBaseBackupPolicyResource ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[BackupInstanceName ]`: The name of the backup instance. - - `[BackupPolicyName ]`: - - `[Id ]`: Resource identity path - - `[JobId ]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). - - `[Location ]`: The location in which uniqueness will be verified. - - `[OperationId ]`: - - `[RecoveryPointId ]`: - - `[RequestName ]`: - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceGuardProxyName ]`: name of the resource guard proxy - - `[ResourceGuardsName ]`: The name of ResourceGuard - - `[SubscriptionId ]`: The ID of the target subscription. The value must be an UUID. - - `[VaultName ]`: The name of the backup vault. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Get-AzDataProtectionBackupVault.md b/src/DataProtection/DataProtection/help/Get-AzDataProtectionBackupVault.md index 2a8c695dd3fc..13a9f9e5a1c7 100644 --- a/src/DataProtection/DataProtection/help/Get-AzDataProtectionBackupVault.md +++ b/src/DataProtection/DataProtection/help/Get-AzDataProtectionBackupVault.md @@ -14,25 +14,26 @@ Returns resource collection belonging to a subscription. ### Get (Default) ``` -Get-AzDataProtectionBackupVault [-SubscriptionId ] [-DefaultProfile ] [] +Get-AzDataProtectionBackupVault [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [] ``` ### Get2 ``` Get-AzDataProtectionBackupVault [-SubscriptionId ] -ResourceGroupName -VaultName - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get1 ``` Get-AzDataProtectionBackupVault [-SubscriptionId ] -ResourceGroupName - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentity ``` Get-AzDataProtectionBackupVault -InputObject [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -130,6 +131,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -186,30 +202,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IBackupVaultResource +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IBackupVaultResource ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[BackupInstanceName ]`: The name of the backup instance. - - `[BackupPolicyName ]`: - - `[Id ]`: Resource identity path - - `[JobId ]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). - - `[Location ]`: The location in which uniqueness will be verified. - - `[OperationId ]`: - - `[RecoveryPointId ]`: - - `[RequestName ]`: - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceGuardProxyName ]`: name of the resource guard proxy - - `[ResourceGuardsName ]`: The name of ResourceGuard - - `[SubscriptionId ]`: The ID of the target subscription. The value must be an UUID. - - `[VaultName ]`: The name of the backup vault. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Get-AzDataProtectionJob.md b/src/DataProtection/DataProtection/help/Get-AzDataProtectionJob.md index ef99d9f5eee1..3f7f773bd838 100644 --- a/src/DataProtection/DataProtection/help/Get-AzDataProtectionJob.md +++ b/src/DataProtection/DataProtection/help/Get-AzDataProtectionJob.md @@ -8,30 +8,31 @@ schema: 2.0.0 # Get-AzDataProtectionJob ## SYNOPSIS -Gets a job with id in a backup vault +Gets or lists jobs in a backup vault ## SYNTAX ### List (Default) ``` Get-AzDataProtectionJob -ResourceGroupName -VaultName [-SubscriptionId ] - [-UseSecondaryRegion] [-DefaultProfile ] [] + [-UseSecondaryRegion] [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzDataProtectionJob -ResourceGroupName -VaultName [-SubscriptionId ] - [-UseSecondaryRegion] [-DefaultProfile ] -Id [] + [-UseSecondaryRegion] [-DefaultProfile ] -Id [-ProgressAction ] + [] ``` ### GetViaIdentity ``` Get-AzDataProtectionJob [-DefaultProfile ] -InputObject - [] + [-ProgressAction ] [] ``` ## DESCRIPTION -Gets a job with id in a backup vault +Gets or lists jobs in a backup vault ## EXAMPLES @@ -53,7 +54,7 @@ a6a4879d-f914-4174-b129-0e27da8a4fb0 Microsoft.DataProtection/backupVaults/backu This command gets all the backup jobs in a given backup vault. -### Example 2: Get a single Job +### Example 2: Get a single Job with Id ```powershell Get-AzDataProtectionJob -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName sarath-rg -VaultName sarath-vault -Id 4abaea8c-f53a-4bb1-9963-59f96b597165 ``` @@ -66,11 +67,23 @@ Name Type This command returns a single job entity with given Id. +### Example 3: Get backup Jobs in a backup vault from secondary region +```powershell +Get-AzDataProtectionJob -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName sarath-rg -VaultName sarath-vault -UseSecondaryRegion +``` + +```output +Name Type +---- ---- +a6a4879d-f914-4174-b129-0e27da8a4fb0 Microsoft.DataProtection/backupVaults/backupJobs +1a402664-a245-4a9d-8bb5-a6bafbb40d26 Microsoft.DataProtection/backupVaults/backupJobs +``` + +This command gets cross region restore jobs in a backup vault from secondary region. + ## 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 @@ -85,9 +98,7 @@ Accept wildcard characters: False ``` ### -Id -The Job ID. -This is a GUID-formatted string (e.g. -00000000-0000-0000-0000-000000000000). +Job ID to get a particular Job ```yaml Type: System.String @@ -117,9 +128,23 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. +Resource Group of the backup vault ```yaml Type: System.String @@ -134,8 +159,7 @@ Accept wildcard characters: False ``` ### -SubscriptionId -The ID of the target subscription. -The value must be an UUID. +Subscription Id of the vault ```yaml Type: System.String[] @@ -144,7 +168,7 @@ Aliases: Required: False Position: Named -Default value: (Get-AzContext).Subscription.Id +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -159,13 +183,13 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -VaultName -The name of the backup vault. +Name of the backup vault ```yaml Type: System.String @@ -188,30 +212,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IAzureBackupJobResource +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IAzureBackupJobResource ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[BackupInstanceName ]`: The name of the backup instance. - - `[BackupPolicyName ]`: - - `[Id ]`: Resource identity path - - `[JobId ]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). - - `[Location ]`: The location in which uniqueness will be verified. - - `[OperationId ]`: - - `[RecoveryPointId ]`: - - `[RequestName ]`: - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceGuardProxyName ]`: name of the resource guard proxy - - `[ResourceGuardsName ]`: The name of ResourceGuard - - `[SubscriptionId ]`: The ID of the target subscription. The value must be an UUID. - - `[VaultName ]`: The name of the backup vault. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Get-AzDataProtectionOperation.md b/src/DataProtection/DataProtection/help/Get-AzDataProtectionOperation.md index 5008138057b0..3defb2cb769e 100644 --- a/src/DataProtection/DataProtection/help/Get-AzDataProtectionOperation.md +++ b/src/DataProtection/DataProtection/help/Get-AzDataProtectionOperation.md @@ -13,7 +13,8 @@ Returns the list of available operations. ## SYNTAX ``` -Get-AzDataProtectionOperation [-DefaultProfile ] [] +Get-AzDataProtectionOperation [-DefaultProfile ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -103,6 +104,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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). @@ -110,10 +126,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IClientDiscoveryValueForSingleApi +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IClientDiscoveryValueForSingleApi ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Get-AzDataProtectionOperationStatus.md b/src/DataProtection/DataProtection/help/Get-AzDataProtectionOperationStatus.md index c05765e8b9e1..fe7cc52a4b51 100644 --- a/src/DataProtection/DataProtection/help/Get-AzDataProtectionOperationStatus.md +++ b/src/DataProtection/DataProtection/help/Get-AzDataProtectionOperationStatus.md @@ -15,13 +15,13 @@ Gets the operation status for a resource. ### Get (Default) ``` Get-AzDataProtectionOperationStatus -Location -OperationId [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentity ``` Get-AzDataProtectionOperationStatus -InputObject [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -115,6 +115,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -140,30 +155,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IOperationResource +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IOperationResource ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[BackupInstanceName ]`: The name of the backup instance. - - `[BackupPolicyName ]`: - - `[Id ]`: Resource identity path - - `[JobId ]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). - - `[Location ]`: The location in which uniqueness will be verified. - - `[OperationId ]`: - - `[RecoveryPointId ]`: - - `[RequestName ]`: - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceGuardProxyName ]`: name of the resource guard proxy - - `[ResourceGuardsName ]`: The name of ResourceGuard - - `[SubscriptionId ]`: The ID of the target subscription. The value must be an UUID. - - `[VaultName ]`: The name of the backup vault. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Get-AzDataProtectionPolicyTemplate.md b/src/DataProtection/DataProtection/help/Get-AzDataProtectionPolicyTemplate.md index 951a8215b9da..afd447ff0a69 100644 --- a/src/DataProtection/DataProtection/help/Get-AzDataProtectionPolicyTemplate.md +++ b/src/DataProtection/DataProtection/help/Get-AzDataProtectionPolicyTemplate.md @@ -13,7 +13,8 @@ Gets default policy template for a selected datasource type. ## SYNTAX ``` -Get-AzDataProtectionPolicyTemplate -DatasourceType [] +Get-AzDataProtectionPolicyTemplate -DatasourceType [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -53,6 +54,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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). @@ -60,10 +76,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IBackupPolicy +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IBackupPolicy ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Get-AzDataProtectionRecoveryPoint.md b/src/DataProtection/DataProtection/help/Get-AzDataProtectionRecoveryPoint.md index 9d573f198547..fe631036b1f1 100644 --- a/src/DataProtection/DataProtection/help/Get-AzDataProtectionRecoveryPoint.md +++ b/src/DataProtection/DataProtection/help/Get-AzDataProtectionRecoveryPoint.md @@ -16,19 +16,20 @@ Gets a Recovery Point using recoveryPointId for a Datasource. ``` Get-AzDataProtectionRecoveryPoint [-BackupInstanceName ] [-ResourceGroupName ] [-SubscriptionId ] [-VaultName ] [-DefaultProfile ] [-StartTime ] - [-EndTime ] [-UseSecondaryRegion] [] + [-EndTime ] [-UseSecondaryRegion] [-ProgressAction ] [] ``` ### Get ``` Get-AzDataProtectionRecoveryPoint -BackupInstanceName -Id -ResourceGroupName - [-SubscriptionId ] -VaultName [-DefaultProfile ] [] + [-SubscriptionId ] -VaultName [-DefaultProfile ] + [-ProgressAction ] [] ``` ### GetViaIdentity ``` Get-AzDataProtectionRecoveryPoint -InputObject [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -69,6 +70,23 @@ Name Type This command returns a recovery point with given id. +### Example 3: Get all recovery points of a given backup instance from secondary region +```powershell +$instance = $instance = Search-AzDataProtectionBackupInstanceInAzGraph -DatasourceType AzureDatabaseForPostgreSQL -Subscription "xxxxxxxx-xxxx-xxxxxxxxxxxx" -ResourceGroup sarath-rg -Vault sarath-vault +$recoveryPoints = Get-AzDataProtectionRecoveryPoint -SubscriptionId "xxxxxxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName sarath-rg -VaultName sarath-vault -BackupInstanceName $instance[2].Name -UseSecondaryRegion +``` + +```output +Name +---- +aded40a562134f97b732f30d0b486fef +aecc362b85484f4eb905bb05ef445e3e +dc814d61a9624c36a1f9d635bc0b80f0 +``` + +This command lists all recovery points of a given backup instance from secondary region. +One of these recovery points can be used to trigger cross region restore to secondary region. + ## PARAMETERS ### -BackupInstanceName @@ -160,6 +178,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -229,7 +262,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -270,32 +303,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IAzureBackupRecoveryPointResource +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IAzureBackupRecoveryPointResource ### System.Management.Automation.PSObject ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[BackupInstanceName ]`: The name of the backup instance. - - `[BackupPolicyName ]`: - - `[Id ]`: Resource identity path - - `[JobId ]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). - - `[Location ]`: The location in which uniqueness will be verified. - - `[OperationId ]`: - - `[RecoveryPointId ]`: - - `[RequestName ]`: - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceGuardProxyName ]`: name of the resource guard proxy - - `[ResourceGuardsName ]`: The name of ResourceGuard - - `[SubscriptionId ]`: The ID of the target subscription. The value must be an UUID. - - `[VaultName ]`: The name of the backup vault. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Get-AzDataProtectionResourceGuard.md b/src/DataProtection/DataProtection/help/Get-AzDataProtectionResourceGuard.md index 54a0a2ce99cd..29e91df053fe 100644 --- a/src/DataProtection/DataProtection/help/Get-AzDataProtectionResourceGuard.md +++ b/src/DataProtection/DataProtection/help/Get-AzDataProtectionResourceGuard.md @@ -15,19 +15,19 @@ Returns a ResourceGuard belonging to a resource group. ### Get1 (Default) ``` Get-AzDataProtectionResourceGuard -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzDataProtectionResourceGuard -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentity ``` Get-AzDataProtectionResourceGuard -InputObject [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -113,6 +113,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -154,30 +169,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IResourceGuardResource +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IResourceGuardResource ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[BackupInstanceName ]`: The name of the backup instance. - - `[BackupPolicyName ]`: - - `[Id ]`: Resource identity path - - `[JobId ]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). - - `[Location ]`: The location in which uniqueness will be verified. - - `[OperationId ]`: - - `[RecoveryPointId ]`: - - `[RequestName ]`: - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceGuardProxyName ]`: name of the resource guard proxy - - `[ResourceGuardsName ]`: The name of ResourceGuard - - `[SubscriptionId ]`: The ID of the target subscription. The value must be an UUID. - - `[VaultName ]`: The name of the backup vault. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Get-AzDataProtectionResourceGuardMapping.md b/src/DataProtection/DataProtection/help/Get-AzDataProtectionResourceGuardMapping.md index 24f3b051b4fc..f430dc656f60 100644 --- a/src/DataProtection/DataProtection/help/Get-AzDataProtectionResourceGuardMapping.md +++ b/src/DataProtection/DataProtection/help/Get-AzDataProtectionResourceGuardMapping.md @@ -15,19 +15,19 @@ Returns the ResourceGuardProxy object associated with the vault, and that matche ### Get (Default) ``` Get-AzDataProtectionResourceGuardMapping -ResourceGroupName [-SubscriptionId ] - -VaultName [-DefaultProfile ] [] + -VaultName [-DefaultProfile ] [-ProgressAction ] [] ``` ### List ``` Get-AzDataProtectionResourceGuardMapping -ResourceGroupName [-SubscriptionId ] - -VaultName [-DefaultProfile ] [] + -VaultName [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentity ``` Get-AzDataProtectionResourceGuardMapping -InputObject [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -49,8 +49,8 @@ LastUpdatedTime : 2023-08-29T07:23:05.1111730Z Name : DppResourceGuardProxy ResourceGuardId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/hiaga-rg/providers/Microsoft.DataProtection/resourceGuard s/mua-pstest-resguard -ResourceGuardOperationDetail : {Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.ResourceGuardOperationDetail, - Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.ResourceGuardOperationDetail} +ResourceGuardOperationDetail : {Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.ResourceGuardOperationDetail, + Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.ResourceGuardOperationDetail} SystemData : Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api40.SystemData Type : Microsoft.DataProtection/vaults/backupResourceGuardProxies ``` @@ -92,6 +92,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -148,30 +163,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IResourceGuardProxyBaseResource +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IResourceGuardProxyBaseResource ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[BackupInstanceName ]`: The name of the backup instance. - - `[BackupPolicyName ]`: - - `[Id ]`: Resource identity path - - `[JobId ]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). - - `[Location ]`: The location in which uniqueness will be verified. - - `[OperationId ]`: - - `[RecoveryPointId ]`: - - `[RequestName ]`: - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceGuardProxyName ]`: name of the resource guard proxy - - `[ResourceGuardsName ]`: The name of ResourceGuard - - `[SubscriptionId ]`: The ID of the target subscription. The value must be an UUID. - - `[VaultName ]`: The name of the backup vault. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Get-AzDataProtectionSoftDeletedBackupInstance.md b/src/DataProtection/DataProtection/help/Get-AzDataProtectionSoftDeletedBackupInstance.md index 1eaa4503a5fc..78e02bd49a12 100644 --- a/src/DataProtection/DataProtection/help/Get-AzDataProtectionSoftDeletedBackupInstance.md +++ b/src/DataProtection/DataProtection/help/Get-AzDataProtectionSoftDeletedBackupInstance.md @@ -15,19 +15,20 @@ Gets a deleted backup instance with name in a backup vault ### List (Default) ``` Get-AzDataProtectionSoftDeletedBackupInstance -ResourceGroupName [-SubscriptionId ] - -VaultName [-DefaultProfile ] [] + -VaultName [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzDataProtectionSoftDeletedBackupInstance -BackupInstanceName -ResourceGroupName - [-SubscriptionId ] -VaultName [-DefaultProfile ] [] + [-SubscriptionId ] -VaultName [-DefaultProfile ] + [-ProgressAction ] [] ``` ### GetViaIdentity ``` Get-AzDataProtectionSoftDeletedBackupInstance -InputObject - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -97,6 +98,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -153,30 +169,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IDeletedBackupInstanceResource +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IDeletedBackupInstanceResource ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[BackupInstanceName ]`: The name of the backup instance. - - `[BackupPolicyName ]`: - - `[Id ]`: Resource identity path - - `[JobId ]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). - - `[Location ]`: The location in which uniqueness will be verified. - - `[OperationId ]`: - - `[RecoveryPointId ]`: - - `[RequestName ]`: - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceGuardProxyName ]`: name of the resource guard proxy - - `[ResourceGuardsName ]`: The name of ResourceGuard - - `[SubscriptionId ]`: The ID of the target subscription. The value must be an UUID. - - `[VaultName ]`: The name of the backup vault. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Initialize-AzDataProtectionBackupInstance.md b/src/DataProtection/DataProtection/help/Initialize-AzDataProtectionBackupInstance.md index e5e4fa43eba1..fc8c88706cd7 100644 --- a/src/DataProtection/DataProtection/help/Initialize-AzDataProtectionBackupInstance.md +++ b/src/DataProtection/DataProtection/help/Initialize-AzDataProtectionBackupInstance.md @@ -16,7 +16,7 @@ Initializes Backup instance Request object for configuring backup Initialize-AzDataProtectionBackupInstance -DatasourceType -DatasourceLocation [-PolicyId ] [-DatasourceId ] [-SecretStoreURI ] [-SecretStoreType ] [-SnapshotResourceGroupId ] [-FriendlyName ] - [-BackupConfiguration ] [] + [-BackupConfiguration ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -163,6 +163,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SecretStoreType Secret store type for secret store authentication of data source. This parameter is only supported for AzureDatabaseForPostgreSQL currently. @@ -218,18 +233,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IBackupInstanceResource +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IBackupInstanceResource ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BACKUPCONFIGURATION `: Backup configuration for backup. Use this parameter to configure protection for AzureKubernetesService. - - `ObjectType `: Type of the specific object - used for deserializing - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Initialize-AzDataProtectionRestoreRequest.md b/src/DataProtection/DataProtection/help/Initialize-AzDataProtectionRestoreRequest.md index 66e845991ffd..d3204a536ae6 100644 --- a/src/DataProtection/DataProtection/help/Initialize-AzDataProtectionRestoreRequest.md +++ b/src/DataProtection/DataProtection/help/Initialize-AzDataProtectionRestoreRequest.md @@ -18,7 +18,8 @@ Initialize-AzDataProtectionRestoreRequest -DatasourceType -Sou -RestoreLocation -RestoreType -TargetResourceId [-RecoveryPoint ] [-RestoreConfiguration ] [-RehydrationDuration ] [-RehydrationPriority ] [-SecretStoreURI ] - [-SecretStoreType ] [-PointInTime ] [] + [-SecretStoreType ] [-PointInTime ] [-ProgressAction ] + [] ``` ### AlternateLocationILR @@ -26,7 +27,8 @@ Initialize-AzDataProtectionRestoreRequest -DatasourceType -Sou Initialize-AzDataProtectionRestoreRequest -DatasourceType -SourceDataStore -RestoreLocation -RestoreType -TargetResourceId [-ItemLevelRecovery] [-RecoveryPoint ] [-ContainersList ] - [-RestoreConfiguration ] [] + [-RestoreConfiguration ] [-ProgressAction ] + [] ``` ### OriginalLocationILR @@ -36,7 +38,8 @@ Initialize-AzDataProtectionRestoreRequest -DatasourceType -Sou [-ContainersList ] [-RestoreConfiguration ] [-RehydrationDuration ] [-RehydrationPriority ] [-SecretStoreURI ] [-SecretStoreType ] -BackupInstance [-PointInTime ] - [-FromPrefixPattern ] [-ToPrefixPattern ] [] + [-FromPrefixPattern ] [-ToPrefixPattern ] [-ProgressAction ] + [] ``` ### OriginalLocationFullRecovery @@ -45,7 +48,8 @@ Initialize-AzDataProtectionRestoreRequest -DatasourceType -Sou -RestoreLocation -RestoreType [-RecoveryPoint ] [-RestoreConfiguration ] [-RehydrationDuration ] [-RehydrationPriority ] [-SecretStoreURI ] [-SecretStoreType ] - -BackupInstance [-PointInTime ] [] + -BackupInstance [-PointInTime ] [-ProgressAction ] + [] ``` ### RestoreAsFiles @@ -54,7 +58,7 @@ Initialize-AzDataProtectionRestoreRequest -DatasourceType -Sou -RestoreLocation -RestoreType [-RecoveryPoint ] -TargetContainerURI -FileNamePrefix [-RehydrationDuration ] [-RehydrationPriority ] [-TargetResourceIdForRestoreAsFile ] [-SecretStoreURI ] - [-SecretStoreType ] [] + [-SecretStoreType ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -140,6 +144,50 @@ FromPrefix ToPrefix Note: The ranges shouldn't overlap with each other. Reference: https://learn.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata +### Example 5: Get cross region restore request object for restore as database for datasource type AzureDatabaseForPostgreSQL +```powershell +$vault = Search-AzDataProtectionBackupVaultInAzGraph -ResourceGroup $ResourceGroupName -Subscription $SubscriptionId -Vault $VaultName +$instance = Search-AzDataProtectionBackupInstanceInAzGraph -Subscription $subscriptionId -ResourceGroup $resourceGroupName -Vault $vaultName -DatasourceType AzureDatabaseForPostgreSQL +$recoveryPointsCrr = Get-AzDataProtectionRecoveryPoint -BackupInstanceName $instance.Name -ResourceGroupName $resourceGroupName -VaultName $vaultName -SubscriptionId $subscriptionId -UseSecondaryRegion +$targetResourceId = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/{targetResourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{targetServerName}/databases/{targetDatabaseName}" +$secretURI = "https://{crr-key-vault}.vault.azure.net/secrets/{secret-for-crr}" +$OssRestoreReq = Initialize-AzDataProtectionRestoreRequest -DatasourceType AzureDatabaseForPostgreSQL -SourceDataStore VaultStore -RestoreLocation $vault.ReplicatedRegion[0] -RestoreType AlternateLocation -RecoveryPoint $recoveryPointsCrr[0].Property.RecoveryPointId -TargetResourceId $targetResourceId -SecretStoreURI $secretURI -SecretStoreType AzureKeyVault +``` + +```output +ObjectType SourceDataStoreType SourceResourceId RecoveryPointId +---------- ------------------- ---------------- --------------- +AzureBackupRecoveryPointBasedRestoreRequest VaultStore d49aeb83264456ccab92a105cade9afe +``` + +First and second commands fetch the vault and backup instance from Azure resource graph. +Third command is used to fetch recovery points from secondary region for cross region restore. +Last command constructs the cross region restore request object for restore to alternate location as database for datasourcetype AzureDatabaseForPostgreSQL. +Please note that we set RestoreLocation parameter to $vault.ReplicatedRegion[0] (paired region) instead of $vault.Location for normal restore. +Use Test-AzDataProtectionBackupInstanceRestore, Start-AzDataProtectionBackupInstanceRestore commands to validate and trigger restore. + +### Example 6: Get cross region restore request object for restore as database for datasource type AzureDatabaseForPostgreSQL +```powershell +$vault = Search-AzDataProtectionBackupVaultInAzGraph -ResourceGroup $ResourceGroupName -Subscription $SubscriptionId -Vault $VaultName +$instance = Search-AzDataProtectionBackupInstanceInAzGraph -Subscription $subscriptionId -ResourceGroup $resourceGroupName -Vault $vaultName -DatasourceType AzureDatabaseForPostgreSQL +$recoveryPointsCrr = Get-AzDataProtectionRecoveryPoint -BackupInstanceName $instance.Name -ResourceGroupName $resourceGroupName -VaultName $vaultName -SubscriptionId $subscriptionId -UseSecondaryRegion +$targetContainerURI = "https://{targetStorageAccountName}.blob.core.windows.net/{targetContainerName}" +$fileNamePrefix = "oss-pstest-crrasfiles" +$OssRestoreReq = Initialize-AzDataProtectionRestoreRequest -DatasourceType AzureDatabaseForPostgreSQL -SourceDataStore VaultStore -RestoreLocation $vault.ReplicatedRegion[0] -RestoreType RestoreAsFiles -RecoveryPoint $recoveryPointsCrr[0].Property.RecoveryPointId -TargetContainerURI $targetContainerURI -FileNamePrefix $fileNamePrefix +``` + +```output +ObjectType SourceDataStoreType SourceResourceId RecoveryPointId +---------- ------------------- ---------------- --------------- +AzureBackupRecoveryPointBasedRestoreRequest VaultStore d49aeb83264456ccab92a105cade9afe +``` + +First and second commands fetch the vault and backup instance from Azure resource graph. +Third command is used to fetch recovery points from secondary region for cross region restore. +Last command constructs the cross region restore request object for restore as files for datasourcetype AzureDatabaseForPostgreSQL. +Please note that we set RestoreLocation parameter to $vault.ReplicatedRegion[0] (paired region) instead of $vault.Location for normal restore. +Use Test-AzDataProtectionBackupInstanceRestore, Start-AzDataProtectionBackupInstanceRestore commands to validate and trigger restore. + ## PARAMETERS ### -BackupInstance @@ -249,6 +297,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RecoveryPoint Id of the recovery point to be restored. @@ -461,68 +524,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IAzureBackupRestoreRequest +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IAzureBackupRestoreRequest ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BACKUPINSTANCE `: Backup Instance object to trigger original localtion restore. - - `[Property ]`: BackupInstanceResource properties - - `DataSourceInfo `: Gets or sets the data source information. - - `ResourceId `: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. - - `[ObjectType ]`: Type of Datasource object, used to initialize the right inherited type - - `[ResourceLocation ]`: Location of datasource. - - `[ResourceName ]`: Unique identifier of the resource in the context of parent. - - `[ResourceType ]`: Resource Type of Datasource. - - `[ResourceUri ]`: Uri of the resource. - - `[Type ]`: DatasourceType of the resource. - - `ObjectType `: - - `PolicyInfo `: Gets or sets the policy information. - - `PolicyId `: - - `[PolicyParameter ]`: Policy parameters for the backup instance - - `[BackupDatasourceParametersList ]`: Gets or sets the Backup Data Source Parameters - - `ObjectType `: Type of the specific object - used for deserializing - - `[DataStoreParametersList ]`: Gets or sets the DataStore Parameters - - `DataStoreType `: type of datastore; Operational/Vault/Archive - - `ObjectType `: Type of the specific object - used for deserializing - - `[DataSourceSetInfo ]`: Gets or sets the data source set information. - - `ResourceId `: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. - - `[DatasourceType ]`: DatasourceType of the resource. - - `[ObjectType ]`: Type of Datasource object, used to initialize the right inherited type - - `[ResourceLocation ]`: Location of datasource. - - `[ResourceName ]`: Unique identifier of the resource in the context of parent. - - `[ResourceType ]`: Resource Type of Datasource. - - `[ResourceUri ]`: Uri of the resource. - - `[DatasourceAuthCredentials ]`: Credentials to use to authenticate with data source provider. - - `ObjectType `: Type of the specific object - used for deserializing - - `[FriendlyName ]`: Gets or sets the Backup Instance friendly name. - - `[IdentityDetail ]`: Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned. - - `[UseSystemAssignedIdentity ]`: Specifies if the BI is protected by System Identity. - - `[UserAssignedIdentityArmUrl ]`: ARM URL for User Assigned Identity. - - `[ValidationType ]`: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. - - `[Tag ]`: Proxy Resource tags. - - `[(Any) ]`: This indicates any property can be added to this object. - -`RESTORECONFIGURATION `: Restore configuration for restore. Use this parameter to restore with AzureKubernetesService. - - `IncludeClusterScopeResource `: Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during restore. - - `ObjectType `: Type of the specific object - used for deserializing - - `[ConflictPolicy ]`: Gets or sets the Conflict Policy property. This property sets policy during conflict of resources during restore. - - `[ExcludedNamespace ]`: Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during restore. - - `[ExcludedResourceType ]`: Gets or sets the exclude resource types property. This property sets the resource types to be excluded during restore. - - `[IncludedNamespace ]`: Gets or sets the include namespaces property. This property sets the namespaces to be included during restore. - - `[IncludedResourceType ]`: Gets or sets the include resource types property. This property sets the resource types to be included during restore. - - `[LabelSelector ]`: Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during restore. - - `[NamespaceMapping ]`: Gets or sets the Namespace Mappings property. This property sets if namespace needs to be change during restore. - - `[(Any) ]`: This indicates any property can be added to this object. - - `[PersistentVolumeRestoreMode ]`: Gets or sets the PV (Persistent Volume) Restore Mode property. This property sets whether volumes needs to be restored. - - `[RestoreHookReference ]`: Gets or sets the restore hook references. This property sets the hook reference to be executed during restore. - - `[Name ]`: Name of the resource - - `[Namespace ]`: Namespace in which the resource exists - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/New-AzDataProtectionBackupConfigurationClientObject.md b/src/DataProtection/DataProtection/help/New-AzDataProtectionBackupConfigurationClientObject.md index 7a6dbe57dd89..86d60a0da3e0 100644 --- a/src/DataProtection/DataProtection/help/New-AzDataProtectionBackupConfigurationClientObject.md +++ b/src/DataProtection/DataProtection/help/New-AzDataProtectionBackupConfigurationClientObject.md @@ -18,7 +18,7 @@ New-AzDataProtectionBackupConfigurationClientObject -DatasourceType ] [-LabelSelector ] [-SnapshotVolume ] [-IncludeClusterScopeResource ] [-BackupHookReference ] [-VaultedBackupContainer ] [-IncludeAllContainer] [-StorageAccountName ] - [-StorageAccountResourceGroupName ] [] + [-StorageAccountResourceGroupName ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -196,6 +196,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SnapshotVolume Boolean parameter to decide whether snapshot volumes are included for backup. By default this is taken as true. @@ -271,15 +286,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BACKUPHOOKREFERENCE `: Hook reference to be executed during backup. - - `[Name ]`: Name of the resource - - `[Namespace ]`: Namespace in which the resource exists - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/New-AzDataProtectionBackupInstance.md b/src/DataProtection/DataProtection/help/New-AzDataProtectionBackupInstance.md index dca44fae35f1..15cdf022cf1d 100644 --- a/src/DataProtection/DataProtection/help/New-AzDataProtectionBackupInstance.md +++ b/src/DataProtection/DataProtection/help/New-AzDataProtectionBackupInstance.md @@ -15,7 +15,8 @@ Configures Backup for supported azure resources ``` New-AzDataProtectionBackupInstance -ResourceGroupName -VaultName -BackupInstance [-SubscriptionId ] [-Tag ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -185,6 +186,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Resource Group of the backup vault @@ -285,48 +301,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BACKUPINSTANCE `: Backup instance request object which will be used to configure backup - - `[Tag ]`: Proxy Resource tags. - - `[(Any) ]`: This indicates any property can be added to this object. - - `[Property ]`: BackupInstanceResource properties - - `DataSourceInfo `: Gets or sets the data source information. - - `ResourceId `: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. - - `[ObjectType ]`: Type of Datasource object, used to initialize the right inherited type - - `[ResourceLocation ]`: Location of datasource. - - `[ResourceName ]`: Unique identifier of the resource in the context of parent. - - `[ResourceType ]`: Resource Type of Datasource. - - `[ResourceUri ]`: Uri of the resource. - - `[Type ]`: DatasourceType of the resource. - - `ObjectType `: - - `PolicyInfo `: Gets or sets the policy information. - - `PolicyId `: - - `[PolicyParameter ]`: Policy parameters for the backup instance - - `[BackupDatasourceParametersList ]`: Gets or sets the Backup Data Source Parameters - - `ObjectType `: Type of the specific object - used for deserializing - - `[DataStoreParametersList ]`: Gets or sets the DataStore Parameters - - `DataStoreType `: type of datastore; Operational/Vault/Archive - - `ObjectType `: Type of the specific object - used for deserializing - - `[DataSourceSetInfo ]`: Gets or sets the data source set information. - - `ResourceId `: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. - - `[DatasourceType ]`: DatasourceType of the resource. - - `[ObjectType ]`: Type of Datasource object, used to initialize the right inherited type - - `[ResourceLocation ]`: Location of datasource. - - `[ResourceName ]`: Unique identifier of the resource in the context of parent. - - `[ResourceType ]`: Resource Type of Datasource. - - `[ResourceUri ]`: Uri of the resource. - - `[DatasourceAuthCredentials ]`: Credentials to use to authenticate with data source provider. - - `ObjectType `: Type of the specific object - used for deserializing - - `[FriendlyName ]`: Gets or sets the Backup Instance friendly name. - - `[IdentityDetail ]`: Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned. - - `[UseSystemAssignedIdentity ]`: Specifies if the BI is protected by System Identity. - - `[UserAssignedIdentityArmUrl ]`: ARM URL for User Assigned Identity. - - `[ValidationType ]`: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/New-AzDataProtectionBackupPolicy.md b/src/DataProtection/DataProtection/help/New-AzDataProtectionBackupPolicy.md index a3389a932472..a9e2a82a0547 100644 --- a/src/DataProtection/DataProtection/help/New-AzDataProtectionBackupPolicy.md +++ b/src/DataProtection/DataProtection/help/New-AzDataProtectionBackupPolicy.md @@ -14,8 +14,8 @@ Creates a new backup policy in a given backup vault ``` New-AzDataProtectionBackupPolicy -ResourceGroupName -VaultName -Name - -Policy [-SubscriptionId ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + -Policy [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -240,6 +240,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Resource Group Name @@ -323,36 +338,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IBaseBackupPolicyResource +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IBaseBackupPolicyResource ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`POLICY `: Policy Request Object - - `DatasourceType `: Type of datasource for the backup management - - `ObjectType `: - - `PolicyRule `: Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc - - `Name `: - - `ObjectType `: - - `DataStoreObjectType `: Type of Datasource object, used to initialize the right inherited type - - `DataStoreType `: type of datastore; Operational/Vault/Archive - - `TriggerObjectType `: Type of the specific object - used for deserializing - - `Lifecycle `: - - `DeleteAfterDuration `: Duration of deletion after given timespan - - `DeleteAfterObjectType `: Type of the specific object - used for deserializing - - `SourceDataStoreObjectType `: Type of Datasource object, used to initialize the right inherited type - - `SourceDataStoreType `: type of datastore; Operational/Vault/Archive - - `[TargetDataStoreCopySetting ]`: - - `CopyAfterObjectType `: Type of the specific object - used for deserializing - - `DataStoreObjectType `: Type of Datasource object, used to initialize the right inherited type - - `DataStoreType `: type of datastore; Operational/Vault/Archive - - `[BackupParameterObjectType ]`: Type of the specific object - used for deserializing - - `[IsDefault ]`: - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/New-AzDataProtectionBackupVault.md b/src/DataProtection/DataProtection/help/New-AzDataProtectionBackupVault.md index a22ebd69c1ee..a31bc2906aa0 100644 --- a/src/DataProtection/DataProtection/help/New-AzDataProtectionBackupVault.md +++ b/src/DataProtection/DataProtection/help/New-AzDataProtectionBackupVault.md @@ -19,7 +19,7 @@ New-AzDataProtectionBackupVault -ResourceGroupName -VaultName [-CrossRegionRestoreState ] [-CrossSubscriptionRestoreState ] [-SoftDeleteRetentionDurationInDay ] [-SoftDeleteState ] [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] - [-WhatIf] [-Confirm] [] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -210,6 +210,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Resource Group Name of the backup vault @@ -360,15 +375,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`STORAGESETTING `: Storage Settings of the vault. Use New-AzDataProtectionBackupVaultStorageSetting Cmdlet to Create. - - `[DatastoreType ]`: Gets or sets the type of the datastore. - - `[Type ]`: Gets or sets the type. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/New-AzDataProtectionBackupVaultStorageSettingObject.md b/src/DataProtection/DataProtection/help/New-AzDataProtectionBackupVaultStorageSettingObject.md index e054480fa48e..b2014fe49bd6 100644 --- a/src/DataProtection/DataProtection/help/New-AzDataProtectionBackupVaultStorageSettingObject.md +++ b/src/DataProtection/DataProtection/help/New-AzDataProtectionBackupVaultStorageSettingObject.md @@ -14,7 +14,7 @@ Get Backup Vault storage setting object ``` New-AzDataProtectionBackupVaultStorageSettingObject -Type -DataStoreType - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -53,6 +53,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Type Storage Type of the vault @@ -80,6 +95,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/New-AzDataProtectionPolicyTagCriteriaClientObject.md b/src/DataProtection/DataProtection/help/New-AzDataProtectionPolicyTagCriteriaClientObject.md index 508d51241acc..a6a8a9fe3f14 100644 --- a/src/DataProtection/DataProtection/help/New-AzDataProtectionPolicyTagCriteriaClientObject.md +++ b/src/DataProtection/DataProtection/help/New-AzDataProtectionPolicyTagCriteriaClientObject.md @@ -15,18 +15,21 @@ Creates a new criteria object ### ScheduleCriteria (Default) ``` New-AzDataProtectionPolicyTagCriteriaClientObject [-DaysOfWeek ] [-WeeksOfMonth ] - [-MonthsOfYear ] [-ScheduleTimes ] [] + [-MonthsOfYear ] [-ScheduleTimes ] [-ProgressAction ] + [] ``` ### AbsoluteCriteria ``` -New-AzDataProtectionPolicyTagCriteriaClientObject -AbsoluteCriteria [] +New-AzDataProtectionPolicyTagCriteriaClientObject -AbsoluteCriteria + [-ProgressAction ] [] ``` ### MonthlyCriteria ``` New-AzDataProtectionPolicyTagCriteriaClientObject [-MonthsOfYear ] - [-ScheduleTimes ] -DaysOfMonth [] + [-ScheduleTimes ] -DaysOfMonth [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -126,6 +129,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ScheduleTimes Schedule times. @@ -164,10 +182,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IScheduleBasedBackupCriteria +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IScheduleBasedBackupCriteria ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/New-AzDataProtectionPolicyTriggerScheduleClientObject.md b/src/DataProtection/DataProtection/help/New-AzDataProtectionPolicyTriggerScheduleClientObject.md index 779eaed0b9ec..047680863007 100644 --- a/src/DataProtection/DataProtection/help/New-AzDataProtectionPolicyTriggerScheduleClientObject.md +++ b/src/DataProtection/DataProtection/help/New-AzDataProtectionPolicyTriggerScheduleClientObject.md @@ -14,7 +14,8 @@ Creates new Schedule object ``` New-AzDataProtectionPolicyTriggerScheduleClientObject -ScheduleDays - -IntervalType -IntervalCount [] + -IntervalType -IntervalCount [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -79,6 +80,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ScheduleDays Days with which backup will be scheduled. @@ -105,6 +121,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/New-AzDataProtectionResourceGuard.md b/src/DataProtection/DataProtection/help/New-AzDataProtectionResourceGuard.md index 57c607cd6c06..9f477be07069 100644 --- a/src/DataProtection/DataProtection/help/New-AzDataProtectionResourceGuard.md +++ b/src/DataProtection/DataProtection/help/New-AzDataProtectionResourceGuard.md @@ -15,7 +15,7 @@ Creates a resource guard under a resource group ``` New-AzDataProtectionResourceGuard -ResourceGroupName -Name -Location [-SubscriptionId ] [-ETag ] [-IdentityType ] [-Tag ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -112,6 +112,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Resource Group name of the resource guard @@ -195,10 +210,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IResourceGuardResource +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IResourceGuardResource ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/New-AzDataProtectionRestoreConfigurationClientObject.md b/src/DataProtection/DataProtection/help/New-AzDataProtectionRestoreConfigurationClientObject.md index 18993b9ec7fd..3d55a3b53bbb 100644 --- a/src/DataProtection/DataProtection/help/New-AzDataProtectionRestoreConfigurationClientObject.md +++ b/src/DataProtection/DataProtection/help/New-AzDataProtectionRestoreConfigurationClientObject.md @@ -18,7 +18,7 @@ New-AzDataProtectionRestoreConfigurationClientObject -DatasourceType ] [-LabelSelector ] [-IncludeClusterScopeResource ] [-ConflictPolicy ] [-NamespaceMapping ] [-PersistentVolumeRestoreMode ] [-RestoreHookReference ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -199,6 +199,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RestoreHookReference Hook reference to be executed during restore. To construct, see NOTES section for RESTOREHOOKREFERENCE properties and create a hash table. @@ -226,18 +241,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`NAMESPACEMAPPING `: Namespaces mapping from source namespaces to target namespaces to resolve namespace naming conflicts in the target cluster. - - `[(Any) ]`: This indicates any property can be added to this object. - -`RESTOREHOOKREFERENCE `: Hook reference to be executed during restore. - - `[Name ]`: Name of the resource - - `[Namespace ]`: Namespace in which the resource exists - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/New-AzDataProtectionRetentionLifeCycleClientObject.md b/src/DataProtection/DataProtection/help/New-AzDataProtectionRetentionLifeCycleClientObject.md index 1eac93ff5efe..4dcf1a7198dc 100644 --- a/src/DataProtection/DataProtection/help/New-AzDataProtectionRetentionLifeCycleClientObject.md +++ b/src/DataProtection/DataProtection/help/New-AzDataProtectionRetentionLifeCycleClientObject.md @@ -15,7 +15,8 @@ Creates new Lifecycle object ``` New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore -SourceRetentionDurationType -SourceRetentionDurationCount - [-TargetDataStore ] [-CopyOption ] [] + [-TargetDataStore ] [-CopyOption ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -71,6 +72,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SourceDataStore Source Datastore @@ -141,10 +157,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.ISourceLifeCycle +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.ISourceLifeCycle ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Remove-AzDataProtectionBackupInstance.md b/src/DataProtection/DataProtection/help/Remove-AzDataProtectionBackupInstance.md index ac04af49fa27..36eaa93a7e3b 100644 --- a/src/DataProtection/DataProtection/help/Remove-AzDataProtectionBackupInstance.md +++ b/src/DataProtection/DataProtection/help/Remove-AzDataProtectionBackupInstance.md @@ -15,14 +15,14 @@ Delete a backupInstances ### Delete (Default) ``` Remove-AzDataProtectionBackupInstance -Name -ResourceGroupName [-SubscriptionId ] - -VaultName [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] - [] + -VaultName [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzDataProtectionBackupInstance -InputObject [-DefaultProfile ] - [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -132,6 +132,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -223,26 +238,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[BackupInstanceName ]`: The name of the backup instance. - - `[BackupPolicyName ]`: - - `[Id ]`: Resource identity path - - `[JobId ]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). - - `[Location ]`: The location in which uniqueness will be verified. - - `[OperationId ]`: - - `[RecoveryPointId ]`: - - `[RequestName ]`: - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceGuardProxyName ]`: name of the resource guard proxy - - `[ResourceGuardsName ]`: The name of ResourceGuard - - `[SubscriptionId ]`: The ID of the target subscription. The value must be an UUID. - - `[VaultName ]`: The name of the backup vault. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Remove-AzDataProtectionBackupPolicy.md b/src/DataProtection/DataProtection/help/Remove-AzDataProtectionBackupPolicy.md index 5280dc2c458b..cf902b3950d9 100644 --- a/src/DataProtection/DataProtection/help/Remove-AzDataProtectionBackupPolicy.md +++ b/src/DataProtection/DataProtection/help/Remove-AzDataProtectionBackupPolicy.md @@ -15,13 +15,14 @@ Deletes a backup policy belonging to a backup vault ### Delete (Default) ``` Remove-AzDataProtectionBackupPolicy -Name -ResourceGroupName [-SubscriptionId ] - -VaultName [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] [] + -VaultName [-DefaultProfile ] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzDataProtectionBackupPolicy -InputObject [-DefaultProfile ] - [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -101,6 +102,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -192,26 +208,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[BackupInstanceName ]`: The name of the backup instance. - - `[BackupPolicyName ]`: - - `[Id ]`: Resource identity path - - `[JobId ]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). - - `[Location ]`: The location in which uniqueness will be verified. - - `[OperationId ]`: - - `[RecoveryPointId ]`: - - `[RequestName ]`: - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceGuardProxyName ]`: name of the resource guard proxy - - `[ResourceGuardsName ]`: The name of ResourceGuard - - `[SubscriptionId ]`: The ID of the target subscription. The value must be an UUID. - - `[VaultName ]`: The name of the backup vault. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Remove-AzDataProtectionBackupVault.md b/src/DataProtection/DataProtection/help/Remove-AzDataProtectionBackupVault.md index c631d1f35b86..9922d1b9b8fb 100644 --- a/src/DataProtection/DataProtection/help/Remove-AzDataProtectionBackupVault.md +++ b/src/DataProtection/DataProtection/help/Remove-AzDataProtectionBackupVault.md @@ -15,13 +15,14 @@ Deletes a BackupVault resource from the resource group. ### Delete (Default) ``` Remove-AzDataProtectionBackupVault -ResourceGroupName [-SubscriptionId ] -VaultName - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzDataProtectionBackupVault -InputObject [-DefaultProfile ] [-AsJob] - [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -115,6 +116,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -206,26 +222,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[BackupInstanceName ]`: The name of the backup instance. - - `[BackupPolicyName ]`: - - `[Id ]`: Resource identity path - - `[JobId ]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). - - `[Location ]`: The location in which uniqueness will be verified. - - `[OperationId ]`: - - `[RecoveryPointId ]`: - - `[RequestName ]`: - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceGuardProxyName ]`: name of the resource guard proxy - - `[ResourceGuardsName ]`: The name of ResourceGuard - - `[SubscriptionId ]`: The ID of the target subscription. The value must be an UUID. - - `[VaultName ]`: The name of the backup vault. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Remove-AzDataProtectionResourceGuard.md b/src/DataProtection/DataProtection/help/Remove-AzDataProtectionResourceGuard.md index 80b441d800f3..ce7a136c7495 100644 --- a/src/DataProtection/DataProtection/help/Remove-AzDataProtectionResourceGuard.md +++ b/src/DataProtection/DataProtection/help/Remove-AzDataProtectionResourceGuard.md @@ -15,13 +15,14 @@ Deletes a ResourceGuard resource from the resource group. ### Delete (Default) ``` Remove-AzDataProtectionResourceGuard -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### DeleteViaIdentity ``` Remove-AzDataProtectionResourceGuard -InputObject [-DefaultProfile ] - [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -100,6 +101,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -176,26 +192,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[BackupInstanceName ]`: The name of the backup instance. - - `[BackupPolicyName ]`: - - `[Id ]`: Resource identity path - - `[JobId ]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). - - `[Location ]`: The location in which uniqueness will be verified. - - `[OperationId ]`: - - `[RecoveryPointId ]`: - - `[RequestName ]`: - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceGuardProxyName ]`: name of the resource guard proxy - - `[ResourceGuardsName ]`: The name of ResourceGuard - - `[SubscriptionId ]`: The ID of the target subscription. The value must be an UUID. - - `[VaultName ]`: The name of the backup vault. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Remove-AzDataProtectionResourceGuardMapping.md b/src/DataProtection/DataProtection/help/Remove-AzDataProtectionResourceGuardMapping.md index d0479a23224f..9e88f0687fc3 100644 --- a/src/DataProtection/DataProtection/help/Remove-AzDataProtectionResourceGuardMapping.md +++ b/src/DataProtection/DataProtection/help/Remove-AzDataProtectionResourceGuardMapping.md @@ -15,13 +15,14 @@ Deletes the ResourceGuardProxy ### Delete (Default) ``` Remove-AzDataProtectionResourceGuardMapping -ResourceGroupName [-SubscriptionId ] - -VaultName [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] [] + -VaultName [-DefaultProfile ] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzDataProtectionResourceGuardMapping -InputObject [-DefaultProfile ] - [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -96,6 +97,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -187,26 +203,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[BackupInstanceName ]`: The name of the backup instance. - - `[BackupPolicyName ]`: - - `[Id ]`: Resource identity path - - `[JobId ]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). - - `[Location ]`: The location in which uniqueness will be verified. - - `[OperationId ]`: - - `[RecoveryPointId ]`: - - `[RequestName ]`: - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceGuardProxyName ]`: name of the resource guard proxy - - `[ResourceGuardsName ]`: The name of ResourceGuard - - `[SubscriptionId ]`: The ID of the target subscription. The value must be an UUID. - - `[VaultName ]`: The name of the backup vault. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Resume-AzDataProtectionBackupInstanceProtection.md b/src/DataProtection/DataProtection/help/Resume-AzDataProtectionBackupInstanceProtection.md index 037e3a05cb1a..37bc19ee7c0f 100644 --- a/src/DataProtection/DataProtection/help/Resume-AzDataProtectionBackupInstanceProtection.md +++ b/src/DataProtection/DataProtection/help/Resume-AzDataProtectionBackupInstanceProtection.md @@ -16,13 +16,14 @@ This operation will resume protection for a stopped backup instance ``` Resume-AzDataProtectionBackupInstanceProtection -BackupInstanceName -ResourceGroupName [-SubscriptionId ] -VaultName [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] - [-WhatIf] [-Confirm] [] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### ResumeViaIdentity ``` Resume-AzDataProtectionBackupInstanceProtection -InputObject - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -131,6 +132,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -222,26 +238,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[BackupInstanceName ]`: The name of the backup instance. - - `[BackupPolicyName ]`: - - `[Id ]`: Resource identity path - - `[JobId ]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). - - `[Location ]`: The location in which uniqueness will be verified. - - `[OperationId ]`: - - `[RecoveryPointId ]`: - - `[RequestName ]`: - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceGuardProxyName ]`: name of the resource guard proxy - - `[ResourceGuardsName ]`: The name of ResourceGuard - - `[SubscriptionId ]`: The ID of the target subscription. The value must be an UUID. - - `[VaultName ]`: The name of the backup vault. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Search-AzDataProtectionBackupInstanceInAzGraph.md b/src/DataProtection/DataProtection/help/Search-AzDataProtectionBackupInstanceInAzGraph.md index 906804e05187..07366358a308 100644 --- a/src/DataProtection/DataProtection/help/Search-AzDataProtectionBackupInstanceInAzGraph.md +++ b/src/DataProtection/DataProtection/help/Search-AzDataProtectionBackupInstanceInAzGraph.md @@ -15,7 +15,7 @@ Searches for Backup instances in Azure Resource Graph and retrieves the expected ``` Search-AzDataProtectionBackupInstanceInAzGraph -Subscription -DatasourceType [-ResourceGroup ] [-Vault ] [-ProtectionStatus ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -92,7 +92,6 @@ Accept wildcard characters: False ``` ### -DefaultProfile -{{ Fill DefaultProfile Description }} ```yaml Type: System.Management.Automation.PSObject @@ -106,6 +105,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProtectionStatus Protection Status of the item @@ -178,6 +192,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Search-AzDataProtectionBackupVaultInAzGraph.md b/src/DataProtection/DataProtection/help/Search-AzDataProtectionBackupVaultInAzGraph.md index d57bc9b4b03d..15c7f2ef0830 100644 --- a/src/DataProtection/DataProtection/help/Search-AzDataProtectionBackupVaultInAzGraph.md +++ b/src/DataProtection/DataProtection/help/Search-AzDataProtectionBackupVaultInAzGraph.md @@ -14,7 +14,7 @@ Searches for Backup vaults in Azure Resource Graph and retrieves the expected en ``` Search-AzDataProtectionBackupVaultInAzGraph -Subscription [-ResourceGroup ] - [-Vault ] [-DefaultProfile ] [] + [-Vault ] [-DefaultProfile ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -22,18 +22,25 @@ Searches for Backup vaults in Azure Resource Graph and retrieves the expected en ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Get a specific vault with its name. +```powershell Search-AzDataProtectionBackupVaultInAzGraph -Subscription "xxxxxxxx-xxxx-xxxxxxxxxxxx" -ResourceGroup $resourceGroupName -Vault $vaultName ``` +```output +ETag IdentityPrincipalId IdentityTenantId IdentityType Location Name Type +---- ------------------- ---------------- ------------ -------- ---- ---- + xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx SystemAssigned centraluseuap sarath-vault Microsoft.DataProtection/backupVaults +``` + +This command gets a specific vault by given vault name from ARG (Azure Resource Graph). + ## PARAMETERS ### -DefaultProfile -{{ Fill DefaultProfile Description }} ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -44,11 +51,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroup Resource Group of Vault ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -63,7 +85,7 @@ Accept wildcard characters: False Subscription of Vault ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -78,7 +100,7 @@ Accept wildcard characters: False Name of the vault ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -97,9 +119,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Management.Automation.PSObject + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.dataprotection/search-azdataprotectionbackupvaultinazgraph](https://learn.microsoft.com/powershell/module/az.dataprotection/search-azdataprotectionbackupvaultinazgraph) - diff --git a/src/DataProtection/DataProtection/help/Search-AzDataProtectionJobInAzGraph.md b/src/DataProtection/DataProtection/help/Search-AzDataProtectionJobInAzGraph.md index 5dc27e870672..c2b664f64fff 100644 --- a/src/DataProtection/DataProtection/help/Search-AzDataProtectionJobInAzGraph.md +++ b/src/DataProtection/DataProtection/help/Search-AzDataProtectionJobInAzGraph.md @@ -15,7 +15,8 @@ Searches for Backup Jobs in Azure Resource Graph and retrieves the expected entr ``` Search-AzDataProtectionJobInAzGraph -Subscription -DatasourceType [-ResourceGroup ] [-Vault ] [-StartTime ] [-EndTime ] - [-Operation ] [-Status ] [-DefaultProfile ] [] + [-Operation ] [-Status ] [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -74,7 +75,6 @@ Accept wildcard characters: False ``` ### -DefaultProfile -{{ Fill DefaultProfile Description }} ```yaml Type: System.Management.Automation.PSObject @@ -119,6 +119,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroup Resource Group of Vault @@ -206,6 +221,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Set-AzDataProtectionMSIPermission.md b/src/DataProtection/DataProtection/help/Set-AzDataProtectionMSIPermission.md index 8beffcd44e6b..4161acef49b1 100644 --- a/src/DataProtection/DataProtection/help/Set-AzDataProtectionMSIPermission.md +++ b/src/DataProtection/DataProtection/help/Set-AzDataProtectionMSIPermission.md @@ -15,14 +15,15 @@ Grants required permissions to the backup vault and other resources for configur ### SetPermissionsForBackup (Default) ``` Set-AzDataProtectionMSIPermission -VaultResourceGroup -VaultName -PermissionsScope - -BackupInstance [-KeyVaultId ] [-WhatIf] [-Confirm] [] + -BackupInstance [-KeyVaultId ] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ### SetPermissionsForRestore ``` Set-AzDataProtectionMSIPermission -VaultResourceGroup -VaultName -PermissionsScope - -RestoreRequest -SnapshotResourceGroupId [-WhatIf] [-Confirm] - [] + -RestoreRequest -SnapshotResourceGroupId + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -145,6 +146,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RestoreRequest Restore request object which will be used for restore To construct, see NOTES section for RESTOREREQUEST properties and create a hash table. @@ -248,58 +264,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BACKUPINSTANCE `: Backup instance request object which will be used to configure backup - - `[Tag ]`: Proxy Resource tags. - - `[(Any) ]`: This indicates any property can be added to this object. - - `[Property ]`: BackupInstanceResource properties - - `DataSourceInfo `: Gets or sets the data source information. - - `ResourceId `: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. - - `[ObjectType ]`: Type of Datasource object, used to initialize the right inherited type - - `[ResourceLocation ]`: Location of datasource. - - `[ResourceName ]`: Unique identifier of the resource in the context of parent. - - `[ResourceType ]`: Resource Type of Datasource. - - `[ResourceUri ]`: Uri of the resource. - - `[Type ]`: DatasourceType of the resource. - - `ObjectType `: - - `PolicyInfo `: Gets or sets the policy information. - - `PolicyId `: - - `[PolicyParameter ]`: Policy parameters for the backup instance - - `[BackupDatasourceParametersList ]`: Gets or sets the Backup Data Source Parameters - - `ObjectType `: Type of the specific object - used for deserializing - - `[DataStoreParametersList ]`: Gets or sets the DataStore Parameters - - `DataStoreType `: type of datastore; Operational/Vault/Archive - - `ObjectType `: Type of the specific object - used for deserializing - - `[DataSourceSetInfo ]`: Gets or sets the data source set information. - - `ResourceId `: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. - - `[DatasourceType ]`: DatasourceType of the resource. - - `[ObjectType ]`: Type of Datasource object, used to initialize the right inherited type - - `[ResourceLocation ]`: Location of datasource. - - `[ResourceName ]`: Unique identifier of the resource in the context of parent. - - `[ResourceType ]`: Resource Type of Datasource. - - `[ResourceUri ]`: Uri of the resource. - - `[DatasourceAuthCredentials ]`: Credentials to use to authenticate with data source provider. - - `ObjectType `: Type of the specific object - used for deserializing - - `[FriendlyName ]`: Gets or sets the Backup Instance friendly name. - - `[IdentityDetail ]`: Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned. - - `[UseSystemAssignedIdentity ]`: Specifies if the BI is protected by System Identity. - - `[UserAssignedIdentityArmUrl ]`: ARM URL for User Assigned Identity. - - `[ValidationType ]`: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. - -`RESTOREREQUEST `: Restore request object which will be used for restore - - `ObjectType `: - - `RestoreTargetInfo `: Gets or sets the restore target information. - - `ObjectType `: Type of Datasource object, used to initialize the right inherited type - - `[RestoreLocation ]`: Target Restore region - - `SourceDataStoreType `: Gets or sets the type of the source data store. - - `[IdentityDetailUseSystemAssignedIdentity ]`: Specifies if the BI is protected by System Identity. - - `[IdentityDetailUserAssignedIdentityArmUrl ]`: ARM URL for User Assigned Identity. - - `[SourceResourceId ]`: Fully qualified Azure Resource Manager ID of the datasource which is being recovered. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Set-AzDataProtectionResourceGuardMapping.md b/src/DataProtection/DataProtection/help/Set-AzDataProtectionResourceGuardMapping.md index 605d7235ae4e..29454f64de0c 100644 --- a/src/DataProtection/DataProtection/help/Set-AzDataProtectionResourceGuardMapping.md +++ b/src/DataProtection/DataProtection/help/Set-AzDataProtectionResourceGuardMapping.md @@ -14,8 +14,8 @@ Creates or Updates a ResourceGuardProxy ``` Set-AzDataProtectionResourceGuardMapping -ResourceGroupName -VaultName - [-SubscriptionId ] [-ResourceGuardId ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + [-SubscriptionId ] [-ResourceGuardId ] [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -37,8 +37,8 @@ LastUpdatedTime : 2023-08-29T07:23:05.1111730Z Name : DppResourceGuardProxy ResourceGuardId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/hiaga-rg/providers/Microsoft.DataProtection/resourceGuard s/mua-pstest-resguard -ResourceGuardOperationDetail : {Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.ResourceGuardOperationDetail, - Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.ResourceGuardOperationDetail} +ResourceGuardOperationDetail : {Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.ResourceGuardOperationDetail, + Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.ResourceGuardOperationDetail} SystemData : Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api40.SystemData Type : Microsoft.DataProtection/vaults/backupResourceGuardProxies ``` @@ -64,6 +64,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -164,19 +179,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IResourceGuardProxyBaseResource +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IResourceGuardProxyBaseResource ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`RESOURCEGUARDOPERATIONDETAIL `: . - - `[DefaultResourceRequest ]`: - - `[VaultCriticalOperation ]`: - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Start-AzDataProtectionBackupInstanceRestore.md b/src/DataProtection/DataProtection/help/Start-AzDataProtectionBackupInstanceRestore.md index f507b12f36cd..30ba0f778d9c 100644 --- a/src/DataProtection/DataProtection/help/Start-AzDataProtectionBackupInstanceRestore.md +++ b/src/DataProtection/DataProtection/help/Start-AzDataProtectionBackupInstanceRestore.md @@ -16,8 +16,8 @@ Triggers restore for a BackupInstance ``` Start-AzDataProtectionBackupInstanceRestore -ResourceGroupName -BackupInstanceName -VaultName -Parameter [-SubscriptionId ] - [-RestoreToSecondaryRegion] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + [-RestoreToSecondaryRegion] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### TriggerExpanded @@ -26,8 +26,8 @@ Start-AzDataProtectionBackupInstanceRestore -ResourceGroupName -BackupI -VaultName [-SubscriptionId ] [-RestoreToSecondaryRegion] [-DefaultProfile ] [-AsJob] [-NoWait] -ObjectType -RestoreTargetInfo -SourceDataStoreType [-IdentityDetailUserAssignedIdentityArmUrl ] - [-IdentityDetailUseSystemAssignedIdentity] [-SourceResourceId ] [-WhatIf] [-Confirm] - [] + [-IdentityDetailUseSystemAssignedIdentity] [-SourceResourceId ] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -173,6 +173,22 @@ The sixth command initializes the restore request object for AzureDatabaseForPos The seventh command triggers validate before restore. The last command triggers the cross subscription restore as files for AzureDatabaseForPostgreSQL. +### Example 8: Trigger cross region restore for AzureDatabaseForPostgreSQL. +```powershell +$restoreJobCRR = Start-AzDataProtectionBackupInstanceRestore -BackupInstanceName $instance.Name -ResourceGroupName $ResourceGroupName -VaultName $vaultName -SubscriptionId $SubscriptionId -Parameter $OssRestoreReq -RestoreToSecondaryRegion +$jobid = $restoreJobCRR.JobId.Split("/")[-1] +$jobstatus = "InProgress" +while($jobstatus -ne "Completed") +{ + Start-Sleep -Seconds 10 + $currentjob = Get-AzDataProtectionJob -Id $jobid -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -UseSecondaryRegion + $jobstatus = $currentjob.Status +} +``` + +This command command triggers the cross region restore for AzureDatabaseForPostgreSQL. +For triggering cross region restore to secondary region, use RestoreToSecondaryRegion switch. + ## PARAMETERS ### -AsJob @@ -191,7 +207,7 @@ Accept wildcard characters: False ``` ### -BackupInstanceName -The name of the backup instance. +The name of the backup instance ```yaml Type: System.String @@ -206,8 +222,6 @@ 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 @@ -222,7 +236,7 @@ Accept wildcard characters: False ``` ### -IdentityDetailUserAssignedIdentityArmUrl -ARM URL for User Assigned Identity. +ARM URL for User Assigned Identity ```yaml Type: System.String @@ -237,7 +251,7 @@ Accept wildcard characters: False ``` ### -IdentityDetailUseSystemAssignedIdentity -Specifies if the BI is protected by System Identity. +Specifies if the BI is protected by System Identity ```yaml Type: System.Management.Automation.SwitchParameter @@ -267,7 +281,7 @@ Accept wildcard characters: False ``` ### -ObjectType -. +Object type of the restore request ```yaml Type: System.String @@ -282,7 +296,7 @@ Accept wildcard characters: False ``` ### -Parameter -Azure backup restore request +Restore request object to be initialized using Initialize-AzDataProtectionRestoreRequest cmdlet To construct, see NOTES section for PARAMETER properties and create a hash table. ```yaml @@ -297,9 +311,23 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. +The name of the resource group where the backup vault is present ```yaml Type: System.String @@ -314,7 +342,7 @@ Accept wildcard characters: False ``` ### -RestoreTargetInfo -Gets or sets the restore target information. +Gets or sets the restore target information To construct, see NOTES section for RESTORETARGETINFO properties and create a hash table. ```yaml @@ -339,13 +367,13 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -SourceDataStoreType -Gets or sets the type of the source data store. +Type of the source data store ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.SourceDataStoreType @@ -360,7 +388,7 @@ Accept wildcard characters: False ``` ### -SourceResourceId -Fully qualified Azure Resource Manager ID of the datasource which is being recovered. +Fully qualified Azure Resource Manager ID of the datasource which is being recovered ```yaml Type: System.String @@ -375,8 +403,7 @@ Accept wildcard characters: False ``` ### -SubscriptionId -The ID of the target subscription. -The value must be an UUID. +Subscription Id of the backup vault ```yaml Type: System.String @@ -385,13 +412,13 @@ Aliases: Required: False Position: Named -Default value: (Get-AzContext).Subscription.Id +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -VaultName -The name of the backup vault. +The name of the backup vault ```yaml Type: System.String @@ -441,33 +468,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IAzureBackupRestoreRequest +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IAzureBackupRestoreRequest ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IOperationJobExtendedInfo +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IOperationJobExtendedInfo ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`PARAMETER `: Azure backup restore request - - `ObjectType `: - - `RestoreTargetInfo `: Gets or sets the restore target information. - - `ObjectType `: Type of Datasource object, used to initialize the right inherited type - - `[RestoreLocation ]`: Target Restore region - - `SourceDataStoreType `: Gets or sets the type of the source data store. - - `[IdentityDetailUseSystemAssignedIdentity ]`: Specifies if the BI is protected by System Identity. - - `[IdentityDetailUserAssignedIdentityArmUrl ]`: ARM URL for User Assigned Identity. - - `[SourceResourceId ]`: Fully qualified Azure Resource Manager ID of the datasource which is being recovered. - -`RESTORETARGETINFO `: Gets or sets the restore target information. - - `ObjectType `: Type of Datasource object, used to initialize the right inherited type - - `[RestoreLocation ]`: Target Restore region - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Stop-AzDataProtectionBackupInstanceProtection.md b/src/DataProtection/DataProtection/help/Stop-AzDataProtectionBackupInstanceProtection.md index 7603467480f9..0242963e8c22 100644 --- a/src/DataProtection/DataProtection/help/Stop-AzDataProtectionBackupInstanceProtection.md +++ b/src/DataProtection/DataProtection/help/Stop-AzDataProtectionBackupInstanceProtection.md @@ -16,13 +16,14 @@ This operation will stop protection of a backup instance and data will be held f ``` Stop-AzDataProtectionBackupInstanceProtection -BackupInstanceName -ResourceGroupName [-SubscriptionId ] -VaultName [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] - [-WhatIf] [-Confirm] [] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### StopViaIdentity ``` Stop-AzDataProtectionBackupInstanceProtection -InputObject - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -131,6 +132,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -222,26 +238,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[BackupInstanceName ]`: The name of the backup instance. - - `[BackupPolicyName ]`: - - `[Id ]`: Resource identity path - - `[JobId ]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). - - `[Location ]`: The location in which uniqueness will be verified. - - `[OperationId ]`: - - `[RecoveryPointId ]`: - - `[RequestName ]`: - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceGuardProxyName ]`: name of the resource guard proxy - - `[ResourceGuardsName ]`: The name of ResourceGuard - - `[SubscriptionId ]`: The ID of the target subscription. The value must be an UUID. - - `[VaultName ]`: The name of the backup vault. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Suspend-AzDataProtectionBackupInstanceBackup.md b/src/DataProtection/DataProtection/help/Suspend-AzDataProtectionBackupInstanceBackup.md index c97e0a993a63..70c10ffd4411 100644 --- a/src/DataProtection/DataProtection/help/Suspend-AzDataProtectionBackupInstanceBackup.md +++ b/src/DataProtection/DataProtection/help/Suspend-AzDataProtectionBackupInstanceBackup.md @@ -16,13 +16,14 @@ This operation will stop backup for a backup instance and retains the backup dat ``` Suspend-AzDataProtectionBackupInstanceBackup -BackupInstanceName -ResourceGroupName [-SubscriptionId ] -VaultName [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] - [-WhatIf] [-Confirm] [] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### SuspendViaIdentity ``` Suspend-AzDataProtectionBackupInstanceBackup -InputObject - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -131,6 +132,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -222,26 +238,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[BackupInstanceName ]`: The name of the backup instance. - - `[BackupPolicyName ]`: - - `[Id ]`: Resource identity path - - `[JobId ]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). - - `[Location ]`: The location in which uniqueness will be verified. - - `[OperationId ]`: - - `[RecoveryPointId ]`: - - `[RequestName ]`: - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceGuardProxyName ]`: name of the resource guard proxy - - `[ResourceGuardsName ]`: The name of ResourceGuard - - `[SubscriptionId ]`: The ID of the target subscription. The value must be an UUID. - - `[VaultName ]`: The name of the backup vault. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Sync-AzDataProtectionBackupInstance.md b/src/DataProtection/DataProtection/help/Sync-AzDataProtectionBackupInstance.md index 0320f50bcd4f..a36bdedb4846 100644 --- a/src/DataProtection/DataProtection/help/Sync-AzDataProtectionBackupInstance.md +++ b/src/DataProtection/DataProtection/help/Sync-AzDataProtectionBackupInstance.md @@ -15,7 +15,7 @@ Sync backup instance again in case of failure\r\nThis action will retry last fai ``` Sync-AzDataProtectionBackupInstance -Name -ResourceGroupName -VaultName [-SubscriptionId ] [-SyncType ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] - [-WhatIf] [-Confirm] [] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -109,6 +109,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -214,6 +229,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Test-AzDataProtectionBackupInstanceReadiness.md b/src/DataProtection/DataProtection/help/Test-AzDataProtectionBackupInstanceReadiness.md index 436e446b6d21..19759b75826f 100644 --- a/src/DataProtection/DataProtection/help/Test-AzDataProtectionBackupInstanceReadiness.md +++ b/src/DataProtection/DataProtection/help/Test-AzDataProtectionBackupInstanceReadiness.md @@ -15,7 +15,7 @@ Validate whether adhoc backup will be successful or not ``` Test-AzDataProtectionBackupInstanceReadiness -ResourceGroupName -VaultName [-SubscriptionId ] -BackupInstance [-DefaultProfile ] [-AsJob] [-NoWait] - [-WhatIf] [-Confirm] [] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -104,6 +104,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -189,49 +204,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IOperationJobExtendedInfo +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IOperationJobExtendedInfo ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BACKUPINSTANCE `: Backup Instance - - `DataSourceInfo `: Gets or sets the data source information. - - `ResourceId `: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. - - `[ObjectType ]`: Type of Datasource object, used to initialize the right inherited type - - `[ResourceLocation ]`: Location of datasource. - - `[ResourceName ]`: Unique identifier of the resource in the context of parent. - - `[ResourceType ]`: Resource Type of Datasource. - - `[ResourceUri ]`: Uri of the resource. - - `[Type ]`: DatasourceType of the resource. - - `ObjectType `: - - `PolicyInfo `: Gets or sets the policy information. - - `PolicyId `: - - `[PolicyParameter ]`: Policy parameters for the backup instance - - `[BackupDatasourceParametersList ]`: Gets or sets the Backup Data Source Parameters - - `ObjectType `: Type of the specific object - used for deserializing - - `[DataStoreParametersList ]`: Gets or sets the DataStore Parameters - - `DataStoreType `: type of datastore; Operational/Vault/Archive - - `ObjectType `: Type of the specific object - used for deserializing - - `[DataSourceSetInfo ]`: Gets or sets the data source set information. - - `ResourceId `: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. - - `[DatasourceType ]`: DatasourceType of the resource. - - `[ObjectType ]`: Type of Datasource object, used to initialize the right inherited type - - `[ResourceLocation ]`: Location of datasource. - - `[ResourceName ]`: Unique identifier of the resource in the context of parent. - - `[ResourceType ]`: Resource Type of Datasource. - - `[ResourceUri ]`: Uri of the resource. - - `[DatasourceAuthCredentials ]`: Credentials to use to authenticate with data source provider. - - `ObjectType `: Type of the specific object - used for deserializing - - `[FriendlyName ]`: Gets or sets the Backup Instance friendly name. - - `[IdentityDetail ]`: Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned. - - `[UseSystemAssignedIdentity ]`: Specifies if the BI is protected by System Identity. - - `[UserAssignedIdentityArmUrl ]`: ARM URL for User Assigned Identity. - - `[ValidationType ]`: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Test-AzDataProtectionBackupInstanceRestore.md b/src/DataProtection/DataProtection/help/Test-AzDataProtectionBackupInstanceRestore.md index 9e44a396e1a5..1da05b7bedde 100644 --- a/src/DataProtection/DataProtection/help/Test-AzDataProtectionBackupInstanceRestore.md +++ b/src/DataProtection/DataProtection/help/Test-AzDataProtectionBackupInstanceRestore.md @@ -15,7 +15,8 @@ Validates if Restore can be triggered for a DataSource ``` Test-AzDataProtectionBackupInstanceRestore -ResourceGroupName -Name -VaultName -RestoreRequest [-SubscriptionId ] [-RestoreToSecondaryRegion] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -34,6 +35,14 @@ $validateRestore = Test-AzDataProtectionBackupInstanceRestore -Name $instances[0 The command tests the restore request object is valid for restore +### Example 2: Validate cross region restore +```powershell +$validateRestore = Test-AzDataProtectionBackupInstanceRestore -ResourceGroupName $ResourceGroupName -Name $instance[0].Name -VaultName $VaultName -RestoreRequest $RestoreRequestObject -SubscriptionId $SubscriptionId -RestoreToSecondaryRegion +``` + +The command tests the restore request object is valid for cross region restore. +For normal restore (non-CRR), DO NOT use RestoreToSecondaryRegion switch. + ## PARAMETERS ### -AsJob @@ -93,6 +102,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group where the backup vault is present @@ -134,7 +158,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -207,25 +231,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IOperationJobExtendedInfo +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IOperationJobExtendedInfo ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`RESTOREREQUEST `: Restore request object for which to validate - - `ObjectType `: - - `RestoreTargetInfo `: Gets or sets the restore target information. - - `ObjectType `: Type of Datasource object, used to initialize the right inherited type - - `[RestoreLocation ]`: Target Restore region - - `SourceDataStoreType `: Gets or sets the type of the source data store. - - `[IdentityDetailUseSystemAssignedIdentity ]`: Specifies if the BI is protected by System Identity. - - `[IdentityDetailUserAssignedIdentityArmUrl ]`: ARM URL for User Assigned Identity. - - `[SourceResourceId ]`: Fully qualified Azure Resource Manager ID of the datasource which is being recovered. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Undo-AzDataProtectionBackupInstanceDeletion.md b/src/DataProtection/DataProtection/help/Undo-AzDataProtectionBackupInstanceDeletion.md index 9c7236156aac..ea5a347e0135 100644 --- a/src/DataProtection/DataProtection/help/Undo-AzDataProtectionBackupInstanceDeletion.md +++ b/src/DataProtection/DataProtection/help/Undo-AzDataProtectionBackupInstanceDeletion.md @@ -16,13 +16,13 @@ Undeletes a soft deleted backup instance ``` Undo-AzDataProtectionBackupInstanceDeletion -BackupInstanceName -ResourceGroupName [-SubscriptionId ] -VaultName [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] - [-WhatIf] [-Confirm] [] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UndeleteViaIdentity ``` Undo-AzDataProtectionBackupInstanceDeletion -InputObject [-DefaultProfile ] - [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -133,6 +133,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -224,26 +239,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[BackupInstanceName ]`: The name of the backup instance. - - `[BackupPolicyName ]`: - - `[Id ]`: Resource identity path - - `[JobId ]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). - - `[Location ]`: The location in which uniqueness will be verified. - - `[OperationId ]`: - - `[RecoveryPointId ]`: - - `[RequestName ]`: - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceGuardProxyName ]`: name of the resource guard proxy - - `[ResourceGuardsName ]`: The name of ResourceGuard - - `[SubscriptionId ]`: The ID of the target subscription. The value must be an UUID. - - `[VaultName ]`: The name of the backup vault. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Unlock-AzDataProtectionResourceGuardOperation.md b/src/DataProtection/DataProtection/help/Unlock-AzDataProtectionResourceGuardOperation.md index a1edb79d1e7c..5924951cc949 100644 --- a/src/DataProtection/DataProtection/help/Unlock-AzDataProtectionResourceGuardOperation.md +++ b/src/DataProtection/DataProtection/help/Unlock-AzDataProtectionResourceGuardOperation.md @@ -15,7 +15,8 @@ Unlocks the critical operation which is protected by the resource guard ``` Unlock-AzDataProtectionResourceGuardOperation -ResourceGroupName -VaultName [-SubscriptionId ] [-ResourceGuardOperationRequest ] [-ResourceToBeDeleted ] - [-Token ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-Token ] [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -111,6 +112,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Resource Group name of the backup vault @@ -246,6 +262,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Update-AzDataProtectionBackupInstanceAssociatedPolicy.md b/src/DataProtection/DataProtection/help/Update-AzDataProtectionBackupInstanceAssociatedPolicy.md index 11eb5b557f76..f6ccf76df879 100644 --- a/src/DataProtection/DataProtection/help/Update-AzDataProtectionBackupInstanceAssociatedPolicy.md +++ b/src/DataProtection/DataProtection/help/Update-AzDataProtectionBackupInstanceAssociatedPolicy.md @@ -15,7 +15,7 @@ Updates associated policy for a given backup instance ``` Update-AzDataProtectionBackupInstanceAssociatedPolicy -ResourceGroupName -VaultName -BackupInstanceName -PolicyId [-SubscriptionId ] [-DefaultProfile ] - [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -113,6 +113,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Resource Group of the backup vault @@ -196,10 +211,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IBackupInstanceResource +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IBackupInstanceResource ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Update-AzDataProtectionBackupVault.md b/src/DataProtection/DataProtection/help/Update-AzDataProtectionBackupVault.md index e748de18b484..a7c5b30e301f 100644 --- a/src/DataProtection/DataProtection/help/Update-AzDataProtectionBackupVault.md +++ b/src/DataProtection/DataProtection/help/Update-AzDataProtectionBackupVault.md @@ -20,7 +20,8 @@ Update-AzDataProtectionBackupVault -ResourceGroupName [-SubscriptionId [-CrossSubscriptionRestoreState ] [-IdentityType ] [-IdentityUserAssignedIdentity ] [-ImmutabilityState ] [-SoftDeleteRetentionDurationInDay ] [-SoftDeleteState ] [-Tag ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaIdentityExpanded @@ -30,7 +31,8 @@ Update-AzDataProtectionBackupVault -InputObject [-CrossSubscriptionRestoreState ] [-IdentityType ] [-IdentityUserAssignedIdentity ] [-ImmutabilityState ] [-SoftDeleteRetentionDurationInDay ] [-SoftDeleteState ] [-Tag ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -241,6 +243,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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. @@ -374,30 +391,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IBackupVaultResource +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IBackupVaultResource ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[BackupInstanceName ]`: The name of the backup instance. - - `[BackupPolicyName ]`: - - `[Id ]`: Resource identity path - - `[JobId ]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). - - `[Location ]`: The location in which uniqueness will be verified. - - `[OperationId ]`: - - `[RecoveryPointId ]`: - - `[RequestName ]`: - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceGuardProxyName ]`: name of the resource guard proxy - - `[ResourceGuardsName ]`: The name of ResourceGuard - - `[SubscriptionId ]`: The ID of the target subscription. The value must be an UUID. - - `[VaultName ]`: The name of the backup vault. - ## RELATED LINKS diff --git a/src/DataProtection/DataProtection/help/Update-AzDataProtectionResourceGuard.md b/src/DataProtection/DataProtection/help/Update-AzDataProtectionResourceGuard.md index 47f8090c3bed..915cb5e4358e 100644 --- a/src/DataProtection/DataProtection/help/Update-AzDataProtectionResourceGuard.md +++ b/src/DataProtection/DataProtection/help/Update-AzDataProtectionResourceGuard.md @@ -15,7 +15,7 @@ Updates a resource guard belonging to a resource group ``` Update-AzDataProtectionResourceGuard -ResourceGroupName -Name [-SubscriptionId ] [-ETag ] [-IdentityType ] [-Tag ] [-CriticalOperationExclusionList ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -119,6 +119,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Resource Group name of the resource guard @@ -202,10 +217,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20230501.IResourceGuardResource +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20231101.IResourceGuardResource ## NOTES -ALIASES - ## RELATED LINKS