Set-AzsBackupConfiguration
Set the backup configuration at the specified location.
Syntax
Set-AzsBackupConfiguration
[-ResourceGroupName <String>]
[-Location <String>]
[-Path <String>]
[-Username <String>]
[-Password <SecureString>]
[-EncryptionKey <SecureString>]
[-IsBackupSchedulerEnabled <Boolean>]
[-BackupFrequencyInHours <Int32>]
[-BackupRetentionPeriodInDays <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzsBackupConfiguration
-InputObject <BackupLocation>
[-Path <String>]
[-Username <String>]
[-Password <SecureString>]
[-EncryptionKey <SecureString>]
[-IsBackupSchedulerEnabled <Boolean>]
[-BackupFrequencyInHours <Int32>]
[-BackupRetentionPeriodInDays <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzsBackupConfiguration
-ResourceId <String>
[-Path <String>]
[-Username <String>]
[-Password <SecureString>]
[-EncryptionKey <SecureString>]
[-IsBackupSchedulerEnabled <Boolean>]
[-BackupFrequencyInHours <Int32>]
[-BackupRetentionPeriodInDays <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Set the backup configuration at the specified location.
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-AzsBackupConfiguration -Path "\\***.***.***.***\Share" -Username "asdomain1\azurestackadmin" -Password $password -EncryptionKey $encryptionKeySet Azure Stack backup configuration.
Parameters
-AsJob
Run asynchronous as a job and return the job object.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BackupFrequencyInHours
The interval, in hours, for the frequency that the scheduler takes a backup.
| Type: | Int32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BackupRetentionPeriodInDays
The retention period, in days, for backups in the storage location.
| Type: | Int32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EncryptionKey
Encryption key used to encrypt backups.
| Type: | SecureString |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Backup location configuration returned by Get-AzsBackupConfiguration.
| Type: | BackupLocation |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IsBackupSchedulerEnabled
Whether the backup scheduler should be enabled.
| Type: | Boolean |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Location
Location to configure.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Password
Password required to access backup location.
| Type: | SecureString |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Path
Location where backups will be stored.
| Type: | String |
| Aliases: | BackupShare |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
Name of the resource group.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceId
The resource id.
| Type: | String |
| Aliases: | id |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Username
Username required to access backup location.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Outputs
Microsoft.AzureStack.Management.Backup.Admin.Models.BackupLocation