Skip to content

Documentation for file workspace, file, check name availability, service, problem classification cmdlets for subscription and no subscription scenarios #2

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.

Sign up for GitHub

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

Merged
grhuangmsft merged 6 commits into from
Feb 16, 2024
Merged

Documentation for file workspace, file, check name availability, service, problem classification cmdlets for subscription and no subscription scenarios #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
913b1bb
docs for get support service
grhuangmsft Feb 7, 2024
452e2d0
problem classification docs
grhuangmsft Feb 7, 2024
54c1f1d
add titles
grhuangmsft Feb 7, 2024
5878a49
documentation for file workspace commands
grhuangmsft Feb 8, 2024
c41fec4
documentation for file/file workspace cmdlets
grhuangmsft Feb 9, 2024
3851a1d
documentation for checkNameAvailability
grhuangmsft Feb 13, 2024
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
70 changes: 62 additions & 8 deletions src/Support/Support.Autorest/docs/Get-AzSupportFile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,27 +40,81 @@ Returns details of a specific file in a work space.

## EXAMPLES

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

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

{{ Add description here }}
Lists all the Files information under a workspace for an Azure subscription.

### Example 2: {{ Add title here }}
### Example 2: Get details of a file in a file workspace
```powershell
{{ Add code here }}
Get-AzSupportFile -Name "test.txt" -WorkspaceName "testworkspace"
```

```output
{{ Add output here (remove the output block if the example doesn't have an output) }}
ChunkSize : 4
CreatedOn : 2/9/2024 3:53:15 PM
FileSize : 4
Id : /subscriptions/3bb7379e-e102-4603-a59c-60f5ca39ec55/providers/Microsoft.Support/fileWorkspaces/testworkspace/files/test.txt
Name : test.txt
NumberOfChunk : 1
ResourceGroupName :
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
Type : Microsoft.Support/files
```

Returns details of a specific file in a workspace.

### Example 3: List all files from a support ticket
```powershell
Get-AzSupportFile -WorkspaceName "2402084010005835"
```

{{ Add description here }}
```output
Name CreatedOn ChunkSize FileSize
---- --------- --------- --------
test.txt 2/9/2024 3:53:15 PM 4 4
test2.txt 2/9/2024 3:53:29 PM 4 4
```

Lists all the Files information under a support ticket for an Azure subscription.

### Example 2: Get details of a file under a support ticket
```powershell
Get-AzSupportFile -Name "test.txt" -WorkspaceName "2402084010005835"
```

```output
ChunkSize : 4
CreatedOn : 2/9/2024 3:53:15 PM
FileSize : 4
Id : /subscriptions/3bb7379e-e102-4603-a59c-60f5ca39ec55/providers/Microsoft.Support/fileWorkspaces/2402084010005835/files/test.txt
Name : test.txt
NumberOfChunk : 1
ResourceGroupName :
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
Type : Microsoft.Support/files
```

Returns details of a specific file under a support ticket.

## PARAMETERS

Expand Down
38 changes: 30 additions & 8 deletions src/Support/Support.Autorest/docs/Get-AzSupportFileWorkspace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,27 +28,49 @@ Gets details for a specific file workspace in an Azure subscription.

## EXAMPLES

### Example 1: {{ Add title here }}
### Example 1: Get information about a file workspace
```powershell
{{ Add code here }}
Get-AzSupportFileWorkspace -Name "testworkspace"
```

```output
{{ Add output here (remove the output block if the example doesn't have an output) }}
CreatedOn : 2/8/2024 3:51:36 PM
ExpirationTime : 2/9/2024 3:51:36 PM
Id : /subscriptions/3bb7379e-e102-4603-a59c-60f5ca39ec55/providers/Microsoft.Support/fileWorkspaces/testworkspace
Name : testworkspace
ResourceGroupName :
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
Type : Microsoft.Support/fileWorkspaces
```

{{ Add description here }}
Gets details for a specific file workspace in an Azure subscription.

### Example 2: {{ Add title here }}
### Example 1: Get information about a file workspace for a support ticket
```powershell
{{ Add code here }}
Get-AzSupportFileWorkspace -Name "2402084010005835"
```

```output
{{ Add output here (remove the output block if the example doesn't have an output) }}
CreatedOn : 2/8/2024 3:51:36 PM
ExpirationTime : 8/9/2024 3:51:36 PM
Id : /subscriptions/3bb7379e-e102-4603-a59c-60f5ca39ec55/providers/Microsoft.Support/fileWorkspaces/2402084010005835
Name : 2402084010005835
ResourceGroupName :
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
Type : Microsoft.Support/fileWorkspaces
```

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

## PARAMETERS

Expand Down
38 changes: 30 additions & 8 deletions src/Support/Support.Autorest/docs/Get-AzSupportFileWorkspacesNoSubscription.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,27 +29,49 @@ Gets details for a specific file workspace.

## EXAMPLES

### Example 1: {{ Add title here }}
### Example 1: Get a file workspace
```powershell
{{ Add code here }}
Get-AzSupportFileWorkspacesNoSubscription -Name "testworkspace"
```

```output
{{ Add output here (remove the output block if the example doesn't have an output) }}
CreatedOn : 2/8/2024 4:25:38 PM
ExpirationTime : 2/9/2024 4:25:38 PM
Id : /providers/Microsoft.Support/fileWorkspaces/testworkspace
Name : testworkspace
ResourceGroupName :
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
Type : Microsoft.Support/fileWorkspaces
```

{{ Add description here }}
Gets details for a specific file workspace.

### Example 2: {{ Add title here }}
### Example 1: Get information about a file workspace for a support ticket
```powershell
{{ Add code here }}
Get-AzSupportFileWorkspace -Name "2402084010005835"
```

```output
{{ Add output here (remove the output block if the example doesn't have an output) }}
CreatedOn : 2/8/2024 3:51:36 PM
ExpirationTime : 8/9/2024 3:51:36 PM
Id : /providers/Microsoft.Support/fileWorkspaces/2402084010005835
Name : 2402084010005835
ResourceGroupName :
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
Type : Microsoft.Support/fileWorkspaces
```

{{ Add description here }}
Gets details for a specific file workspace under a support ticket.

## PARAMETERS

Expand Down
70 changes: 62 additions & 8 deletions src/Support/Support.Autorest/docs/Get-AzSupportFilesNoSubscription.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,27 +40,81 @@ Returns details of a specific file in a work space.

## EXAMPLES

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

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

{{ Add description here }}
Lists all the Files information under a workspace

### Example 2: {{ Add title here }}
### Example 2: Get details of a file in a file workspace
```powershell
{{ Add code here }}
Get-AzSupportFilesNoSubscription -Name "test.txt" -WorkspaceName "testworkspace"
```

```output
{{ Add output here (remove the output block if the example doesn't have an output) }}
ChunkSize : 4
CreatedOn : 2/9/2024 3:53:15 PM
FileSize : 4
Id : /providers/Microsoft.Support/fileWorkspaces/testworkspace/files/test.txt
Name : test.txt
NumberOfChunk : 1
ResourceGroupName :
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
Type : Microsoft.Support/files
```

Returns details of a specific file in a workspace.

### Example 3: List all files from a support ticket
```powershell
Get-AzSupportFilesNoSubscription -WorkspaceName "2402084010005835"
```

{{ Add description here }}
```output
Name CreatedOn ChunkSize FileSize
---- --------- --------- --------
test.txt 2/9/2024 3:53:15 PM 4 4
test2.txt 2/9/2024 3:53:29 PM 4 4
```

Lists all the Files information under a support ticket.

### Example 2: Get details of a file under a support ticket
```powershell
Get-AzSupportFilesNoSubscription -Name "test.txt" -WorkspaceName "2402084010005835"
```

```output
ChunkSize : 4
CreatedOn : 2/9/2024 3:53:15 PM
FileSize : 4
Id : /providers/Microsoft.Support/fileWorkspaces/2402084010005835/files/test.txt
Name : test.txt
NumberOfChunk : 1
ResourceGroupName :
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
Type : Microsoft.Support/files
```

Returns details of a specific file under a support ticket.

## PARAMETERS

Expand Down
27 changes: 19 additions & 8 deletions src/Support/Support.Autorest/docs/Get-AzSupportProblemClassification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,27 +40,38 @@ Get problem classification details for a specific Azure service.

## EXAMPLES

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

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

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

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

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

{{ Add description here }}
Get problem classification details for a specific Azure service.

## PARAMETERS

Expand Down
28 changes: 20 additions & 8 deletions src/Support/Support.Autorest/docs/Get-AzSupportService.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,27 +32,39 @@ Gets a specific Azure service for support ticket creation.

## EXAMPLES

### Example 1: {{ Add title here }}
### Example 1: List Azure Support Services
```powershell
{{ Add code here }}
Get-AzSupportService
```

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

{{ Add description here }}
Lists all the Azure services available for support ticket creation.
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.
Always use the service and its corresponding problem classification(s) obtained programmatically for support ticket creation.
This practice ensures that you always have the most recent set of service and problem classification Ids.

### Example 2: {{ Add title here }}
### Example 2: Get Azure Support Service
```powershell
{{ Add code here }}
Get-AzSupportService -Name "484e2236-bc6d-b1bb-76d2-7d09278cf9ea"
```

```output
{{ Add output here (remove the output block if the example doesn't have an output) }}
DisplayName : Activity Logs
Id : /providers/Microsoft.Support/services/484e2236-bc6d-b1bb-76d2-7d09278cf9ea
Name : 484e2236-bc6d-b1bb-76d2-7d09278cf9ea
ResourceGroupName :
ResourceType : {}
Type : Microsoft.Support/services
```

{{ Add description here }}
Gets a specific Azure service for support ticket creation.

## PARAMETERS

Expand Down
Loading