New-AzureStorSimpleDeviceBackupScheduleUpdateConfig

  • Reference
Module:
Azure

Creates a backup schedule update configuration object.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

New-AzureStorSimpleDeviceBackupScheduleUpdateConfig
   -Id <String>
   -BackupType <String>
   -RecurrenceType <String>
   -RecurrenceValue <Int32>
   -RetentionCount <Int64>
   [-StartFromDateTime <String>]
   [-Enabled <Boolean>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

The New-AzureStorSimpleDeviceBackupScheduleUpdateConfig cmdlet creates a BackupScheduleUpdateRequest configuration object. Use this configuration object to update a backup policy by using the Set-AzureStorSimpleDeviceBackupPolicy cmdlet.

Examples

Example 1: Create a schedule update request

PS C:\>New-AzureStorSimpleDeviceBackupScheduleUpdateConfig -Id "147f734d-a31a-4473-8501-6ba38be2cb30" -BackupType CloudSnapshot -RecurrenceType Hourly -RecurrenceValue 1 -RetentionCount 50 -Enabled $True
VERBOSE: ClientRequestId: ef346641-54b4-4273-8898-7f863e7c5b7e_PS


BackupType     : CloudSnapshot
Id             : 147f734d-a31a-4473-8501-6ba38be2cb30
Recurrence     : Microsoft.WindowsAzure.Management.StorSimple.Models.ScheduleRecurrence
RetentionCount : 50
StartTime      : 2014-12-16T00:39:32+05:30
Status         : Enabled

This command creates a backup schedule update request for the schedule that has the specified ID. The request is to make the schedule a cloud snapshot backup that recurs every hour. The backups are kept for 50 days. This schedule is enabled from the default time, which is the current time.

Parameters

-BackupType

Specifies the backup type. Valid values are: LocalSnapshot and CloudSnapshot.

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

-Enabled

Indicates whether to enable the backup schedule.

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

-Id

Specifies the instance ID of the backup schedule to update.

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

-Profile

Specifies an Azure profile.

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

-RecurrenceType

Specifies the type of recurrence for this backup schedule. Valid values are:

  • Minutes
  • Hourly
  • Daily
  • Weekly
Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-RecurrenceValue

Specifies how often to make a backup. This parameter uses the unit specified by the RecurrenceType parameter.

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

-RetentionCount

Specifies the number of days to keep a backup.

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

-StartFromDateTime

Specifies the date from which to start making backups. The default value is the current time.

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

Inputs

None

Outputs

BackupScheduleUpdateRequest

This cmdlet returns a BackupScheduleUpdateRequest object that contains information about updated backup schedules.