Skip to content

Commit f6d22ca

Browse files
authored
update Set-AzStorageSyncServer.md (Azure#28233)
1 parent ca07e18 commit f6d22ca

File tree

1 file changed

+47
-36
lines changed

1 file changed

+47
-36
lines changed

src/StorageSync/StorageSync/help/Set-AzStorageSyncServer.md

Lines changed: 47 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,16 @@ This command will set the server with identity. This helps to enable the server
1414

1515
### StringParameterSet (Default)
1616
```
17-
Set-AzStorageSyncServer [-ResourceGroupName] <String> [-StorageSyncServiceName] <String> [-Identity] [-AsJob]
18-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
17+
Set-AzStorageSyncServer [-ResourceGroupName] <String> [-StorageSyncServiceName] <String> [-ServerId] <String>
18+
[-Identity] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>] [-WhatIf]
19+
[-Confirm] [<CommonParameters>]
1920
```
2021

2122
### ObjectParameterSet
2223
```
23-
Set-AzStorageSyncServer [-ParentObject] <PSStorageSyncService> [-Identity] [-AsJob]
24-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
25-
```
26-
27-
### ParentStringParameterSet
28-
```
29-
Set-AzStorageSyncServer [-ParentResourceId] <String> [-Identity] [-AsJob] [-DefaultProfile <IAzureContextContainer>]
30-
[-WhatIf] [-Confirm] [<CommonParameters>]
24+
Set-AzStorageSyncServer [-InputObject] <PSRegisteredServer> [-Identity] [-AsJob]
25+
[-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
26+
[<CommonParameters>]
3127
```
3228

3329
## DESCRIPTION
@@ -75,13 +71,28 @@ Accept pipeline input: False
7571
Accept wildcard characters: False
7672
```
7773
78-
### -ParentObject
79-
StorageSyncService Object, normally passed through the parameter.
74+
### -Identity
75+
Registered Server Identity
8076
8177
```yaml
82-
Type: Microsoft.Azure.Commands.StorageSync.Models.PSStorageSyncService
78+
Type: System.Management.Automation.SwitchParameter
79+
Parameter Sets: (All)
80+
Aliases:
81+
82+
Required: False
83+
Position: Named
84+
Default value: None
85+
Accept pipeline input: False
86+
Accept wildcard characters: False
87+
```
88+
89+
### -InputObject
90+
RegisteredServer Object, normally passed through the parameter.
91+
92+
```yaml
93+
Type: Microsoft.Azure.Commands.StorageSync.Models.PSRegisteredServer
8394
Parameter Sets: ObjectParameterSet
84-
Aliases: StorageSyncService
95+
Aliases: RegisteredServer
8596

8697
Required: True
8798
Position: 0
@@ -90,18 +101,18 @@ Accept pipeline input: True (ByValue)
90101
Accept wildcard characters: False
91102
```
92103
93-
### -ParentResourceId
94-
StorageSyncService Parent Resource Id
104+
### -ProgressAction
105+
{{ Fill ProgressAction Description }}
95106
96107
```yaml
97-
Type: System.String
98-
Parameter Sets: ParentStringParameterSet
99-
Aliases: StorageSyncServiceId
108+
Type: System.Management.Automation.ActionPreference
109+
Parameter Sets: (All)
110+
Aliases: proga
100111

101-
Required: True
102-
Position: 0
112+
Required: False
113+
Position: Named
103114
Default value: None
104-
Accept pipeline input: True (ByPropertyName)
115+
Accept pipeline input: False
105116
Accept wildcard characters: False
106117
```
107118
@@ -116,35 +127,35 @@ Aliases:
116127
Required: True
117128
Position: 0
118129
Default value: None
119-
Accept pipeline input: True (ByPropertyName)
130+
Accept pipeline input: False
120131
Accept wildcard characters: False
121132
```
122133
123-
### -StorageSyncServiceName
124-
Name of the StorageSyncService.
134+
### -ServerId
135+
Name of the RegisteredServer.
125136
126137
```yaml
127138
Type: System.String
128139
Parameter Sets: StringParameterSet
129-
Aliases: ParentName
140+
Aliases: RegisteredServerName
130141

131142
Required: True
132-
Position: 1
143+
Position: 2
133144
Default value: None
134-
Accept pipeline input: True (ByPropertyName)
145+
Accept pipeline input: False
135146
Accept wildcard characters: False
136147
```
137148
138-
### -CloudTiering
139-
Identity Parameter
149+
### -StorageSyncServiceName
150+
Name of the StorageSyncService.
140151
141152
```yaml
142-
Type: System.Management.Automation.SwitchParameter
143-
Parameter Sets: (All)
144-
Aliases:
153+
Type: System.String
154+
Parameter Sets: StringParameterSet
155+
Aliases: ParentName
145156

146-
Required: False
147-
Position: Named
157+
Required: True
158+
Position: 1
148159
Default value: None
149160
Accept pipeline input: False
150161
Accept wildcard characters: False
@@ -181,7 +192,7 @@ Accept wildcard characters: False
181192
```
182193
183194
### CommonParameters
184-
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).
195+
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).
185196
186197
## INPUTS
187198

0 commit comments

Comments
 (0)