Skip to content

Commit 3851a1d

Browse files
grhuangmsftgrhuangmsft
committed
documentation for checkNameAvailability
1 parent c41fec4 commit 3851a1d

8 files changed

+86
-96
lines changed

‎src/Support/Support.Autorest/docs/Test-AzSupportCommunicationNameAvailability.md‎

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -57,27 +57,19 @@ This API should be used to check the uniqueness of the name for adding a new com
5757

5858
## EXAMPLES
5959

60-
### Example 1: {{ Add title here }}
60+
### Example 1: Check friendly name availability of a communication for a support ticket
6161
```powershell
62-
{{ Add code here }}
62+
Test-AzSupportCommunicationNameAvailability -Name "testCommunication" -SupportTicketName "2402084010005835" -Type "Microsoft.Support/communications"
6363
```
6464

6565
```output
66-
{{ Add output here (remove the output block if the example doesn't have an output) }}
66+
Message NameAvailable Reason
67+
------- ------------- ------
68+
True
6769
```
6870

69-
{{ Add description here }}
70-
71-
### Example 2: {{ Add title here }}
72-
```powershell
73-
{{ Add code here }}
74-
```
75-
76-
```output
77-
{{ Add output here (remove the output block if the example doesn't have an output) }}
78-
```
79-
80-
{{ Add description here }}
71+
Check the availability of a resource name.
72+
This API should be used to check the uniqueness of the name for adding a new communication to the support ticket under an Azure subscription.
8173

8274
## PARAMETERS
8375

‎src/Support/Support.Autorest/docs/Test-AzSupportCommunicationsNoSubscriptionNameAvailability.md‎

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -57,27 +57,19 @@ This API should be used to check the uniqueness of the name for adding a new com
5757

5858
## EXAMPLES
5959

60-
### Example 1: {{ Add title here }}
60+
### Example 1: Check friendly name availability of a communication for a support ticket
6161
```powershell
62-
{{ Add code here }}
62+
Test-AzSupportCommunicationsNoSubscriptionNameAvailability -Name "testCommunication" -SupportTicketName "2402084010005835" -Type "Microsoft.Support/communications"
6363
```
6464

6565
```output
66-
{{ Add output here (remove the output block if the example doesn't have an output) }}
66+
Message NameAvailable Reason
67+
------- ------------- ------
68+
True
6769
```
6870

69-
{{ Add description here }}
70-
71-
### Example 2: {{ Add title here }}
72-
```powershell
73-
{{ Add code here }}
74-
```
75-
76-
```output
77-
{{ Add output here (remove the output block if the example doesn't have an output) }}
78-
```
79-
80-
{{ Add description here }}
71+
Check the availability of a resource name.
72+
This API should be used to check the uniqueness of the name for adding a new communication to the support ticket.
8173

8274
## PARAMETERS
8375

‎src/Support/Support.Autorest/docs/Test-AzSupportTicketNameAvailability.md‎

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,27 +43,35 @@ This API should be used to check the uniqueness of the name for support ticket c
4343

4444
## EXAMPLES
4545

46-
### Example 1: {{ Add title here }}
46+
### Example 1: Check support ticket friendly name availability
4747
```powershell
48-
{{ Add code here }}
48+
Test-AzSupportTicketNameAvailability -Name "testSupportTicketName" -Type "Microsoft.Support/supportTickets"
4949
```
5050

5151
```output
52-
{{ Add output here (remove the output block if the example doesn't have an output) }}
52+
Message NameAvailable Reason
53+
------- ------------- ------
54+
True
5355
```
5456

55-
{{ Add description here }}
57+
Check the availability of a resource name.
58+
This API should be used to check the uniqueness of the name for support ticket creation for the selected subscription.
59+
If the provided type is neither Microsoft.Support/supportTickets nor Microsoft.Support/fileWorkspaces, then it will default to Microsoft.Support/supportTickets.
5660

57-
### Example 2: {{ Add title here }}
61+
### Example 2: Check file workspace friendly name availability
5862
```powershell
59-
{{ Add code here }}
63+
Test-AzSupportTicketNameAvailability -Name "testFileWorkspaceName" -Type "Microsoft.Support/fileWorkspaces"
6064
```
6165

6266
```output
63-
{{ Add output here (remove the output block if the example doesn't have an output) }}
67+
Message NameAvailable Reason
68+
------- ------------- ------
69+
True
6470
```
6571

66-
{{ Add description here }}
72+
Check the availability of a resource name.
73+
This API should be used to check the uniqueness of the name for file workspace creation for the selected subscription.
74+
If the provided type is neither Microsoft.Support/supportTickets nor Microsoft.Support/fileWorkspaces, then it will default to Microsoft.Support/supportTickets.
6775

6876
## PARAMETERS
6977

‎src/Support/Support.Autorest/docs/Test-AzSupportTicketsNoSubscriptionNameAvailability.md‎

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,27 +43,35 @@ This API should be used to check the uniqueness of the name for support ticket c
4343

4444
## EXAMPLES
4545

46-
### Example 1: {{ Add title here }}
46+
### Example 1: Check support ticket friendly name availability
4747
```powershell
48-
{{ Add code here }}
48+
Test-AzSupportTicketsNoSubscriptionNameAvailability -Name "testSupportTicketName" -Type "Microsoft.Support/supportTickets"
4949
```
5050

5151
```output
52-
{{ Add output here (remove the output block if the example doesn't have an output) }}
52+
Message NameAvailable Reason
53+
------- ------------- ------
54+
True
5355
```
5456

55-
{{ Add description here }}
57+
Check the availability of a resource name.
58+
This API should be used to check the uniqueness of the name for support ticket creation for the selected subscription.
59+
If the provided type is neither Microsoft.Support/supportTickets nor Microsoft.Support/fileWorkspaces, then it will default to Microsoft.Support/supportTickets.
5660

57-
### Example 2: {{ Add title here }}
61+
### Example 2: Check file workspace friendly name availability
5862
```powershell
59-
{{ Add code here }}
63+
Test-AzSupportTicketsNoSubscriptionNameAvailability -Name "testFileWorkspaceName" -Type "Microsoft.Support/fileWorkspaces"
6064
```
6165

6266
```output
63-
{{ Add output here (remove the output block if the example doesn't have an output) }}
67+
Message NameAvailable Reason
68+
------- ------------- ------
69+
True
6470
```
6571

66-
{{ Add description here }}
72+
Check the availability of a resource name.
73+
This API should be used to check the uniqueness of the name for file workspace creation for the selected subscription.
74+
If the provided type is neither Microsoft.Support/supportTickets nor Microsoft.Support/fileWorkspaces, then it will default to Microsoft.Support/supportTickets.
6775

6876
## PARAMETERS
6977

‎src/Support/Support.Autorest/examples/Test-AzSupportCommunicationNameAvailability.md‎

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,12 @@
1-
### Example 1: {{ Add title here }}
1+
### Example 1: Check friendly name availability of a communication for a support ticket
22
```powershell
3-
{{ Add code here }}
3+
Test-AzSupportCommunicationNameAvailability -Name "testCommunication" -SupportTicketName "2402084010005835" -Type "Microsoft.Support/communications"
44
```
55

66
```output
7-
{{ Add output here (remove the output block if the example doesn't have an output) }}
7+
Message NameAvailable Reason
8+
------- ------------- ------
9+
True
810
```
911

10-
{{ Add description here }}
11-
12-
### Example 2: {{ Add title here }}
13-
```powershell
14-
{{ Add code here }}
15-
```
16-
17-
```output
18-
{{ Add output here (remove the output block if the example doesn't have an output) }}
19-
```
20-
21-
{{ Add description here }}
22-
12+
Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication to the support ticket under an Azure subscription.

‎src/Support/Support.Autorest/examples/Test-AzSupportCommunicationsNoSubscriptionNameAvailability.md‎

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,12 @@
1-
### Example 1: {{ Add title here }}
1+
### Example 1: Check friendly name availability of a communication for a support ticket
22
```powershell
3-
{{ Add code here }}
3+
Test-AzSupportCommunicationsNoSubscriptionNameAvailability -Name "testCommunication" -SupportTicketName "2402084010005835" -Type "Microsoft.Support/communications"
44
```
55

66
```output
7-
{{ Add output here (remove the output block if the example doesn't have an output) }}
7+
Message NameAvailable Reason
8+
------- ------------- ------
9+
True
810
```
911

10-
{{ Add description here }}
11-
12-
### Example 2: {{ Add title here }}
13-
```powershell
14-
{{ Add code here }}
15-
```
16-
17-
```output
18-
{{ Add output here (remove the output block if the example doesn't have an output) }}
19-
```
20-
21-
{{ Add description here }}
22-
12+
Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication to the support ticket.

‎src/Support/Support.Autorest/examples/Test-AzSupportTicketNameAvailability.md‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
1-
### Example 1: {{ Add title here }}
1+
### Example 1: Check support ticket friendly name availability
22
```powershell
3-
{{ Add code here }}
3+
Test-AzSupportTicketNameAvailability -Name "testSupportTicketName" -Type "Microsoft.Support/supportTickets"
44
```
55

66
```output
7-
{{ Add output here (remove the output block if the example doesn't have an output) }}
7+
Message NameAvailable Reason
8+
------- ------------- ------
9+
True
810
```
911

10-
{{ Add description here }}
12+
Check the availability of a resource name. This API should be used to check the uniqueness of the name for support ticket creation for the selected subscription.
13+
If the provided type is neither Microsoft.Support/supportTickets nor Microsoft.Support/fileWorkspaces, then it will default to Microsoft.Support/supportTickets.
1114

12-
### Example 2: {{ Add title here }}
15+
### Example 2: Check file workspace friendly name availability
1316
```powershell
14-
{{ Add code here }}
17+
Test-AzSupportTicketNameAvailability -Name "testFileWorkspaceName" -Type "Microsoft.Support/fileWorkspaces"
1518
```
1619

1720
```output
18-
{{ Add output here (remove the output block if the example doesn't have an output) }}
21+
Message NameAvailable Reason
22+
------- ------------- ------
23+
True
1924
```
2025

21-
{{ Add description here }}
22-
26+
Check the availability of a resource name. This API should be used to check the uniqueness of the name for file workspace creation for the selected subscription.
27+
If the provided type is neither Microsoft.Support/supportTickets nor Microsoft.Support/fileWorkspaces, then it will default to Microsoft.Support/supportTickets.

‎src/Support/Support.Autorest/examples/Test-AzSupportTicketsNoSubscriptionNameAvailability.md‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
1-
### Example 1: {{ Add title here }}
1+
### Example 1: Check support ticket friendly name availability
22
```powershell
3-
{{ Add code here }}
3+
Test-AzSupportTicketsNoSubscriptionNameAvailability -Name "testSupportTicketName" -Type "Microsoft.Support/supportTickets"
44
```
55

66
```output
7-
{{ Add output here (remove the output block if the example doesn't have an output) }}
7+
Message NameAvailable Reason
8+
------- ------------- ------
9+
True
810
```
911

10-
{{ Add description here }}
12+
Check the availability of a resource name. This API should be used to check the uniqueness of the name for support ticket creation for the selected subscription.
13+
If the provided type is neither Microsoft.Support/supportTickets nor Microsoft.Support/fileWorkspaces, then it will default to Microsoft.Support/supportTickets.
1114

12-
### Example 2: {{ Add title here }}
15+
### Example 2: Check file workspace friendly name availability
1316
```powershell
14-
{{ Add code here }}
17+
Test-AzSupportTicketsNoSubscriptionNameAvailability -Name "testFileWorkspaceName" -Type "Microsoft.Support/fileWorkspaces"
1518
```
1619

1720
```output
18-
{{ Add output here (remove the output block if the example doesn't have an output) }}
21+
Message NameAvailable Reason
22+
------- ------------- ------
23+
True
1924
```
2025

21-
{{ Add description here }}
22-
26+
Check the availability of a resource name. This API should be used to check the uniqueness of the name for file workspace creation for the selected subscription.
27+
If the provided type is neither Microsoft.Support/supportTickets nor Microsoft.Support/fileWorkspaces, then it will default to Microsoft.Support/supportTickets.

0 commit comments

Comments
 (0)