Skip to content

Commit 762b446

Browse files
grhuangmsftgrhuangmsft
authored
Merge pull request #2 from grhuangmsft/users/grhuang/azsupport-autorest-feature
Documentation for file workspace, file, check name availability, service, problem classification cmdlets for subscription and no subscription scenarios
2 parents 7bdc9aa + 3851a1d commit 762b446

28 files changed

+722
-286
lines changed

‎src/Support/Support.Autorest/docs/Get-AzSupportFile.md

Lines changed: 62 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,27 +40,81 @@ Returns details of a specific file in a work space.
4040

4141
## EXAMPLES
4242

43-
### Example 1: {{ Add title here }}
43+
### Example 1: List all files from a file workspace
4444
```powershell
45-
{{ Add code here }}
45+
Get-AzSupportFile -WorkspaceName "testworkspace"
4646
```
4747

4848
```output
49-
{{ Add output here (remove the output block if the example doesn't have an output) }}
49+
Name CreatedOn ChunkSize FileSize
50+
---- --------- --------- --------
51+
test.txt 2/9/2024 3:53:15 PM 4 4
52+
test2.txt 2/9/2024 3:53:29 PM 4 4
5053
```
5154

52-
{{ Add description here }}
55+
Lists all the Files information under a workspace for an Azure subscription.
5356

54-
### Example 2: {{ Add title here }}
57+
### Example 2: Get details of a file in a file workspace
5558
```powershell
56-
{{ Add code here }}
59+
Get-AzSupportFile -Name "test.txt" -WorkspaceName "testworkspace"
5760
```
5861

5962
```output
60-
{{ Add output here (remove the output block if the example doesn't have an output) }}
63+
ChunkSize : 4
64+
CreatedOn : 2/9/2024 3:53:15 PM
65+
FileSize : 4
66+
Id : /subscriptions/3bb7379e-e102-4603-a59c-60f5ca39ec55/providers/Microsoft.Support/fileWorkspaces/testworkspace/files/test.txt
67+
Name : test.txt
68+
NumberOfChunk : 1
69+
ResourceGroupName :
70+
SystemDataCreatedAt :
71+
SystemDataCreatedBy :
72+
SystemDataCreatedByType :
73+
SystemDataLastModifiedAt :
74+
SystemDataLastModifiedBy :
75+
SystemDataLastModifiedByType :
76+
Type : Microsoft.Support/files
77+
```
78+
79+
Returns details of a specific file in a workspace.
80+
81+
### Example 3: List all files from a support ticket
82+
```powershell
83+
Get-AzSupportFile -WorkspaceName "2402084010005835"
6184
```
6285

63-
{{ Add description here }}
86+
```output
87+
Name CreatedOn ChunkSize FileSize
88+
---- --------- --------- --------
89+
test.txt 2/9/2024 3:53:15 PM 4 4
90+
test2.txt 2/9/2024 3:53:29 PM 4 4
91+
```
92+
93+
Lists all the Files information under a support ticket for an Azure subscription.
94+
95+
### Example 2: Get details of a file under a support ticket
96+
```powershell
97+
Get-AzSupportFile -Name "test.txt" -WorkspaceName "2402084010005835"
98+
```
99+
100+
```output
101+
ChunkSize : 4
102+
CreatedOn : 2/9/2024 3:53:15 PM
103+
FileSize : 4
104+
Id : /subscriptions/3bb7379e-e102-4603-a59c-60f5ca39ec55/providers/Microsoft.Support/fileWorkspaces/2402084010005835/files/test.txt
105+
Name : test.txt
106+
NumberOfChunk : 1
107+
ResourceGroupName :
108+
SystemDataCreatedAt :
109+
SystemDataCreatedBy :
110+
SystemDataCreatedByType :
111+
SystemDataLastModifiedAt :
112+
SystemDataLastModifiedBy :
113+
SystemDataLastModifiedByType :
114+
Type : Microsoft.Support/files
115+
```
116+
117+
Returns details of a specific file under a support ticket.
64118

65119
## PARAMETERS
66120

‎src/Support/Support.Autorest/docs/Get-AzSupportFileWorkspace.md

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,27 +28,49 @@ Gets details for a specific file workspace in an Azure subscription.
2828

2929
## EXAMPLES
3030

31-
### Example 1: {{ Add title here }}
31+
### Example 1: Get information about a file workspace
3232
```powershell
33-
{{ Add code here }}
33+
Get-AzSupportFileWorkspace -Name "testworkspace"
3434
```
3535

3636
```output
37-
{{ Add output here (remove the output block if the example doesn't have an output) }}
37+
CreatedOn : 2/8/2024 3:51:36 PM
38+
ExpirationTime : 2/9/2024 3:51:36 PM
39+
Id : /subscriptions/3bb7379e-e102-4603-a59c-60f5ca39ec55/providers/Microsoft.Support/fileWorkspaces/testworkspace
40+
Name : testworkspace
41+
ResourceGroupName :
42+
SystemDataCreatedAt :
43+
SystemDataCreatedBy :
44+
SystemDataCreatedByType :
45+
SystemDataLastModifiedAt :
46+
SystemDataLastModifiedBy :
47+
SystemDataLastModifiedByType :
48+
Type : Microsoft.Support/fileWorkspaces
3849
```
3950

40-
{{ Add description here }}
51+
Gets details for a specific file workspace in an Azure subscription.
4152

42-
### Example 2: {{ Add title here }}
53+
### Example 1: Get information about a file workspace for a support ticket
4354
```powershell
44-
{{ Add code here }}
55+
Get-AzSupportFileWorkspace -Name "2402084010005835"
4556
```
4657

4758
```output
48-
{{ Add output here (remove the output block if the example doesn't have an output) }}
59+
CreatedOn : 2/8/2024 3:51:36 PM
60+
ExpirationTime : 8/9/2024 3:51:36 PM
61+
Id : /subscriptions/3bb7379e-e102-4603-a59c-60f5ca39ec55/providers/Microsoft.Support/fileWorkspaces/2402084010005835
62+
Name : 2402084010005835
63+
ResourceGroupName :
64+
SystemDataCreatedAt :
65+
SystemDataCreatedBy :
66+
SystemDataCreatedByType :
67+
SystemDataLastModifiedAt :
68+
SystemDataLastModifiedBy :
69+
SystemDataLastModifiedByType :
70+
Type : Microsoft.Support/fileWorkspaces
4971
```
5072

51-
{{ Add description here }}
73+
Gets details for a specific file workspace under a support ticket in an Azure subscription.
5274

5375
## PARAMETERS
5476

‎src/Support/Support.Autorest/docs/Get-AzSupportFileWorkspacesNoSubscription.md

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,27 +29,49 @@ Gets details for a specific file workspace.
2929

3030
## EXAMPLES
3131

32-
### Example 1: {{ Add title here }}
32+
### Example 1: Get a file workspace
3333
```powershell
34-
{{ Add code here }}
34+
Get-AzSupportFileWorkspacesNoSubscription -Name "testworkspace"
3535
```
3636

3737
```output
38-
{{ Add output here (remove the output block if the example doesn't have an output) }}
38+
CreatedOn : 2/8/2024 4:25:38 PM
39+
ExpirationTime : 2/9/2024 4:25:38 PM
40+
Id : /providers/Microsoft.Support/fileWorkspaces/testworkspace
41+
Name : testworkspace
42+
ResourceGroupName :
43+
SystemDataCreatedAt :
44+
SystemDataCreatedBy :
45+
SystemDataCreatedByType :
46+
SystemDataLastModifiedAt :
47+
SystemDataLastModifiedBy :
48+
SystemDataLastModifiedByType :
49+
Type : Microsoft.Support/fileWorkspaces
3950
```
4051

41-
{{ Add description here }}
52+
Gets details for a specific file workspace.
4253

43-
### Example 2: {{ Add title here }}
54+
### Example 1: Get information about a file workspace for a support ticket
4455
```powershell
45-
{{ Add code here }}
56+
Get-AzSupportFileWorkspace -Name "2402084010005835"
4657
```
4758

4859
```output
49-
{{ Add output here (remove the output block if the example doesn't have an output) }}
60+
CreatedOn : 2/8/2024 3:51:36 PM
61+
ExpirationTime : 8/9/2024 3:51:36 PM
62+
Id : /providers/Microsoft.Support/fileWorkspaces/2402084010005835
63+
Name : 2402084010005835
64+
ResourceGroupName :
65+
SystemDataCreatedAt :
66+
SystemDataCreatedBy :
67+
SystemDataCreatedByType :
68+
SystemDataLastModifiedAt :
69+
SystemDataLastModifiedBy :
70+
SystemDataLastModifiedByType :
71+
Type : Microsoft.Support/fileWorkspaces
5072
```
5173

52-
{{ Add description here }}
74+
Gets details for a specific file workspace under a support ticket.
5375

5476
## PARAMETERS
5577

‎src/Support/Support.Autorest/docs/Get-AzSupportFilesNoSubscription.md

Lines changed: 62 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,27 +40,81 @@ Returns details of a specific file in a work space.
4040

4141
## EXAMPLES
4242

43-
### Example 1: {{ Add title here }}
43+
### Example 1: List all files from a file workspace
4444
```powershell
45-
{{ Add code here }}
45+
Get-AzSupportFilesNoSubscription -WorkspaceName "testworkspace"
4646
```
4747

4848
```output
49-
{{ Add output here (remove the output block if the example doesn't have an output) }}
49+
Name CreatedOn ChunkSize FileSize
50+
---- --------- --------- --------
51+
test.txt 2/9/2024 3:53:15 PM 4 4
52+
test2.txt 2/9/2024 3:53:29 PM 4 4
5053
```
5154

52-
{{ Add description here }}
55+
Lists all the Files information under a workspace
5356

54-
### Example 2: {{ Add title here }}
57+
### Example 2: Get details of a file in a file workspace
5558
```powershell
56-
{{ Add code here }}
59+
Get-AzSupportFilesNoSubscription -Name "test.txt" -WorkspaceName "testworkspace"
5760
```
5861

5962
```output
60-
{{ Add output here (remove the output block if the example doesn't have an output) }}
63+
ChunkSize : 4
64+
CreatedOn : 2/9/2024 3:53:15 PM
65+
FileSize : 4
66+
Id : /providers/Microsoft.Support/fileWorkspaces/testworkspace/files/test.txt
67+
Name : test.txt
68+
NumberOfChunk : 1
69+
ResourceGroupName :
70+
SystemDataCreatedAt :
71+
SystemDataCreatedBy :
72+
SystemDataCreatedByType :
73+
SystemDataLastModifiedAt :
74+
SystemDataLastModifiedBy :
75+
SystemDataLastModifiedByType :
76+
Type : Microsoft.Support/files
77+
```
78+
79+
Returns details of a specific file in a workspace.
80+
81+
### Example 3: List all files from a support ticket
82+
```powershell
83+
Get-AzSupportFilesNoSubscription -WorkspaceName "2402084010005835"
6184
```
6285

63-
{{ Add description here }}
86+
```output
87+
Name CreatedOn ChunkSize FileSize
88+
---- --------- --------- --------
89+
test.txt 2/9/2024 3:53:15 PM 4 4
90+
test2.txt 2/9/2024 3:53:29 PM 4 4
91+
```
92+
93+
Lists all the Files information under a support ticket.
94+
95+
### Example 2: Get details of a file under a support ticket
96+
```powershell
97+
Get-AzSupportFilesNoSubscription -Name "test.txt" -WorkspaceName "2402084010005835"
98+
```
99+
100+
```output
101+
ChunkSize : 4
102+
CreatedOn : 2/9/2024 3:53:15 PM
103+
FileSize : 4
104+
Id : /providers/Microsoft.Support/fileWorkspaces/2402084010005835/files/test.txt
105+
Name : test.txt
106+
NumberOfChunk : 1
107+
ResourceGroupName :
108+
SystemDataCreatedAt :
109+
SystemDataCreatedBy :
110+
SystemDataCreatedByType :
111+
SystemDataLastModifiedAt :
112+
SystemDataLastModifiedBy :
113+
SystemDataLastModifiedByType :
114+
Type : Microsoft.Support/files
115+
```
116+
117+
Returns details of a specific file under a support ticket.
64118

65119
## PARAMETERS
66120

‎src/Support/Support.Autorest/docs/Get-AzSupportProblemClassification.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,27 +40,38 @@ Get problem classification details for a specific Azure service.
4040

4141
## EXAMPLES
4242

43-
### Example 1: {{ Add title here }}
43+
### Example 1: List Azure Support Problem Classifications
4444
```powershell
45-
{{ Add code here }}
45+
Get-AzSupportProblemClassification -ServiceName "6f16735c-b0ae-b275-ad3a-03479cfa1396"
4646
```
4747

4848
```output
49-
{{ Add output here (remove the output block if the example doesn't have an output) }}
49+
DisplayName Name SecondaryConsentEnabled
50+
----------- ---- -----------------------
51+
Compute-VM (cores-vCPUs) subscription limit increases 4d78b174-3203-a3ac-9e08-41fb35de6354
52+
Windows Update, Guest Patching and OS Upgrades / Issue with Azure Automatic VM guest patching e565bd13-86f0-ecb3-d2b7-0a7501ae8839
53+
Windows Update, Guest Patching and OS Upgrades / Issue with Azure Update Management patching 8d686480-ef41-5005-358e-12b9be9608fe
5054
```
5155

52-
{{ Add description here }}
56+
Lists all the problem classifications (categories) available for a specific Azure service.
57+
Always use the service and problem classifications obtained programmatically.
58+
This practice ensures that you always have the most recent set of service and problem classification Ids.
5359

54-
### Example 2: {{ Add title here }}
60+
### Example 2: Get Azure Support Problem Classification
5561
```powershell
56-
{{ Add code here }}
62+
Get-AzSupportProblemClassification -ServiceName "6f16735c-b0ae-b275-ad3a-03479cfa1396" -Name "e565bd13-86f0-ecb3-d2b7-0a7501ae8839"
5763
```
5864

5965
```output
60-
{{ Add output here (remove the output block if the example doesn't have an output) }}
66+
DisplayName : Windows Update, Guest Patching and OS Upgrades / Issue with Azure Automatic VM guest patching
67+
Id : /providers/Microsoft.Support/services/6f16735c-b0ae-b275-ad3a-03479cfa1396/problemClassifications/e565bd13-86f0-ecb3-d2b7-0a7501ae8839
68+
Name : e565bd13-86f0-ecb3-d2b7-0a7501ae8839
69+
ResourceGroupName :
70+
SecondaryConsentEnabled :
71+
Type : Microsoft.Support/problemClassifications
6172
```
6273

63-
{{ Add description here }}
74+
Get problem classification details for a specific Azure service.
6475

6576
## PARAMETERS
6677

‎src/Support/Support.Autorest/docs/Get-AzSupportService.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,27 +32,39 @@ Gets a specific Azure service for support ticket creation.
3232

3333
## EXAMPLES
3434

35-
### Example 1: {{ Add title here }}
35+
### Example 1: List Azure Support Services
3636
```powershell
37-
{{ Add code here }}
37+
Get-AzSupportService
3838
```
3939

4040
```output
41-
{{ Add output here (remove the output block if the example doesn't have an output) }}
41+
DisplayName Name ResourceType
42+
----------- ---- ------------
43+
Activity Logs 484e2236-bc6d-b1bb-76d2-7d09278cf9ea {}
44+
Advisor 26d8424b-0a41-4443-cbc6-0309ea8708d0 {}
45+
AKS Edge Essentials 1232100c-42c0-f626-2b4f-8c8a4877acad {Microsoft.Kubernetes/connectedClusters}
4246
```
4347

44-
{{ Add description here }}
48+
Lists all the Azure services available for support ticket creation.
49+
For **Technical** issues, select the Service Id that maps to the Azure service/product as displayed in the **Services** drop-down list on the Azure portal's [New support request](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/overview) page.
50+
Always use the service and its corresponding problem classification(s) obtained programmatically for support ticket creation.
51+
This practice ensures that you always have the most recent set of service and problem classification Ids.
4552

46-
### Example 2: {{ Add title here }}
53+
### Example 2: Get Azure Support Service
4754
```powershell
48-
{{ Add code here }}
55+
Get-AzSupportService -Name "484e2236-bc6d-b1bb-76d2-7d09278cf9ea"
4956
```
5057

5158
```output
52-
{{ Add output here (remove the output block if the example doesn't have an output) }}
59+
DisplayName : Activity Logs
60+
Id : /providers/Microsoft.Support/services/484e2236-bc6d-b1bb-76d2-7d09278cf9ea
61+
Name : 484e2236-bc6d-b1bb-76d2-7d09278cf9ea
62+
ResourceGroupName :
63+
ResourceType : {}
64+
Type : Microsoft.Support/services
5365
```
5466

55-
{{ Add description here }}
67+
Gets a specific Azure service for support ticket creation.
5668

5769
## PARAMETERS
5870

0 commit comments

Comments
 (0)