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

[Support RP] CLI release GA version 2024-04-01 #482

Merged
merged 11 commits into from
May 14, 2024
591 changes: 297 additions & 294 deletions Commands/readme.md

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions Commands/support/in-subscription/_check-name-availability.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# [Command] _support in-subscription check-name-availability_

Check the availability of a resource name. This API should be used to check the uniqueness of the resource name for the selected subscription.

## Versions

### [2024-04-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5zdXBwb3J0L2NoZWNrbmFtZWF2YWlsYWJpbGl0eQ==/2024-04-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.support/checknameavailability 2024-04-01 -->
16 changes: 16 additions & 0 deletions Commands/support/in-subscription/chat-transcript/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _support in-subscription chat-transcript list_

List all chat transcripts for a support ticket under subscription

## Versions

### [2024-04-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5zdXBwb3J0L3N1cHBvcnR0aWNrZXRzL3t9L2NoYXR0cmFuc2NyaXB0cw==/2024-04-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.support/supporttickets/{}/chattranscripts 2024-04-01 -->

#### examples

- List all chat transcripts for a support ticket under subscription
```bash
support in-subscription chat-transcript list --ticket-name "TestTicketName"
```
16 changes: 16 additions & 0 deletions Commands/support/in-subscription/chat-transcript/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _support in-subscription chat-transcript show_

Get chatTranscript details for a support ticket under a subscription.

## Versions

### [2024-04-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5zdXBwb3J0L3N1cHBvcnR0aWNrZXRzL3t9L2NoYXR0cmFuc2NyaXB0cy97fQ==/2024-04-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.support/supporttickets/{}/chattranscripts/{} 2024-04-01 -->

#### examples

- Get chatTranscript details for a support ticket under a subscription.
```bash
support in-subscription chat-transcript show --ticket-name "TestTicketName" --chat-transcript-name "TestChatTranscriptName"
```
11 changes: 11 additions & 0 deletions Commands/support/in-subscription/chat-transcript/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# [Group] _support in-subscription chat-transcript_

Manage support ticket chat transcript

## Commands

- [list](/Commands/support/in-subscription/chat-transcript/_list.md)
: List all chat transcripts for a support ticket under subscription

- [show](/Commands/support/in-subscription/chat-transcript/_show.md)
: Get chatTranscript details for a support ticket under a subscription.
16 changes: 16 additions & 0 deletions Commands/support/in-subscription/communication/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _support in-subscription communication create_

Adds a new customer communication to an Azure support ticket.

## Versions

### [2024-04-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5zdXBwb3J0L3N1cHBvcnR0aWNrZXRzL3t9L2NvbW11bmljYXRpb25zL3t9/2024-04-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.support/supporttickets/{}/communications/{} 2024-04-01 -->

#### examples

- Adds a new customer communication to an Azure support ticket.
```bash
support in-subscription communication create --ticket-name "TestTicketName "--communication-name "TestTicketCommunicationName" --communication-body "TicketCommunicationBody" --communication-subject "TicketCommunicationSubject"
```
16 changes: 16 additions & 0 deletions Commands/support/in-subscription/communication/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _support in-subscription communication list_

List all communications (attachments not included) for a support ticket. <br/></br> You can also filter support ticket communications by _CreatedDate_ or _CommunicationType_ using the $filter parameter. The only type of communication supported today is _Web_. Output will be a paged result with _nextLink_, using which you can retrieve the next set of Communication results. <br/><br/>Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.

## Versions

### [2024-04-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5zdXBwb3J0L3N1cHBvcnR0aWNrZXRzL3t9L2NvbW11bmljYXRpb25z/2024-04-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.support/supporttickets/{}/communications 2024-04-01 -->

#### examples

- List web communication created on or after a specific date for a subscription support ticket.
```bash
support in-subscription communication list --ticket-name "TestTicketName" --filter "CreatedDate ge 2024-01-01"
```
16 changes: 16 additions & 0 deletions Commands/support/in-subscription/communication/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _support in-subscription communication show_

Get communication details for a support ticket.

## Versions

### [2024-04-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5zdXBwb3J0L3N1cHBvcnR0aWNrZXRzL3t9L2NvbW11bmljYXRpb25zL3t9/2024-04-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.support/supporttickets/{}/communications/{} 2024-04-01 -->

#### examples

- Get communication details for a subscription support ticket.
```bash
support in-subscription communication show --ticket-name "TestTicketName" --communication-name "TestTicketCommunicationName"
```
9 changes: 9 additions & 0 deletions Commands/support/in-subscription/communication/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# [Command] _support in-subscription communication update_

Update a new customer communication to an Azure support ticket.

## Versions

### [2024-04-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5zdXBwb3J0L3N1cHBvcnR0aWNrZXRzL3t9L2NvbW11bmljYXRpb25zL3t9/2024-04-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.support/supporttickets/{}/communications/{} 2024-04-01 -->
17 changes: 17 additions & 0 deletions Commands/support/in-subscription/communication/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# [Group] _support in-subscription communication_

Manage support ticket communications

## Commands

- [create](/Commands/support/in-subscription/communication/_create.md)
: Adds a new customer communication to an Azure support ticket.

- [list](/Commands/support/in-subscription/communication/_list.md)
: List all communications (attachments not included) for a support ticket. <br/></br> You can also filter support ticket communications by _CreatedDate_ or _CommunicationType_ using the $filter parameter. The only type of communication supported today is _Web_. Output will be a paged result with _nextLink_, using which you can retrieve the next set of Communication results. <br/><br/>Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.

- [show](/Commands/support/in-subscription/communication/_show.md)
: Get communication details for a support ticket.

- [update](/Commands/support/in-subscription/communication/_update.md)
: Update a new customer communication to an Azure support ticket.
21 changes: 21 additions & 0 deletions Commands/support/in-subscription/file-workspace/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# [Command] _support in-subscription file-workspace create_

Create a new file workspace for the specified subscription.

## Versions

### [2024-04-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5zdXBwb3J0L2ZpbGV3b3Jrc3BhY2VzL3t9/2024-04-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.support/fileworkspaces/{} 2024-04-01 -->

#### examples

- Create a file workspace for a specified subscription (different from the account subscription)
```bash
support in-subscription file-workspace create --file-workspace-name "TestWorkspaceName" --subscription "TestSubscription"
```

- Create a file workspace for a specified subscription (same as the account subscription)
```bash
support in-subscription file-workspace create --file-workspace-name "TestWorkspaceName"
```
21 changes: 21 additions & 0 deletions Commands/support/in-subscription/file-workspace/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# [Command] _support in-subscription file-workspace show_

Get details for a specific file workspace in an Azure subscription.

## Versions

### [2024-04-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5zdXBwb3J0L2ZpbGV3b3Jrc3BhY2VzL3t9/2024-04-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.support/fileworkspaces/{} 2024-04-01 -->

#### examples

- Show a file workspace for a specified subscription (different from the account subscription)
```bash
support in-subscription file-workspace show --file-workspace-name "TestWorkspaceName" --subscription "TestSubscription"
```

- Show a file workspace for a specified subscription (same as the account subscription)
```bash
support in-subscription file-workspace show --file-workspace-name "TestWorkspaceName"
```
11 changes: 11 additions & 0 deletions Commands/support/in-subscription/file-workspace/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# [Group] _support in-subscription file-workspace_

File workspaces for Azure Support for the specified subscription.

## Commands

- [create](/Commands/support/in-subscription/file-workspace/_create.md)
: Create a new file workspace for the specified subscription.

- [show](/Commands/support/in-subscription/file-workspace/_show.md)
: Get details for a specific file workspace in an Azure subscription.
9 changes: 9 additions & 0 deletions Commands/support/in-subscription/file/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# [Command] _support in-subscription file create_

Create a new file under a workspace for the specified subscription.

## Versions

### [2024-04-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5zdXBwb3J0L2ZpbGV3b3Jrc3BhY2VzL3t9L2ZpbGVzL3t9/2024-04-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.support/fileworkspaces/{}/files/{} 2024-04-01 -->
21 changes: 21 additions & 0 deletions Commands/support/in-subscription/file/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# [Command] _support in-subscription file list_

List all the Files information under a workspace for an Azure subscription.

## Versions

### [2024-04-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5zdXBwb3J0L2ZpbGV3b3Jrc3BhY2VzL3t9L2ZpbGVz/2024-04-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.support/fileworkspaces/{}/files 2024-04-01 -->

#### examples

- List all the files within a file-workspace for a specified subscription (different from the account subscription)
```bash
support in-subscription file list --file-workspace-name "TestFileWorkspaceName" --subscription "TestSubscription"
```

- List all the files within a file-workspace for a specified subscription (same as the account subscription)
```bash
support in-subscription file list --file-workspace-name "TestFileWorkspaceName"
```
21 changes: 21 additions & 0 deletions Commands/support/in-subscription/file/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# [Command] _support in-subscription file show_

Get details of a specific file in a work space.

## Versions

### [2024-04-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5zdXBwb3J0L2ZpbGV3b3Jrc3BhY2VzL3t9L2ZpbGVzL3t9/2024-04-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.support/fileworkspaces/{}/files/{} 2024-04-01 -->

#### examples

- Show a file within a file-workspace for a specified subscription (different from the account subscription)
```bash
support in-subscription file show --subscription "TestSubscription" --file-workspace-name "TestWorkspaceName" --file-name "FileName"
```

- Show a file within a file-workspace for a specified subscription (same as the account subscription)
```bash
support in-subscription file show --file-workspace-name "TestWorkspaceName" --file-name "FileName"
```
9 changes: 9 additions & 0 deletions Commands/support/in-subscription/file/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# [Command] _support in-subscription file update_

Update a new file under a workspace for the specified subscription.

## Versions

### [2024-04-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5zdXBwb3J0L2ZpbGV3b3Jrc3BhY2VzL3t9L2ZpbGVzL3t9/2024-04-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.support/fileworkspaces/{}/files/{} 2024-04-01 -->
9 changes: 9 additions & 0 deletions Commands/support/in-subscription/file/_upload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# [Command] _support in-subscription file upload_

This API allows you to upload content to a file

## Versions

### [2024-04-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5zdXBwb3J0L2ZpbGV3b3Jrc3BhY2VzL3t9L2ZpbGVzL3t9L3VwbG9hZA==/2024-04-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.support/fileworkspaces/{}/files/{}/upload 2024-04-01 -->
20 changes: 20 additions & 0 deletions Commands/support/in-subscription/file/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# [Group] _support in-subscription file_

File operations for a specified subscription

## Commands

- [create](/Commands/support/in-subscription/file/_create.md)
: Create a new file under a workspace for the specified subscription.

- [list](/Commands/support/in-subscription/file/_list.md)
: List all the Files information under a workspace for an Azure subscription.

- [show](/Commands/support/in-subscription/file/_show.md)
: Get details of a specific file in a work space.

- [update](/Commands/support/in-subscription/file/_update.md)
: Update a new file under a workspace for the specified subscription.

- [upload](/Commands/support/in-subscription/file/_upload.md)
: This API allows you to upload content to a file
25 changes: 25 additions & 0 deletions Commands/support/in-subscription/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# [Group] _support in-subscription_

Manage Azure support resource within the selected subscription.

## Subgroups

- [chat-transcript](/Commands/support/in-subscription/chat-transcript/readme.md)
: Manage support ticket chat transcript

- [communication](/Commands/support/in-subscription/communication/readme.md)
: Manage support ticket communications

- [file](/Commands/support/in-subscription/file/readme.md)
: File operations for a specified subscription

- [file-workspace](/Commands/support/in-subscription/file-workspace/readme.md)
: File workspaces for Azure Support for the specified subscription.

- [tickets](/Commands/support/in-subscription/tickets/readme.md)
: Create and manage Azure support ticket with a subscription.

## Commands

- [check-name-availability](/Commands/support/in-subscription/_check-name-availability.md)
: Check the availability of a resource name. This API should be used to check the uniqueness of the resource name for the selected subscription.
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# [Command] _support in-subscription tickets check-name-availability_

Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication or file workspace to the support ticket.

## Versions

### [2024-04-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5zdXBwb3J0L3N1cHBvcnR0aWNrZXRzL3t9L2NoZWNrbmFtZWF2YWlsYWJpbGl0eQ==/2024-04-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.support/supporttickets/{}/checknameavailability 2024-04-01 -->
Loading
Loading