Regenerated Documentation, fix a typo
This commit is contained in:
Jeffrey A. Robinson
Родитель
70845d2f95
Коммит
684552b88f
|
|
@ -8,23 +8,23 @@ Locale: en-US
|
|||
|
||||
# Azs.Backup.Admin Module
|
||||
## Description
|
||||
Preview release of the Backup administrator module that allows administrators to
|
||||
- Configure where backups are stored
|
||||
- Perform backups
|
||||
- List and restore completed backup
|
||||
{{Manually Enter Description Here}}
|
||||
|
||||
## Azs.Backup.Admin Cmdlets
|
||||
### [Get-AzsBackup](Get-AzsBackup.md)
|
||||
Returns a backup from a location based on name.
|
||||
|
||||
### [Get-AzsBackupLocation](Get-AzsBackupLocation.md)
|
||||
Returns the list of backup locations.
|
||||
### [Get-AzsBackupConfiguration](Get-AzsBackupConfiguration.md)
|
||||
Returns the list of backup configurations.
|
||||
|
||||
### [New-AzsEncryptionKeyBase64](New-AzsEncryptionKeyBase64.md)
|
||||
Generate encryption key for infrastructure backups.
|
||||
|
||||
### [Restore-AzsBackup](Restore-AzsBackup.md)
|
||||
Restore a backup.
|
||||
|
||||
### [Set-AzsBackupShare](Set-AzsBackupShare.md)
|
||||
Create a new backup location.
|
||||
### [Set-AzsBackupConfiguration](Set-AzsBackupConfiguration.md)
|
||||
Set the backup configuration at the specified location.
|
||||
|
||||
### [Start-AzsBackup](Start-AzsBackup.md)
|
||||
Back up a specific location.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
external help file: Azs.Backup.Admin-help.xml
|
||||
Module Name: Azs.Backup.Admin
|
||||
online version:
|
||||
online version:
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
|
|
@ -38,14 +38,14 @@ Returns a backup from a location based on name.
|
|||
|
||||
## EXAMPLES
|
||||
|
||||
### EXAMPLE 1
|
||||
### -------------------------- EXAMPLE 1 --------------------------
|
||||
```
|
||||
Get-AzsBackup
|
||||
```
|
||||
|
||||
Get information sbout all Azure Stack backups.
|
||||
|
||||
### EXAMPLE 2
|
||||
### -------------------------- EXAMPLE 2 --------------------------
|
||||
```
|
||||
Get-AzsBackup -Name 'backupName'
|
||||
```
|
||||
|
|
@ -54,13 +54,28 @@ Get information for the the specified Azure Stack backup.
|
|||
|
||||
## PARAMETERS
|
||||
|
||||
### -Location
|
||||
Location backed up.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: List, Get
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Name
|
||||
Name of the backup.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: Get
|
||||
Aliases:
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
|
|
@ -69,13 +84,28 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Location
|
||||
Location backed up.
|
||||
### -ParentResource
|
||||
Passing a backup location will return the list of all backups at that backup location.
|
||||
|
||||
```yaml
|
||||
Type: BackupLocation
|
||||
Parameter Sets: ParentResource
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ResourceGroupName
|
||||
Name of the resource group.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: List, Get
|
||||
Aliases:
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
|
|
@ -99,45 +129,13 @@ Accept pipeline input: True (ByPropertyName)
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ResourceGroupName
|
||||
Name of the resource group.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: List, Get
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ParentResource
|
||||
Passing a backup location will return the list of all backups at that backup location.
|
||||
|
||||
```yaml
|
||||
Type: BackupLocation
|
||||
Parameter Sets: ParentResource
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Top
|
||||
Return the top N items as specified by the parameter value.
|
||||
Applies after the -Skip parameter.
|
||||
|
||||
### -Skip
|
||||
{{Fill Skip Description}}
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: List, ParentResource
|
||||
Aliases:
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
|
|
@ -146,13 +144,13 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Skip
|
||||
Skip the first N items as specified by the parameter value.
|
||||
### -Top
|
||||
{{Fill Top Description}}
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: List, ParentResource
|
||||
Aliases:
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
|
|
@ -173,3 +171,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
|
|||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
|
||||
|
|
|
|||
|
|
@ -1,40 +1,40 @@
|
|||
---
|
||||
external help file: Azs.Backup.Admin-help.xml
|
||||
Module Name: Azs.Backup.Admin
|
||||
online version:
|
||||
online version:
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-AzsBackupLocation
|
||||
# Get-AzsBackupConfiguration
|
||||
|
||||
## SYNOPSIS
|
||||
Returns the list of backup locations.
|
||||
Returns the list of backup configurations.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
### List (Default)
|
||||
```
|
||||
Get-AzsBackupLocation [-ResourceGroupName <String>] [-Skip <Int32>] [-Top <Int32>] [<CommonParameters>]
|
||||
Get-AzsBackupConfiguration [-ResourceGroupName <String>] [-Skip <Int32>] [-Top <Int32>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### Get
|
||||
```
|
||||
Get-AzsBackupLocation [[-Location] <String>] [-ResourceGroupName <String>] [<CommonParameters>]
|
||||
Get-AzsBackupConfiguration [[-Location] <String>] [-ResourceGroupName <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### ResourceId
|
||||
```
|
||||
Get-AzsBackupLocation -ResourceId <String> [<CommonParameters>]
|
||||
Get-AzsBackupConfiguration -ResourceId <String> [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Returns the list of backup locations.
|
||||
Returns the list of backup configurations.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### EXAMPLE 1
|
||||
### -------------------------- EXAMPLE 1 --------------------------
|
||||
```
|
||||
Get-AzsBackupLocation
|
||||
Get-AzsBackupConfiguration
|
||||
```
|
||||
|
||||
Get Azure Stack backup configuration.
|
||||
|
|
@ -42,12 +42,12 @@ Get Azure Stack backup configuration.
|
|||
## PARAMETERS
|
||||
|
||||
### -Location
|
||||
Location to backup.
|
||||
Backup location.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: Get
|
||||
Aliases:
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 1
|
||||
|
|
@ -56,6 +56,21 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ResourceGroupName
|
||||
Name of the resource group.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: List, Get
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ResourceId
|
||||
The resource id.
|
||||
|
||||
|
|
@ -71,28 +86,13 @@ Accept pipeline input: True (ByPropertyName)
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ResourceGroupName
|
||||
Name of the resource group.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: List, Get
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Skip
|
||||
Skip the first N items as specified by the parameter value.
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: List
|
||||
Aliases:
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
|
|
@ -108,7 +108,7 @@ Applies after the -Skip parameter.
|
|||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: List
|
||||
Aliases:
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
|
|
@ -129,3 +129,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
|
|||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
---
|
||||
external help file: Azs.Backup.Admin-help.xml
|
||||
Module Name: Azs.Backup.Admin
|
||||
online version:
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# New-AzsEncryptionKeyBase64
|
||||
|
||||
## SYNOPSIS
|
||||
Generate encryption key for infrastructure backups.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
New-AzsEncryptionKeyBase64 [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Generate encryption key for infrastructure backups.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### -------------------------- EXAMPLE 1 --------------------------
|
||||
```
|
||||
New-AzsEncryptionKeyBase64
|
||||
```
|
||||
|
||||
Generate encryption key for infrastructure backups.
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### 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 (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||
|
||||
## INPUTS
|
||||
|
||||
## OUTPUTS
|
||||
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
external help file: Azs.Backup.Admin-help.xml
|
||||
Module Name: Azs.Backup.Admin
|
||||
online version:
|
||||
online version:
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
|
|
@ -28,7 +28,7 @@ Restore a backup.
|
|||
|
||||
## EXAMPLES
|
||||
|
||||
### EXAMPLE 1
|
||||
### -------------------------- EXAMPLE 1 --------------------------
|
||||
```
|
||||
Restore-AzsBackup -Backup 4e90bd2f-c7ab-47a3-a3c7-908cddd1ad0e
|
||||
```
|
||||
|
|
@ -37,73 +37,13 @@ Restore from an Azure Stack backup.
|
|||
|
||||
## PARAMETERS
|
||||
|
||||
### -ResourceGroupName
|
||||
Name of the resource group.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: Backups_Restore
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Name
|
||||
Name of the backup.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: Backups_Restore
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Location
|
||||
Name of location to backup.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: Backups_Restore
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ResourceId
|
||||
The backup resource id.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: ResourceId
|
||||
Aliases: id
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByPropertyName)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -AsJob
|
||||
Run asynchronous as a job and return the job object.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
|
|
@ -118,7 +58,7 @@ Don't ask for confirmation.
|
|||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
|
|
@ -127,6 +67,81 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Location
|
||||
Name of location to backup.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: Backups_Restore
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Name
|
||||
Name of the backup.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: Backups_Restore
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ResourceGroupName
|
||||
Name of the resource group.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: Backups_Restore
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ResourceId
|
||||
{{Fill ResourceId Description}}
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: ResourceId
|
||||
Aliases: id
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByPropertyName)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Confirm
|
||||
Prompts you for confirmation before running the cmdlet.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases: cf
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -WhatIf
|
||||
Shows what would happen if the cmdlet runs.
|
||||
The cmdlet is not run.
|
||||
|
|
@ -143,21 +158,6 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Confirm
|
||||
Prompts you for confirmation before running the cmdlet.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases: cf
|
||||
|
||||
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||
|
||||
|
|
@ -168,3 +168,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
|
|||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
|
||||
|
|
|
|||
|
|
@ -1,56 +1,122 @@
|
|||
---
|
||||
external help file: Azs.Backup.Admin-help.xml
|
||||
Module Name: Azs.Backup.Admin
|
||||
online version:
|
||||
online version:
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Set-AzsBackupShare
|
||||
# Set-AzsBackupConfiguration
|
||||
|
||||
## SYNOPSIS
|
||||
Create a new backup location.
|
||||
Set the backup configuration at the specified location.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
### Update (Default)
|
||||
```
|
||||
Set-AzsBackupShare [-ResourceGroupName <String>] [-Location <String>] -BackupShare <String> -Username <String>
|
||||
-Password <SecureString> -EncryptionKey <SecureString> [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
|
||||
Set-AzsBackupConfiguration [-ResourceGroupName <String>] [-Location <String>] [-Path <String>]
|
||||
[-Username <String>] [-Password <SecureString>] [-EncryptionKey <SecureString>]
|
||||
[-IsBackupSchedulerEnabled <Boolean>] [-BackupFrequencyInHours <Int32>] [-BackupRetentionPeriodInDays <Int32>]
|
||||
[-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### InputObject
|
||||
```
|
||||
Set-AzsBackupShare -InputObject <BackupLocation> [-BackupShare <String>] [-Username <String>]
|
||||
[-Password <SecureString>] [-EncryptionKey <SecureString>] [-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>]
|
||||
```
|
||||
|
||||
### ResourceId
|
||||
```
|
||||
Set-AzsBackupShare -ResourceId <String> -BackupShare <String> -Username <String> -Password <SecureString>
|
||||
-EncryptionKey <SecureString> [-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
|
||||
Create a new backup location.
|
||||
Set the backup configuration at the specified location.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### EXAMPLE 1
|
||||
### -------------------------- EXAMPLE 1 --------------------------
|
||||
```
|
||||
Set-AzsBackupShare -BackupShare "\\***.***.***.***\Share" -Username "asdomain1\azurestackadmin" -Password $password -EncryptionKey $encryptionKey
|
||||
Set-AzsBackupConfiguration -Path "\\***.***.***.***\Share" -Username "asdomain1\azurestackadmin" -Password $password -EncryptionKey $encryptionKey
|
||||
```
|
||||
|
||||
Set Azure Stack backup configuration.
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -AsJob
|
||||
Run asynchronous as a job and return the job object.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: False
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -BackupFrequencyInHours
|
||||
The interval, in hours, for the frequency that the scheduler takes a backup.
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: 0
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -BackupRetentionPeriodInDays
|
||||
The retention period, in days, for backups in the storage location.
|
||||
|
||||
```yaml
|
||||
Type: Int32
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: 0
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -EncryptionKey
|
||||
Encryption key used to encrypt backups.
|
||||
|
||||
```yaml
|
||||
Type: SecureString
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -InputObject
|
||||
Backup location configuration returned by Get-AzsBackupLocation.
|
||||
Backup location configuration returned by Get-AzsBackupConfiguration.
|
||||
|
||||
```yaml
|
||||
Type: BackupLocation
|
||||
Parameter Sets: InputObject
|
||||
Aliases:
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
|
|
@ -59,6 +125,81 @@ Accept pipeline input: True (ByValue)
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -IsBackupSchedulerEnabled
|
||||
Whether the backup scheduler should be enabled.
|
||||
|
||||
```yaml
|
||||
Type: Boolean
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: False
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Location
|
||||
Location to configure.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: Update
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Password
|
||||
Password required to access backup location.
|
||||
|
||||
```yaml
|
||||
Type: SecureString
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Path
|
||||
Location where backups will be stored.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases: BackupShare
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ResourceGroupName
|
||||
Name of the resource group.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: Update
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ResourceId
|
||||
The resource id.
|
||||
|
||||
|
|
@ -74,167 +215,13 @@ Accept pipeline input: True (ByPropertyName)
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ResourceGroupName
|
||||
Name of the resource group.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: Update
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Location
|
||||
Name of the backup location.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: Update
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -BackupShare
|
||||
Location where backups will be stored.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: Update, ResourceId
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: InputObject
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Username
|
||||
Username required to access backup location.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: Update, ResourceId
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: InputObject
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Password
|
||||
Password required to access backup location.
|
||||
|
||||
```yaml
|
||||
Type: SecureString
|
||||
Parameter Sets: Update, ResourceId
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
```yaml
|
||||
Type: SecureString
|
||||
Parameter Sets: InputObject
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -EncryptionKey
|
||||
Encryption key used to encrypt backups.
|
||||
|
||||
```yaml
|
||||
Type: SecureString
|
||||
Parameter Sets: Update, ResourceId
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
```yaml
|
||||
Type: SecureString
|
||||
Parameter Sets: InputObject
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -AsJob
|
||||
Run asynchronous as a job and return the job object.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: False
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -WhatIf
|
||||
Shows what would happen if the cmdlet runs.
|
||||
The cmdlet is not run.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases: wi
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
|
|
@ -258,6 +245,22 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -WhatIf
|
||||
Shows what would happen if the cmdlet runs.
|
||||
The cmdlet is not run.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases: wi
|
||||
|
||||
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||
|
||||
|
|
@ -270,3 +273,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
|
|||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
external help file: Azs.Backup.Admin-help.xml
|
||||
Module Name: Azs.Backup.Admin
|
||||
online version:
|
||||
online version:
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
|
|
@ -28,7 +28,7 @@ Back up a specific location.
|
|||
|
||||
## EXAMPLES
|
||||
|
||||
### EXAMPLE 1
|
||||
### -------------------------- EXAMPLE 1 --------------------------
|
||||
```
|
||||
Start-AzsBackup
|
||||
```
|
||||
|
|
@ -37,58 +37,13 @@ Start an Azure Stack backup.
|
|||
|
||||
## PARAMETERS
|
||||
|
||||
### -ResourceGroupName
|
||||
Name of the resource group.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: CreateBackup
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Location
|
||||
Name of the backup location.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: CreateBackup
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ResourceId
|
||||
The backup resource id.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: CreateBackup_FromResourceId
|
||||
Aliases: id
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByPropertyName)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -AsJob
|
||||
Run asynchronous as a job and return the job object.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
|
|
@ -103,7 +58,7 @@ Don't ask for confirmation.
|
|||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
|
|
@ -112,6 +67,66 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Location
|
||||
Name of the backup location.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: CreateBackup
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ResourceGroupName
|
||||
Name of the resource group.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: CreateBackup
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ResourceId
|
||||
{{Fill ResourceId Description}}
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: CreateBackup_FromResourceId
|
||||
Aliases: id
|
||||
|
||||
Required: True
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByPropertyName)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Confirm
|
||||
Prompts you for confirmation before running the cmdlet.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases: cf
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -WhatIf
|
||||
Shows what would happen if the cmdlet runs.
|
||||
The cmdlet is not run.
|
||||
|
|
@ -128,21 +143,6 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Confirm
|
||||
Prompts you for confirmation before running the cmdlet.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases: cf
|
||||
|
||||
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||
|
||||
|
|
@ -155,3 +155,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
|
|||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ Licensed under the MIT License. See License.txt in the project root for license
|
|||
The resource id.
|
||||
|
||||
.PARAMETER InputObject
|
||||
Backup location configuration returned by Get-AzsBackupLocation.
|
||||
Backup location configuration returned by Get-AzsBackupConfiguration.
|
||||
|
||||
.PARAMETER Path
|
||||
Location where backups will be stored.
|
||||
|
|
@ -49,7 +49,7 @@ Licensed under the MIT License. See License.txt in the project root for license
|
|||
|
||||
.EXAMPLE
|
||||
|
||||
PS C:\> Set-AzsBackupShare -Path "\\***.***.***.***\Share" -Username "asdomain1\azurestackadmin" -Password $password -EncryptionKey $encryptionKey
|
||||
PS C:\> Set-AzsBackupConfiguration -Path "\\***.***.***.***\Share" -Username "asdomain1\azurestackadmin" -Password $password -EncryptionKey $encryptionKey
|
||||
|
||||
Set Azure Stack backup configuration.
|
||||
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче