New-AzureStorSimpleDeviceBackupScheduleAddConfig
Creates a backup schedule 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-AzureStorSimpleDeviceBackupScheduleAddConfig
-BackupType <String>
-RecurrenceType <String>
-RecurrenceValue <Int32>
-RetentionCount <Int64>
[-StartFromDateTime <String>]
-Enabled <Boolean>
[-Profile <AzureSMProfile>]
[<CommonParameters>]
Description
The New-AzureStorSimpleDeviceBackupScheduleAddConfig cmdlet creates a BackupScheduleBase configuration object. Use this configuration object to create new backup policy by using the New-AzureStorSimpleDeviceBackupPolicy cmdlet.
Examples
Example 1: Create a backup configuration object
PS C:\>New-AzureStorSimpleDeviceBackupScheduleAddConfig -BackupType CloudSnapshot -RecurrenceType Daily -RecurrenceValue 1 -RetentionCount 100 -Enabled $True
VERBOSE: ClientRequestId: 426a79ee-fed3-4d3d-9123-e371f83222b3_PS
BackupType : CloudSnapshot
Recurrence : Microsoft.WindowsAzure.Management.StorSimple.Models.ScheduleRecurrence
RetentionCount : 100
StartTime : 2014-12-16T00:37:19+05:30
Status : Enabled
This command creates a backup schedule base object for cloud snapshot backups. The backup occurs every day, and the backups are kept for 100 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: | 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
BackupScheduleBase
This cmdlet returns a BackupScheduleBase object. Use a BackupScheduleBase to construct new backup policy.