1
1
---
2
2
external help file : Microsoft.Azure.Commands.Websites.dll-Help.xml
3
- online version :
3
+ online version :
4
4
schema : 2.0.0
5
5
---
6
6
7
7
# Edit-AzureRmWebAppBackupConfiguration
8
8
9
9
## SYNOPSIS
10
+ Edits the current backup configuration for a web app.
10
11
11
12
## SYNTAX
12
13
@@ -26,25 +27,17 @@ Edit-AzureRmWebAppBackupConfiguration [-FrequencyInterval] <Int32> [-FrequencyUn
26
27
```
27
28
28
29
## DESCRIPTION
29
-
30
- ## EXAMPLES
31
-
32
- ### Example 1
33
- ```
34
- PS C:\> {{ Add example code here }}
35
- ```
36
-
37
- {{ Add example description here }}
30
+ The ** Edit-AzureRmWebAppBackupConfiguration** cmdlet edits the current backup configuration for a web app that was built using the Web Apps feature of the Azure App Service.
38
31
39
32
## PARAMETERS
40
33
41
34
### -Databases
42
- @{Text=}
35
+ Specifies the databases that are backed up.
43
36
44
37
``` yaml
45
38
Type : DatabaseBackupSetting[]
46
39
Parameter Sets : (All)
47
- Aliases :
40
+ Aliases :
48
41
49
42
Required : False
50
43
Position : 8
@@ -54,12 +47,12 @@ Accept wildcard characters: False
54
47
` ` `
55
48
56
49
### -FrequencyInterval
57
- @{Text=}
50
+ Specifies the interval between backups. For example, for weekly backup, the value of this parameter must be 7 and the value of the **FrequencyUnit** parameter must be "Day".
58
51
59
52
` ` ` yaml
60
53
Type : Int32
61
54
Parameter Sets : (All)
62
- Aliases :
55
+ Aliases :
63
56
64
57
Required : True
65
58
Position : 4
@@ -69,12 +62,12 @@ Accept wildcard characters: False
69
62
` ` `
70
63
71
64
### -FrequencyUnit
72
- @{Text=}
65
+ Specifies the unit of time in which the interval between backups is measured. For example, for weekly backup, the value of this parameter must be "Day" and the value of the **FrequencyInterval** parameter must be 7.
73
66
74
67
` ` ` yaml
75
68
Type : String
76
69
Parameter Sets : (All)
77
- Aliases :
70
+ Aliases :
78
71
79
72
Required : True
80
73
Position : 5
@@ -84,12 +77,12 @@ Accept wildcard characters: False
84
77
` ` `
85
78
86
79
### -KeepAtLeastOneBackup
87
- @{Text=}
80
+ Specifies whether the retention policy must keep at least one backup in the storage account.
88
81
89
82
` ` ` yaml
90
83
Type : SwitchParameter
91
84
Parameter Sets : (All)
92
- Aliases :
85
+ Aliases :
93
86
94
87
Required : False
95
88
Position : 9
@@ -99,12 +92,12 @@ Accept wildcard characters: False
99
92
` ` `
100
93
101
94
### -Name
102
- @{Text=}
95
+ Specifies the name of the web app.
103
96
104
97
` ` ` yaml
105
98
Type : String
106
99
Parameter Sets : FromResourceName
107
- Aliases :
100
+ Aliases :
108
101
109
102
Required : True
110
103
Position : 1
@@ -114,12 +107,12 @@ Accept wildcard characters: False
114
107
` ` `
115
108
116
109
### -ResourceGroupName
117
- @{Text=}
110
+ Specifies the name of the resource group that contains the web app.
118
111
119
112
` ` ` yaml
120
113
Type : String
121
114
Parameter Sets : FromResourceName
122
- Aliases :
115
+ Aliases :
123
116
124
117
Required : True
125
118
Position : 0
@@ -129,12 +122,12 @@ Accept wildcard characters: False
129
122
` ` `
130
123
131
124
### -RetentionPeriodInDays
132
- @{Text=}
125
+ Specifies the number of days that the backup is to be retained. The backup is deleted after the retention period is exceeded.
133
126
134
127
` ` ` yaml
135
128
Type : Int32
136
129
Parameter Sets : (All)
137
- Aliases :
130
+ Aliases :
138
131
139
132
Required : True
140
133
Position : 6
@@ -144,12 +137,12 @@ Accept wildcard characters: False
144
137
` ` `
145
138
146
139
### -Slot
147
- @{Text=}
140
+ Specifies the name of the slot to which the web app is deployed.
148
141
149
142
` ` ` yaml
150
143
Type : String
151
144
Parameter Sets : FromResourceName
152
- Aliases :
145
+ Aliases :
153
146
154
147
Required : False
155
148
Position : 2
@@ -159,12 +152,12 @@ Accept wildcard characters: False
159
152
` ` `
160
153
161
154
### -StartTime
162
- @{Text=}
155
+ Specifies the date that the backup schedule must be applied.
163
156
164
157
` ` ` yaml
165
158
Type : DateTime
166
159
Parameter Sets : (All)
167
- Aliases :
160
+ Aliases :
168
161
169
162
Required : False
170
163
Position : 7
@@ -174,12 +167,12 @@ Accept wildcard characters: False
174
167
` ` `
175
168
176
169
### -StorageAccountUrl
177
- @{Text=}
170
+ Specifies the URL of the storage account that contains the web app.
178
171
179
172
` ` ` yaml
180
173
Type : String
181
174
Parameter Sets : (All)
182
- Aliases :
175
+ Aliases :
183
176
184
177
Required : True
185
178
Position : 3
@@ -189,12 +182,12 @@ Accept wildcard characters: False
189
182
` ` `
190
183
191
184
### -WebApp
192
- @{Text=}
185
+ Specifies a **WebApp** object that contains details about the web app.
193
186
194
187
` ` ` yaml
195
188
Type : Site
196
189
Parameter Sets : FromWebApp
197
- Aliases :
190
+ Aliases :
198
191
199
192
Required : True
200
193
Position : 0
@@ -208,9 +201,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
208
201
209
202
## INPUTS
210
203
204
+ ### None
205
+
211
206
## OUTPUTS
212
207
208
+ ### None
209
+
213
210
## NOTES
214
211
215
212
## RELATED LINKS
216
213
214
+ [Get-AzureRmWebAppBackupConfiguration](./Get-AzureRmWebAppBackupConfiguration.md)
0 commit comments