Skip to content

Commit f20584a

Browse files
v-yuzhichenZiyue Zheng
andauthored
Fix Az.Relay Syntax Errors (#17755)
* Fix Az.Relay Syntax Errors * Fix Az.Relay Syntax Errors Co-authored-by: Ziyue Zheng <[email protected]>
1 parent 6b257b9 commit f20584a

7 files changed

+25
-26
lines changed

src/Relay/Relay/help/Get-AzRelayAuthorizationRule.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The **Get-AzRelayAuthorizationRule** cmdlet gets the description of the specifie
3737

3838
### Example 1: Namespace
3939
```powershell
40-
Get-AzRelayNamespaceAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1
40+
Get-AzRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1
4141
```
4242

4343
```output
@@ -52,7 +52,7 @@ Returns the specified authorization rule description for a specified namespace.
5252

5353
### Example 2: WcfRelay
5454
```powershell
55-
Get-AzWcfRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -WcfRelay TestWCFRelay1 -Name AuthoRule1
55+
Get-AzRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -WcfRelay TestWCFRelay1 -Name AuthoRule1
5656
```
5757

5858
```output
@@ -67,7 +67,7 @@ Returns the specified authorization rule description for a given WcfRelay.
6767

6868
### Example 3: HybridConnection
6969
```powershell
70-
Get-AzRelayHybridConnectionAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -HybridConnections TestHybridConnection -Name AuthoRule1
70+
Get-AzRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -HybridConnections TestHybridConnection -Name AuthoRule1
7171
```
7272

7373
```output

src/Relay/Relay/help/New-AzRelayHybridConnection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The New-AzRelayHybridConnection cmdlet creates a HybridConnection in the specifi
3333

3434
### Example 1 - InputObject
3535
```powershell
36-
$getHybirdConnection = Get-AzRelayHybridConnection -ResourceGroupName Default-ServiceBus-WestUS -NamespaceName TestNameSpace-HybirdConnection -Name TestHybirdConnection1
36+
$getHybirdConnection = Get-AzRelayHybridConnection -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-HybirdConnection -Name TestHybirdConnection1
3737
$getHybirdConnection.UserMetadata = "TestHybirdConnection2"
3838
$getHybirdConnection.RequiresClientAuthorization = $False
3939
New-AzRelayHybridConnection -ResourceGroupName Default-Storage-WestUS -Namespace TestNameSpace-HybirdConnection -Name TestHybirdConnection2 -InputObject $getHybirdConnection

src/Relay/Relay/help/New-AzRelayKey.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ The **New-AzRelayKey** cmdlet generates the primary and secondary connection str
3939

4040
### Example 1 - Namespace
4141
```powershell
42-
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -RegenerateKeys PrimaryKey
42+
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -RegenerateKey PrimaryKey
4343
44-
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -RegenerateKeys SecondaryKey
44+
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -RegenerateKey SecondaryKey
4545
```
4646

4747
```output
@@ -56,9 +56,9 @@ Regenerates the primary or secondary connection strings for the given Relay-Name
5656

5757
### Example 1.1 - Namespace KeyValue Provided
5858
```powershell
59-
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -RegenerateKeys PrimaryKey -KeyValue ###############
59+
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -RegenerateKey PrimaryKey -KeyValue ###############
6060
61-
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -RegenerateKeys SecondaryKey -KeyValue ###############
61+
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -RegenerateKey SecondaryKey -KeyValue ###############
6262
```
6363

6464
```output
@@ -73,9 +73,9 @@ generates the primary or secondary connection strings for the given Relay-Namesp
7373

7474
### Example 2 - WcfRelay
7575
```powershell
76-
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -WcfRelay TestWCFRelay1 -RegenerateKeys PrimaryKey
76+
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -WcfRelay TestWCFRelay1 -RegenerateKey PrimaryKey
7777
78-
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -WcfRelay TestWCFRelay1 -RegenerateKeys SecondaryKey
78+
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -WcfRelay TestWCFRelay1 -RegenerateKey SecondaryKey
7979
```
8080

8181
```output
@@ -90,9 +90,9 @@ Regenerates the primary or secondary connection strings for the given Relay-WcfR
9090

9191
### Example 2.1 - WcfRelay KeyValue Provided
9292
```powershell
93-
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -WcfRelay TestWCFRelay1 -RegenerateKeys PrimaryKey -KeyValue ###############
93+
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -WcfRelay TestWCFRelay1 -RegenerateKey PrimaryKey -KeyValue ###############
9494
95-
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -WcfRelay TestWCFRelay1 -RegenerateKeys SecondaryKey -KeyValue ###############
95+
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -WcfRelay TestWCFRelay1 -RegenerateKey SecondaryKey -KeyValue ###############
9696
```
9797

9898
```output
@@ -107,9 +107,9 @@ generates the primary or secondary connection strings for the given Relay-WcfRel
107107

108108
### Example 3 - HybridConnection
109109
```powershell
110-
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -HybridConnection TestHybridConnection -RegenerateKeys PrimaryKey
110+
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -HybridConnection TestHybridConnection -RegenerateKey PrimaryKey
111111
112-
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -HybridConnection TestHybridConnection -RegenerateKeys SecondaryKey
112+
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -HybridConnection TestHybridConnection -RegenerateKey SecondaryKey
113113
```
114114

115115
```output
@@ -124,9 +124,9 @@ Regenerates the primary or secondary connection strings for the given Relay enti
124124

125125
### Example 3.1 - HybridConnection KeyValue Provided
126126
```powershell
127-
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -HybridConnection TestHybridConnection -RegenerateKeys PrimaryKey -KeyValue ###############
127+
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -HybridConnection TestHybridConnection -RegenerateKey PrimaryKey -KeyValue ###############
128128
129-
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -HybridConnection TestHybridConnection -RegenerateKeys SecondaryKey -KeyValue ###############
129+
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -HybridConnection TestHybridConnection -RegenerateKey SecondaryKey -KeyValue ###############
130130
```
131131

132132
```output

src/Relay/Relay/help/New-AzWcfRelay.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The New-AzWcfRelay cmdlet creates a WcfRelay in the specified Relay namespace.
3333

3434
### Example 1 - InputObject
3535
```powershell
36-
$getWcfRelay = Get-AzWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -NamespaceName TestNameSpace-Relay1 -WcfRelayName TestWCFRelay1
36+
$getWcfRelay = Get-AzWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -WcfRelay TestWCFRelay1
3737
$GetWcfRelay.UserMetadata = "TestWCFRelay2"
3838
$GetWcfRelay.RequiresClientAuthorization = $False
3939
$GetWcfRelay.RelayType = "Http"

src/Relay/Relay/help/Set-AzRelayAuthorizationRule.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,9 @@ The **Set-AzRelayAuthorizationRule** cmdlet updates the description for the spec
5353

5454
### Example 1.1 - Namespace with InputObject
5555
```powershell
56-
$getAutoRule = Get-AzRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -NamespaceName TestNameSpace-Relay1 -AuthorizationRuleName
57-
AuthoRule1
56+
$getAutoRule = Get-AzRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1
5857
$getAutoRule.Rights.Add("Send")
59-
Set-AzRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -AuthorizationRule AuthoRule1 -InputObject $getAutoRule
58+
Set-AzRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -InputObject $getAutoRule
6059
```
6160

6261
```output
@@ -70,7 +69,7 @@ Adds **Send** from the access rights of the authorization rule `AuthoRule1` in n
7069

7170
### Example 1.2 - Namespace with Rights parameter
7271
```powershell
73-
Set-AzRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -AuthorizationRule AuthoRule1 -Rights "Send"
72+
Set-AzRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -Rights "Send"
7473
```
7574

7675
```output

src/Relay/Relay/help/Set-AzRelayHybridConnection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Type : Microsoft.Relay/HybridConnections
5252

5353
### Example 2
5454
```powershell
55-
Set-AzRelayHybridConnection -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestHybridConnection -UserMetadata = "Test UserMetadata updated"
55+
Set-AzRelayHybridConnection -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestHybridConnection -UserMetadata "Test UserMetadata updated"
5656
```
5757

5858
```output

src/Relay/Relay/help/Set-AzWcfRelay.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ The Set-AzWcfRelay cmdlet updates the description for the WcfRelay in the specif
3232

3333
### Example 1 - InputObject
3434
```powershell
35-
$getWcfRelay = Get-AzWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -NamespaceName TestNameSpace-Relay1 -WcfRelayName TestWCFRelay
36-
$getWcfRelay.UserMetadata = "usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can be used to store desc
35+
$getWcfRelay = Get-AzWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -WcfRelay TestWCFRelay
36+
$getWcfRelay.UserMetadata = "usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can be used to store desc
3737
riptive data, such as list of teams and their contact information also user-defined configuration settings can be stored."
3838
Set-AzWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestWCFRelay1 -InputObject $getWcfRelay
3939
```
@@ -46,8 +46,8 @@ ListenerCount :
4646
RequiresClientAuthorization : False
4747
RequiresTransportSecurity : True
4848
IsDynamic : False
49-
UserMetadata : usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can be used to store desc
50-
riptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.
49+
UserMetadata : usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can be used to store desc
50+
riptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.
5151
Id : /subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/Default-Storage-WestUS/providers/Microsoft.Rel
5252
ay/namespaces/TestNameSpace-Relay1/WcfRelays/TestWCFRelay2
5353
Name : TestWCFRelay2

0 commit comments

Comments
 (0)