Skip to content

Commit c41fec4

Browse files
grhuangmsftgrhuangmsft
committed
documentation for file/file workspace cmdlets
1 parent 5878a49 commit c41fec4

12 files changed

+472
-66
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: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Gets details for a specific file workspace in an Azure subscription.
2828

2929
## EXAMPLES
3030

31-
### Example 1: Get a file workspace
31+
### Example 1: Get information about a file workspace
3232
```powershell
3333
Get-AzSupportFileWorkspace -Name "testworkspace"
3434
```
@@ -50,6 +50,28 @@ Type : Microsoft.Support/fileWorkspaces
5050

5151
Gets details for a specific file workspace in an Azure subscription.
5252

53+
### Example 1: Get information about a file workspace for a support ticket
54+
```powershell
55+
Get-AzSupportFileWorkspace -Name "2402084010005835"
56+
```
57+
58+
```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
71+
```
72+
73+
Gets details for a specific file workspace under a support ticket in an Azure subscription.
74+
5375
## PARAMETERS
5476

5577
### -DefaultProfile

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,28 @@ Type : Microsoft.Support/fileWorkspaces
5151

5252
Gets details for a specific file workspace.
5353

54+
### Example 1: Get information about a file workspace for a support ticket
55+
```powershell
56+
Get-AzSupportFileWorkspace -Name "2402084010005835"
57+
```
58+
59+
```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
72+
```
73+
74+
Gets details for a specific file workspace under a support ticket.
75+
5476
## PARAMETERS
5577

5678
### -DefaultProfile

‎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/New-AzSupportFileAndUpload.md‎

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,27 +22,53 @@ Creates and uploads a new file under a workspace for the specified subscription.
2222

2323
## EXAMPLES
2424

25-
### Example 1: {{ Add title here }}
25+
### Example 1: Create and upload a file to a file workspace
2626
```powershell
27-
{{ Add code here }}
27+
New-AzSupportFileAndUpload -WorkspaceName "testworkspace" -FilePath "C:\path\to\file\test.txt"
2828
```
2929

3030
```output
31-
{{ Add output here (remove the output block if the example doesn't have an output) }}
31+
ChunkSize : 4
32+
CreatedOn : 2/9/2024 4:06:13 PM
33+
FileSize : 4
34+
Id : /subscriptions/3bb7379e-e102-4603-a59c-60f5ca39ec55/providers/Microsoft.Support/fileWorkspaces/testworkspace/files/test.txt
35+
Name : test.txt
36+
NumberOfChunk : 1
37+
ResourceGroupName :
38+
SystemDataCreatedAt :
39+
SystemDataCreatedBy :
40+
SystemDataCreatedByType :
41+
SystemDataLastModifiedAt :
42+
SystemDataLastModifiedBy :
43+
SystemDataLastModifiedByType :
44+
Type : Microsoft.Support/files
3245
```
3346

34-
{{ Add description here }}
47+
Create a new file and upload content in a file workspace for an Azure subscription.
3548

36-
### Example 2: {{ Add title here }}
49+
### Example 2: Create and upload a file to a support ticket
3750
```powershell
38-
{{ Add code here }}
51+
New-AzSupportFileAndUpload -WorkspaceName "2402084010005835" -FilePath "C:\path\to\file\test.txt"
3952
```
4053

4154
```output
42-
{{ Add output here (remove the output block if the example doesn't have an output) }}
55+
ChunkSize : 4
56+
CreatedOn : 2/9/2024 4:06:13 PM
57+
FileSize : 4
58+
Id : /subscriptions/3bb7379e-e102-4603-a59c-60f5ca39ec55/providers/Microsoft.Support/fileWorkspaces/2402084010005835/files/test.txt
59+
Name : test.txt
60+
NumberOfChunk : 1
61+
ResourceGroupName :
62+
SystemDataCreatedAt :
63+
SystemDataCreatedBy :
64+
SystemDataCreatedByType :
65+
SystemDataLastModifiedAt :
66+
SystemDataLastModifiedBy :
67+
SystemDataLastModifiedByType :
68+
Type : Microsoft.Support/files
4369
```
4470

45-
{{ Add description here }}
71+
Create a new file and upload content to a support ticket in an Azure subscription.
4672

4773
## PARAMETERS
4874

‎src/Support/Support.Autorest/docs/New-AzSupportFileAndUploadNoSubscription.md‎

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,27 +22,53 @@ Creates and uploads a new file under a workspace for the specified subscription.
2222

2323
## EXAMPLES
2424

25-
### Example 1: {{ Add title here }}
25+
### Example 1: Create and upload a file to a file workspace
2626
```powershell
27-
{{ Add code here }}
27+
New-AzSupportFileAndUploadNoSubscription -WorkspaceName "testworkspace" -FilePath "C:\path\to\file\test.txt"
2828
```
2929

3030
```output
31-
{{ Add output here (remove the output block if the example doesn't have an output) }}
31+
ChunkSize : 4
32+
CreatedOn : 2/9/2024 4:06:13 PM
33+
FileSize : 4
34+
Id : /providers/Microsoft.Support/fileWorkspaces/testworkspace/files/test.txt
35+
Name : test.txt
36+
NumberOfChunk : 1
37+
ResourceGroupName :
38+
SystemDataCreatedAt :
39+
SystemDataCreatedBy :
40+
SystemDataCreatedByType :
41+
SystemDataLastModifiedAt :
42+
SystemDataLastModifiedBy :
43+
SystemDataLastModifiedByType :
44+
Type : Microsoft.Support/files
3245
```
3346

34-
{{ Add description here }}
47+
Create a new file and upload content in a file workspace.
3548

36-
### Example 2: {{ Add title here }}
49+
### Example 2: Create and upload a file to a support ticket
3750
```powershell
38-
{{ Add code here }}
51+
New-AzSupportFileAndUploadNoSubscription -WorkspaceName "2402084010005835" -FilePath "C:\path\to\file\test.txt"
3952
```
4053

4154
```output
42-
{{ Add output here (remove the output block if the example doesn't have an output) }}
55+
ChunkSize : 4
56+
CreatedOn : 2/9/2024 4:06:13 PM
57+
FileSize : 4
58+
Id : /providers/Microsoft.Support/fileWorkspaces/2402084010005835/files/test.txt
59+
Name : test.txt
60+
NumberOfChunk : 1
61+
ResourceGroupName :
62+
SystemDataCreatedAt :
63+
SystemDataCreatedBy :
64+
SystemDataCreatedByType :
65+
SystemDataLastModifiedAt :
66+
SystemDataLastModifiedBy :
67+
SystemDataLastModifiedByType :
68+
Type : Microsoft.Support/files
4369
```
4470

45-
{{ Add description here }}
71+
Create a new file and upload content to a support ticket.
4672

4773
## PARAMETERS
4874

0 commit comments

Comments
 (0)