Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

format the help markdown file of Az.Relay #18498

Merged
merged 1 commit into from
Jun 22, 2022
+35 −35
Merged

format the help markdown file of Az.Relay #18498

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Relay/Relay/help/Get-AzRelayAuthorizationRule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Returns the specified authorization rule description for a given WcfRelay.

### Example 3: HybridConnection
```powershell
Get-AzRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -HybridConnections TestHybridConnection -Name AuthoRule1
Get-AzRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -HybridConnection TestHybridConnection -Name AuthoRule1
```

```output
Expand Down
60 changes: 30 additions & 30 deletions src/Relay/Relay/help/New-AzRelayKey.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,27 +45,27 @@ New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameS
```

```output
PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################
SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################
PrimaryKey : ############################################
SecondaryKey : ############################################
PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=xxxxxxxxxxx
SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=xxxxxxxxxxx
PrimaryKey : xxxxxxxxxxx
SecondaryKey : xxxxxxxxxxx
KeyName : AuthoRule1
```

Regenerates the primary or secondary connection strings for the given Relay-Namespace entity.

### Example 1.1 - Namespace KeyValue Provided
```powershell
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -RegenerateKey PrimaryKey -KeyValue ###############
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -RegenerateKey PrimaryKey -KeyValue xxxxxxxxxxx

New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -RegenerateKey SecondaryKey -KeyValue ###############
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -RegenerateKey SecondaryKey -KeyValue xxxxxxxxxxx
```

```output
PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################
SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################
PrimaryKey : ############################################
SecondaryKey : ############################################
PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=xxxxxxxxxxx
SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=xxxxxxxxxxx
PrimaryKey : xxxxxxxxxxx
SecondaryKey : xxxxxxxxxxx
KeyName : AuthoRule1
```

Expand All @@ -79,27 +79,27 @@ New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameS
```

```output
PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################;EntityPath=TestWCFRelay1
SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################;EntityPath=TestWCFRelay1
PrimaryKey : ############################################
SecondaryKey : ############################################
PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=xxxxxxxxxxx;EntityPath=TestWCFRelay1
SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=xxxxxxxxxxx;EntityPath=TestWCFRelay1
PrimaryKey : xxxxxxxxxxx
SecondaryKey : xxxxxxxxxxx
KeyName : AuthoRule1
```

Regenerates the primary or secondary connection strings for the given Relay-WcfRelay entity.

### Example 2.1 - WcfRelay KeyValue Provided
```powershell
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -WcfRelay TestWCFRelay1 -RegenerateKey PrimaryKey -KeyValue ###############
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -WcfRelay TestWCFRelay1 -RegenerateKey PrimaryKey -KeyValue xxxxxxxxxxx

New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -WcfRelay TestWCFRelay1 -RegenerateKey SecondaryKey -KeyValue ###############
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -WcfRelay TestWCFRelay1 -RegenerateKey SecondaryKey -KeyValue xxxxxxxxxxx
```

```output
PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################;EntityPath=TestWCFRelay1
SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################;EntityPath=TestWCFRelay1
PrimaryKey : ############################################
SecondaryKey : ############################################
PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=xxxxxxxxxxx;EntityPath=TestWCFRelay1
SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=xxxxxxxxxxx;EntityPath=TestWCFRelay1
PrimaryKey : xxxxxxxxxxx
SecondaryKey : xxxxxxxxxxx
KeyName : AuthoRule1
```

Expand All @@ -113,27 +113,27 @@ New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameS
```

```output
PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################;EntityPath=TestHybridConnection
SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################;EntityPath=TestHybridConnection
PrimaryKey : ############################################
SecondaryKey : ############################################
PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=xxxxxxxxxxx;EntityPath=TestHybridConnection
SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=xxxxxxxxxxx;EntityPath=TestHybridConnection
PrimaryKey : xxxxxxxxxxx
SecondaryKey : xxxxxxxxxxx
KeyName : AuthoRule1
```

Regenerates the primary or secondary connection strings for the given Relay entities (Namespace/WcfRelay/HybridConnection).

### Example 3.1 - HybridConnection KeyValue Provided
```powershell
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -HybridConnection TestHybridConnection -RegenerateKey PrimaryKey -KeyValue ###############
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -HybridConnection TestHybridConnection -RegenerateKey PrimaryKey -KeyValue xxxxxxxxxxx

New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -HybridConnection TestHybridConnection -RegenerateKey SecondaryKey -KeyValue ###############
New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -HybridConnection TestHybridConnection -RegenerateKey SecondaryKey -KeyValue xxxxxxxxxxx
```

```output
PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################;EntityPath=TestHybridConnection
SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################;EntityPath=TestHybridConnection
PrimaryKey : ############################################
SecondaryKey : ############################################
PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=xxxxxxxxxxx;EntityPath=TestHybridConnection
SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=xxxxxxxxxxx;EntityPath=TestHybridConnection
PrimaryKey : xxxxxxxxxxx
SecondaryKey : xxxxxxxxxxx
KeyName : AuthoRule1
```

Expand Down
4 changes: 2 additions & 2 deletions src/Relay/Relay/help/New-AzWcfRelay.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ The New-AzWcfRelay cmdlet creates a WcfRelay in the specified Relay namespace.

### Example 1 - InputObject
```powershell
$getWcfRelay = Get-AzWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -WcfRelay TestWCFRelay1
$getWcfRelay = Get-AzWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestWCFRelay1
$GetWcfRelay.UserMetadata = "TestWCFRelay2"
$GetWcfRelay.RequiresClientAuthorization = $False
$GetWcfRelay.RelayType = "Http"
New-AzWcfRelay -ResourceGroupName Default-Storage-WestUS -Namespace TestNameSpace-Relay1 -Name TestWCFRelay2 -InputObject
New-AzWcfRelay -ResourceGroupName Default-Storage-WestUS -Namespace TestNameSpace-Relay1 -Name TestWCFRelay2 -InputObject $getWcfRelay
```

```output
Expand Down
2 changes: 1 addition & 1 deletion src/Relay/Relay/help/Remove-AzWcfRelay.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The **Remove-AzWcfRelay** cmdlet removes the WcfRelay from the specified Relay n

### Example 1
```powershell
Remove-AzWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -NamespaceName TestNameSpace-Relay1 -Name TestWCFRelay1
Remove-AzWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestWCFRelay1
```

Removes the WcfRelay `TestWCFRelay1` from the namespace `TestNameSpace-Relay1`.
Expand Down
2 changes: 1 addition & 1 deletion src/Relay/Relay/help/Set-AzWcfRelay.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The Set-AzWcfRelay cmdlet updates the description for the WcfRelay in the specif

### Example 1 - InputObject
```powershell
$getWcfRelay = Get-AzWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -WcfRelay TestWCFRelay
$getWcfRelay = Get-AzWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestWCFRelay
$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
riptive data, such as list of teams and their contact information also user-defined configuration settings can be stored."
Set-AzWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestWCFRelay1 -InputObject $getWcfRelay
Expand Down