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.

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

Update doc for Test-AzSignalRName #25827

Merged
merged 1 commit into from
Aug 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions src/SignalR/SignalR/ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
12 changes: 6 additions & 6 deletions src/SignalR/SignalR/help/Test-AzSignalRName.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down