Skip to content

Commit 895931b

Browse files
author
Maddie Clayton
authored
Merge pull request #7067 from deathly809/Backup1.5.0
[Azure Stack][Admin] Backup for Azure Stack 1.5.0
2 parents e2dbe4c + accc98a commit 895931b

25 files changed

+3370
-524
lines changed

src/StackAdmin/Azs.Backup.Admin/Help/Azs.Backup.Admin.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,23 @@ Locale: en-US
88

99
# Azs.Backup.Admin Module
1010
## Description
11-
Preview release of the Backup administrator module that allows administrators to
12-
- Configure where backups are stored
13-
- Perform backups
14-
- List and restore completed backup
11+
{{Manually Enter Description Here}}
1512

1613
## Azs.Backup.Admin Cmdlets
1714
### [Get-AzsBackup](Get-AzsBackup.md)
1815
Returns a backup from a location based on name.
1916

20-
### [Get-AzsBackupLocation](Get-AzsBackupLocation.md)
21-
Returns the list of backup locations.
17+
### [Get-AzsBackupConfiguration](Get-AzsBackupConfiguration.md)
18+
Returns the list of backup configurations.
19+
20+
### [New-AzsEncryptionKeyBase64](New-AzsEncryptionKeyBase64.md)
21+
Generate encryption key for infrastructure backups.
2222

2323
### [Restore-AzsBackup](Restore-AzsBackup.md)
2424
Restore a backup.
2525

26-
### [Set-AzsBackupShare](Set-AzsBackupShare.md)
27-
Create a new backup location.
26+
### [Set-AzsBackupConfiguration](Set-AzsBackupConfiguration.md)
27+
Set the backup configuration at the specified location.
2828

2929
### [Start-AzsBackup](Start-AzsBackup.md)
3030
Back up a specific location.

src/StackAdmin/Azs.Backup.Admin/Help/Get-AzsBackup.md

Lines changed: 33 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file: Azs.Backup.Admin-help.xml
33
Module Name: Azs.Backup.Admin
4-
online version:
4+
online version:
55
schema: 2.0.0
66
---
77

@@ -38,14 +38,14 @@ Returns a backup from a location based on name.
3838

3939
## EXAMPLES
4040

41-
### EXAMPLE 1
41+
### -------------------------- EXAMPLE 1 --------------------------
4242
```
4343
Get-AzsBackup
4444
```
4545

4646
Get information sbout all Azure Stack backups.
4747

48-
### EXAMPLE 2
48+
### -------------------------- EXAMPLE 2 --------------------------
4949
```
5050
Get-AzsBackup -Name 'backupName'
5151
```
@@ -54,48 +54,48 @@ Get information for the the specified Azure Stack backup.
5454

5555
## PARAMETERS
5656

57-
### -Name
58-
Name of the backup.
57+
### -Location
58+
Location backed up.
5959

6060
```yaml
6161
Type: String
62-
Parameter Sets: Get
63-
Aliases:
62+
Parameter Sets: List, Get
63+
Aliases:
6464

65-
Required: True
65+
Required: False
6666
Position: Named
6767
Default value: None
6868
Accept pipeline input: False
6969
Accept wildcard characters: False
7070
```
7171
72-
### -Location
73-
Location backed up.
72+
### -Name
73+
Name of the backup.
7474
7575
```yaml
7676
Type: String
77-
Parameter Sets: List, Get
78-
Aliases:
77+
Parameter Sets: Get
78+
Aliases:
7979

80-
Required: False
80+
Required: True
8181
Position: Named
8282
Default value: None
8383
Accept pipeline input: False
8484
Accept wildcard characters: False
8585
```
8686
87-
### -ResourceId
88-
The resource id.
87+
### -ParentResource
88+
Passing a backup location will return the list of all backups at that backup location.
8989
9090
```yaml
91-
Type: String
92-
Parameter Sets: ResourceId
93-
Aliases: id
91+
Type: BackupLocation
92+
Parameter Sets: ParentResource
93+
Aliases:
9494

9595
Required: True
9696
Position: Named
9797
Default value: None
98-
Accept pipeline input: True (ByPropertyName)
98+
Accept pipeline input: True (ByValue)
9999
Accept wildcard characters: False
100100
```
101101
@@ -105,7 +105,7 @@ Name of the resource group.
105105
```yaml
106106
Type: String
107107
Parameter Sets: List, Get
108-
Aliases:
108+
Aliases:
109109

110110
Required: False
111111
Position: Named
@@ -114,30 +114,28 @@ Accept pipeline input: False
114114
Accept wildcard characters: False
115115
```
116116
117-
### -ParentResource
118-
Passing a backup location will return the list of all backups at that backup location.
117+
### -ResourceId
118+
The resource id.
119119
120120
```yaml
121-
Type: BackupLocation
122-
Parameter Sets: ParentResource
123-
Aliases:
121+
Type: String
122+
Parameter Sets: ResourceId
123+
Aliases: id
124124

125125
Required: True
126126
Position: Named
127127
Default value: None
128-
Accept pipeline input: True (ByValue)
128+
Accept pipeline input: True (ByPropertyName)
129129
Accept wildcard characters: False
130130
```
131131
132-
### -Top
133-
Return the top N items as specified by the parameter value.
134-
Applies after the -Skip parameter.
135-
132+
### -Skip
133+
{{Fill Skip Description}}
136134
137135
```yaml
138136
Type: Int32
139137
Parameter Sets: List, ParentResource
140-
Aliases:
138+
Aliases:
141139

142140
Required: False
143141
Position: Named
@@ -146,13 +144,13 @@ Accept pipeline input: False
146144
Accept wildcard characters: False
147145
```
148146
149-
### -Skip
150-
Skip the first N items as specified by the parameter value.
147+
### -Top
148+
{{Fill Top Description}}
151149
152150
```yaml
153151
Type: Int32
154152
Parameter Sets: List, ParentResource
155-
Aliases:
153+
Aliases:
156154

157155
Required: False
158156
Position: Named
@@ -173,3 +171,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
173171
## NOTES
174172
175173
## RELATED LINKS
174+
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,53 @@
11
---
22
external help file: Azs.Backup.Admin-help.xml
33
Module Name: Azs.Backup.Admin
4-
online version:
4+
online version:
55
schema: 2.0.0
66
---
77

8-
# Get-AzsBackupLocation
8+
# Get-AzsBackupConfiguration
99

1010
## SYNOPSIS
11-
Returns the list of backup locations.
11+
Returns the list of backup configurations.
1212

1313
## SYNTAX
1414

1515
### List (Default)
1616
```
17-
Get-AzsBackupLocation [-ResourceGroupName <String>] [-Skip <Int32>] [-Top <Int32>] [<CommonParameters>]
17+
Get-AzsBackupConfiguration [-ResourceGroupName <String>] [-Skip <Int32>] [-Top <Int32>] [<CommonParameters>]
1818
```
1919

2020
### Get
2121
```
22-
Get-AzsBackupLocation [[-Location] <String>] [-ResourceGroupName <String>] [<CommonParameters>]
22+
Get-AzsBackupConfiguration [[-Location] <String>] [-ResourceGroupName <String>] [<CommonParameters>]
2323
```
2424

2525
### ResourceId
2626
```
27-
Get-AzsBackupLocation -ResourceId <String> [<CommonParameters>]
27+
Get-AzsBackupConfiguration -ResourceId <String> [<CommonParameters>]
2828
```
2929

3030
## DESCRIPTION
31-
Returns the list of backup locations.
31+
Returns the list of backup configurations.
3232

3333
## EXAMPLES
3434

35-
### EXAMPLE 1
35+
### -------------------------- EXAMPLE 1 --------------------------
3636
```
37-
Get-AzsBackupLocation
37+
Get-AzsBackupConfiguration
3838
```
3939

4040
Get Azure Stack backup configuration.
4141

4242
## PARAMETERS
4343

4444
### -Location
45-
Location to backup.
45+
Backup location.
4646

4747
```yaml
4848
Type: String
4949
Parameter Sets: Get
50-
Aliases:
50+
Aliases:
5151

5252
Required: False
5353
Position: 1
@@ -56,33 +56,33 @@ Accept pipeline input: False
5656
Accept wildcard characters: False
5757
```
5858
59-
### -ResourceId
60-
The resource id.
59+
### -ResourceGroupName
60+
Name of the resource group.
6161
6262
```yaml
6363
Type: String
64-
Parameter Sets: ResourceId
65-
Aliases: id
64+
Parameter Sets: List, Get
65+
Aliases:
6666

67-
Required: True
67+
Required: False
6868
Position: Named
6969
Default value: None
70-
Accept pipeline input: True (ByPropertyName)
70+
Accept pipeline input: False
7171
Accept wildcard characters: False
7272
```
7373
74-
### -ResourceGroupName
75-
Name of the resource group.
74+
### -ResourceId
75+
The resource id.
7676
7777
```yaml
7878
Type: String
79-
Parameter Sets: List, Get
80-
Aliases:
79+
Parameter Sets: ResourceId
80+
Aliases: id
8181

82-
Required: False
82+
Required: True
8383
Position: Named
8484
Default value: None
85-
Accept pipeline input: False
85+
Accept pipeline input: True (ByPropertyName)
8686
Accept wildcard characters: False
8787
```
8888
@@ -92,7 +92,7 @@ Skip the first N items as specified by the parameter value.
9292
```yaml
9393
Type: Int32
9494
Parameter Sets: List
95-
Aliases:
95+
Aliases:
9696

9797
Required: False
9898
Position: Named
@@ -108,7 +108,7 @@ Applies after the -Skip parameter.
108108
```yaml
109109
Type: Int32
110110
Parameter Sets: List
111-
Aliases:
111+
Aliases:
112112

113113
Required: False
114114
Position: Named
@@ -129,3 +129,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
129129
## NOTES
130130
131131
## RELATED LINKS
132+
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
external help file: Azs.Backup.Admin-help.xml
3+
Module Name: Azs.Backup.Admin
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# New-AzsEncryptionKeyBase64
9+
10+
## SYNOPSIS
11+
Generate encryption key for infrastructure backups.
12+
13+
## SYNTAX
14+
15+
```
16+
New-AzsEncryptionKeyBase64 [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
Generate encryption key for infrastructure backups.
21+
22+
## EXAMPLES
23+
24+
### -------------------------- EXAMPLE 1 --------------------------
25+
```
26+
New-AzsEncryptionKeyBase64
27+
```
28+
29+
Generate encryption key for infrastructure backups.
30+
31+
## PARAMETERS
32+
33+
### CommonParameters
34+
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).
35+
36+
## INPUTS
37+
38+
## OUTPUTS
39+
40+
## NOTES
41+
42+
## RELATED LINKS
43+

0 commit comments

Comments
 (0)