Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion src/DataProtection/DataProtection.Autorest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
This directory contains the PowerShell module for the DataProtection service.

---

## Info
- Modifiable: yes
- Generated: all
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
12 changes: 6 additions & 6 deletions src/DataProtection/DataProtection/Az.DataProtection.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#
# Generated by: Microsoft Corporation
#
# Generated on: 12/27/2023
# Generated on: 3/17/2024
#

@{
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -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'
Expand All @@ -168,7 +168,7 @@ PrivateData = @{

} # End of PSData hashtable

} # End of PrivateData hashtable
} # End of PrivateData hashtable

# HelpInfo URI of this module
# HelpInfoURI = ''
Expand Down
5 changes: 4 additions & 1 deletion src/DataProtection/DataProtection/help/Az.DataProtection.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ Trigger adhoc backup
```
Backup-AzDataProtectionBackupInstanceAdhoc -BackupInstanceName <String> -ResourceGroupName <String>
[-SubscriptionId <String>] -VaultName <String> -BackupRuleOptionRuleName <String>
[-TriggerOptionRetentionTagOverride <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf]
[-Confirm] [<CommonParameters>]
[-TriggerOptionRetentionTagOverride <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### BackupViaIdentityExpanded
```
Backup-AzDataProtectionBackupInstanceAdhoc -InputObject <IDataProtectionIdentity>
-BackupRuleOptionRuleName <String> [-TriggerOptionRetentionTagOverride <String>] [-DefaultProfile <PSObject>]
[-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>]
[-AsJob] [-NoWait] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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 <IDataProtectionIdentity>`: Identity Parameter
- `[BackupInstanceName <String>]`: The name of the backup instance.
- `[BackupPolicyName <String>]`:
- `[Id <String>]`: Resource identity path
- `[JobId <String>]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
- `[Location <String>]`: The location in which uniqueness will be verified.
- `[OperationId <String>]`:
- `[RecoveryPointId <String>]`:
- `[RequestName <String>]`:
- `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive.
- `[ResourceGuardProxyName <String>]`: name of the resource guard proxy
- `[ResourceGuardsName <String>]`: The name of ResourceGuard
- `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID.
- `[VaultName <String>]`: The name of the backup vault.

## RELATED LINKS
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,14 @@ Adds or removes Retention Rule to existing Policy
### RemoveRetention (Default)
```
Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy <IBackupPolicy> -Name <RetentionRuleName>
[-RemoveRule] [<CommonParameters>]
[-RemoveRule] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### AddRetention
```
Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy <IBackupPolicy> -Name <RetentionRuleName>
-IsDefault <Boolean> -LifeCycles <ISourceLifeCycle[]> [-OverwriteLifeCycle <Boolean>] [<CommonParameters>]
-IsDefault <Boolean> -LifeCycles <ISourceLifeCycle[]> [-OverwriteLifeCycle <Boolean>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -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.

Expand All @@ -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 <ISourceLifeCycle[]>`: Life cycles associated with the retention rule.
- `DeleteAfterDuration <String>`: Duration of deletion after given timespan
- `DeleteAfterObjectType <String>`: Type of the specific object - used for deserializing
- `SourceDataStoreObjectType <String>`: Type of Datasource object, used to initialize the right inherited type
- `SourceDataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive
- `[TargetDataStoreCopySetting <ITargetCopySetting[]>]`:
- `CopyAfterObjectType <String>`: Type of the specific object - used for deserializing
- `DataStoreObjectType <String>`: Type of Datasource object, used to initialize the right inherited type
- `DataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive

`POLICY <IBackupPolicy>`: Backup Policy Object
- `DatasourceType <String[]>`: Type of datasource for the backup management
- `ObjectType <String>`:
- `PolicyRule <IBasePolicyRule[]>`: Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc
- `Name <String>`:
- `ObjectType <String>`:
- `DataStoreObjectType <String>`: Type of Datasource object, used to initialize the right inherited type
- `DataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive
- `TriggerObjectType <String>`: Type of the specific object - used for deserializing
- `Lifecycle <ISourceLifeCycle[]>`:
- `DeleteAfterDuration <String>`: Duration of deletion after given timespan
- `DeleteAfterObjectType <String>`: Type of the specific object - used for deserializing
- `SourceDataStoreObjectType <String>`: Type of Datasource object, used to initialize the right inherited type
- `SourceDataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive
- `[TargetDataStoreCopySetting <ITargetCopySetting[]>]`:
- `CopyAfterObjectType <String>`: Type of the specific object - used for deserializing
- `DataStoreObjectType <String>`: Type of Datasource object, used to initialize the right inherited type
- `DataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive
- `[BackupParameterObjectType <String>]`: Type of the specific object - used for deserializing
- `[IsDefault <Boolean?>]`:

## RELATED LINKS
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ Adds or removes schedule tag in an existing backup policy.
### RemoveTag (Default)
```
Edit-AzDataProtectionPolicyTagClientObject -Policy <IBackupPolicy> -Name <TagName> [-RemoveRule]
[<CommonParameters>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### updateTag
```
Edit-AzDataProtectionPolicyTagClientObject -Policy <IBackupPolicy> -Name <TagName>
-Criteria <IScheduleBasedBackupCriteria[]> [<CommonParameters>]
-Criteria <IScheduleBasedBackupCriteria[]> [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -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.

Expand All @@ -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 <IScheduleBasedBackupCriteria[]>`: Criterias to be associated with the schedule tag.
- `ObjectType <String>`: Type of the specific object - used for deserializing
- `[AbsoluteCriterion <AbsoluteMarker[]>]`: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" and should be part of AbsoluteMarker enum
- `[DaysOfMonth <IDay[]>]`: This is day of the month from 1 to 28 other wise last of month
- `[Date <Int32?>]`: Date of the month
- `[IsLast <Boolean?>]`: Whether Date is last date of month
- `[DaysOfTheWeek <DayOfWeek[]>]`: It should be Sunday/Monday/T..../Saturday
- `[MonthsOfYear <Month[]>]`: It should be January/February/....../December
- `[ScheduleTime <DateTime[]>]`: List of schedule times for backup
- `[WeeksOfTheMonth <WeekNumber[]>]`: It should be First/Second/Third/Fourth/Last

`POLICY <IBackupPolicy>`: Backup Policy Object.
- `DatasourceType <String[]>`: Type of datasource for the backup management
- `ObjectType <String>`:
- `PolicyRule <IBasePolicyRule[]>`: Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc
- `Name <String>`:
- `ObjectType <String>`:
- `DataStoreObjectType <String>`: Type of Datasource object, used to initialize the right inherited type
- `DataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive
- `TriggerObjectType <String>`: Type of the specific object - used for deserializing
- `Lifecycle <ISourceLifeCycle[]>`:
- `DeleteAfterDuration <String>`: Duration of deletion after given timespan
- `DeleteAfterObjectType <String>`: Type of the specific object - used for deserializing
- `SourceDataStoreObjectType <String>`: Type of Datasource object, used to initialize the right inherited type
- `SourceDataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive
- `[TargetDataStoreCopySetting <ITargetCopySetting[]>]`:
- `CopyAfterObjectType <String>`: Type of the specific object - used for deserializing
- `DataStoreObjectType <String>`: Type of Datasource object, used to initialize the right inherited type
- `DataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive
- `[BackupParameterObjectType <String>]`: Type of the specific object - used for deserializing
- `[IsDefault <Boolean?>]`:

## RELATED LINKS
Loading