Update doc for Test-AzSignalRName (Azure#25827)

azure-sdk · Aug 16, 2024 · 6ffb4c9 · 6ffb4c9
1 parent 333abf7
commit 6ffb4c9
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/src/SignalR/SignalR/ChangeLog.md b/src/SignalR/SignalR/ChangeLog.md
@@ -18,6 +18,7 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Improve the doc for `Test-AzSignalRName`.
 
 ## Version 2.0.1
 * Introduced secrets detection feature to safeguard sensitive data.

diff --git a/src/SignalR/SignalR/help/Test-AzSignalRName.md b/src/SignalR/SignalR/help/Test-AzSignalRName.md
@@ -8,7 +8,7 @@ schema: 2.0.0
 # Test-AzSignalRName
 
 ## SYNOPSIS
-Check the availability of a name. Alias: Test-AzSignal.
+Check whether a name is available. Alias: Test-AzSignal.
 
 ## SYNTAX
 
@@ -18,22 +18,22 @@ Test-AzSignalRName [-Name] <String> [-Location] <String> [-DefaultProfile <IAzur
 ```
 
 ## DESCRIPTION
-Check the availability of a name. Alias: Test-AzSignal.
+Check whether a name is available. If a name is available, returns true. Otherwise, return false.  Alias: Test-AzSignal.
 
 ## EXAMPLES
 
-### Example 1: Check an existed name.
+### Example 1: When the name is already in use, it's not available.
 ```powershell
-Test-AzSignalRName -Name existedsignalr -Location eastus
+Test-AzSignalRName -Name inusesignalr -Location eastus
 ```
 
 ```output
 False
 ```
 
-### Example 2: Check an unexisted name.
+### Example 2: When the name is not in use, it's available.
 ```powershell
-Test-AzSignalRName -Name unexistedsignalr -Location eastus
+Test-AzSignalRName -Name availablesignalr -Location eastus
 ```
 
 ```output