Skip to content

Latest commit

 

History

History
149 lines (115 loc) · 3.75 KB

New-AzDataProtectionRetentionLifeCycleClientObject.md

File metadata and controls

149 lines (115 loc) · 3.75 KB
external help file Module Name online version schema
Az.DataProtection-help.xml
Az.DataProtection
2.0.0

New-AzDataProtectionRetentionLifeCycleClientObject

SYNOPSIS

Creates new Lifecycle object

SYNTAX

New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore <DataStoreType>
 -SourceRetentionDurationType <DurationType> -SourceRetentionDurationCount <Int32>
 [-TargetDataStore <DataStoreType>] [-CopyOption <CopyOption>]
 [<CommonParameters>]

DESCRIPTION

Creates new Lifecycle object

EXAMPLES

Example 1: Create a daily retention lifecycle

New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore OperationalStore -SourceRetentionDurationType Days -SourceRetentionDurationCount 30
DeleteAfterDuration        : P30D
DeleteAfterObjectType      : AbsoluteDeleteOption
SourceDataStoreObjectType  : DataStoreInfoBase
SourceDataStoreType        : OperationalStore
TargetDataStoreCopySetting :

This command creates a lifecycle object which stores the backup data in operational store for 30 days.

Example 2: Create a weekly retention lifecycle.

New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore OperationalStore -SourceRetentionDurationType Weeks -SourceRetentionDurationCount 20
DeleteAfterDuration        : P20W
DeleteAfterObjectType      : AbsoluteDeleteOption
SourceDataStoreObjectType  : DataStoreInfoBase
SourceDataStoreType        : OperationalStore
TargetDataStoreCopySetting :

This command creates a lifecycle object which stores the backup data in operational store for 20 weeks.

PARAMETERS

-CopyOption

CopyOption

Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.CopyOption
Parameter Sets: (All)
Aliases:
Accepted values: CustomCopyOption, ImmediateCopyOption, CopyOnExpiryOption

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SourceDataStore

Source Datastore

Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.DataStoreType
Parameter Sets: (All)
Aliases:
Accepted values: ArchiveStore, OperationalStore, VaultStore

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SourceRetentionDurationCount

Retention Duration Count

Type: System.Int32
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SourceRetentionDurationType

Retention Duration Type

Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.DurationType
Parameter Sets: (All)
Aliases:
Accepted values: Days, Weeks, Months, Years

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TargetDataStore

Target Datastore

Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.DataStoreType
Parameter Sets: (All)
Aliases:
Accepted values: ArchiveStore, OperationalStore, VaultStore

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.

INPUTS

OUTPUTS

Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20240401.ISourceLifeCycle

NOTES

RELATED LINKS