Set-AzsBackupConfiguration
Update a backup location.
Syntax
Set-AzsBackupConfiguration
[-Location <String>]
[-ResourceGroupName <String>]
[-SubscriptionId <String>]
[-BackupFrequencyInHours <Int32>]
[-BackupRetentionPeriodInDays <Int32>]
[-EncryptionCertPath <String>]
[-IsBackupSchedulerEnabled]
[-Password <SecureString>]
[-Path <String>]
[-Tag <Hashtable>]
[-UserName <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-Confirm]
[-WhatIf]
[<CommonParameters>] Set-AzsBackupConfiguration
-Backup \<IBackupLocation>
[-Location <String>]
[-ResourceGroupName <String>]
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-Confirm]
[-WhatIf]
[<CommonParameters>] Description
Update a backup location.
Examples
Example 1: Set backup configuration
PS C:\> Set-AzsBackupConfiguration -Path "\\***.***.***.***\Share" -Username "asdomain1\azurestackadmin" -Password $password -EncryptionCertPath $encryptionCertPathSet Azure Stack backup configuration.
Parameters
-AsJob
Run the command as a job
| Type: | System.Management.Automation.SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Backup
Information about the backup location. To construct, see NOTES section for BACKUP properties and create a hash table.
| Type: | Microsoft.Azure.PowerShell.Cmdlets.BackupAdmin.Models.Api20180901.IBackupLocation |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-BackupFrequencyInHours
The interval, in hours, for the frequency that the scheduler takes a backup.
| Type: | System.Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BackupRetentionPeriodInDays
The retention period, in days, for backs in the storage location.
| Type: | System.Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | System.Management.Automation.SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | System.Management.Automation.PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EncryptionCertPath
Path to the encryption cert file with public key (.cer).
| Type: | System.String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IsBackupSchedulerEnabled
True if the backup scheduler is enabled.
| Type: | System.Management.Automation.SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Location
Name of the backup location.
| Type: | System.String |
| Position: | Named |
| Default value: | (Get-AzLocation)[0].Location |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NoWait
Run the command asynchronously
| Type: | System.Management.Automation.SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Password
Password to access the location.
| Type: | System.Security.SecureString |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Path
Path to the update location
| Type: | System.String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
Name of the resource group.
| Type: | System.String |
| Position: | Named |
| Default value: | "system.$((Get-AzLocation)[0].Location)" |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
| Type: | System.String |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Tag
List of key value pairs.
| Type: | System.Collections.Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserName
Username to access the location.
| Type: | System.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: | System.Management.Automation.SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.Azure.PowerShell.Cmdlets.BackupAdmin.Models.Api20180901.IBackupLocation
Outputs
Microsoft.Azure.PowerShell.Cmdlets.BackupAdmin.Models.Api20180901.IBackupLocation
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.
BACKUP <IBackupLocation>: Information about the backup location.
[Location <String>]: Location of the resource.[Tag \<IResourceTags>]: List of key value pairs.[(Any) <String>]: This indicates any property can be added to this object.
[BackupFrequencyInHours <Int32?>]: The interval, in hours, for the frequency that the scheduler takes a backup.[BackupRetentionPeriodInDays <Int32?>]: The retention period, in days, for backs in the storage location.[EncryptionCertBase64 <String>]: The base64 raw data for the backup encryption certificate.[IsBackupSchedulerEnabled <Boolean?>]: True if the backup scheduler is enabled.[Password <String>]: Password to access the location.[Path <String>]: Path to the update location[UserName <String>]: Username to access the location.