From 4f2e4bc790a1b4d71c926b02064107595731ad90 Mon Sep 17 00:00:00 2001 From: "Grace Huang (from Dev Box)" Date: Mon, 11 Mar 2024 13:34:34 -0400 Subject: [PATCH 1/3] update documentation and readme --- src/Support/Support.Autorest/README.md | 45 ++++++++++++-- .../docs/Get-AzSupportChatTranscript.md | 9 ++- ...-AzSupportChatTranscriptsNoSubscription.md | 62 +++++++++++++++---- .../docs/Get-AzSupportCommunication.md | 13 ++-- ...t-AzSupportCommunicationsNoSubscription.md | 31 +++++++--- .../docs/Get-AzSupportOperation.md | 2 +- .../Get-AzSupportProblemClassification.md | 10 +-- .../docs/Get-AzSupportTicket.md | 13 ++-- .../Get-AzSupportTicketsNoSubscription.md | 22 +++---- ...w-AzSupportCommunicationsNoSubscription.md | 31 +++++----- .../New-AzSupportTicketsNoSubscription.md | 2 +- .../Update-AzSupportTicketsNoSubscription.md | 62 ++++++++++++++----- .../examples/Get-AzSupportChatTranscript.md | 9 ++- ...-AzSupportChatTranscriptsNoSubscription.md | 56 ++++++++++++++--- .../examples/Get-AzSupportCommunication.md | 13 ++-- ...t-AzSupportCommunicationsNoSubscription.md | 29 ++++++--- .../examples/Get-AzSupportOperation.md | 2 +- .../Get-AzSupportProblemClassification.md | 10 +-- .../examples/Get-AzSupportTicket.md | 13 ++-- .../Get-AzSupportTicketsNoSubscription.md | 20 +++--- ...w-AzSupportCommunicationsNoSubscription.md | 28 ++++----- .../Update-AzSupportTicketsNoSubscription.md | 60 +++++++++++++----- 22 files changed, 359 insertions(+), 183 deletions(-) diff --git a/src/Support/Support.Autorest/README.md b/src/Support/Support.Autorest/README.md index 745ca6ec2037..d6a7b8491a39 100644 --- a/src/Support/Support.Autorest/README.md +++ b/src/Support/Support.Autorest/README.md @@ -79,10 +79,47 @@ directive: - FileSize - NumberOfChunks - where: - subject: UploadFile - parameter-name: FileWorkspaceName + model-name: SupportTicketDetails set: - alias: WorkspaceName + format-table: + properties: + - Name + - Title + - SupportTicketId + - Severity + - ServiceDisplayName + - CreatedDate + - where: + model-name: CommunicationDetails + set: + format-table: + properties: + - Name + - Sender + - Subject + - CreatedDate + - where: + model-name: ChatTranscriptDetails + set: + format-table: + properties: + - Name + - StartTime + - where: + subject: CommunicationsNoSubscription + parameter-name: CommunicationName + set: + alias: Name + - where: + subject: SupportTicketsNoSubscription + parameter-name: SupportTicketName + set: + alias: Name + - where: + subject: ChatTranscriptsNoSubscription + parameter-name: ChatTranscriptName + set: + alias: Name - where: subject: UploadFilesNoSubscription parameter-name: FileWorkspaceName @@ -158,7 +195,7 @@ directive: - from: GetAzSupportCommunication_List.cs where: $ transform: $ = $.replace("!String.IsNullOrEmpty(_nextLink)" ,"!String.IsNullOrEmpty(_nextLink) && this._top <= 0"); - - from: GetAzSupportTicketCommunicationsNoSubscription_List.cs + - from: GetAzSupportCommunicationsNoSubscription_List.cs where: $ transform: $ = $.replace("!String.IsNullOrEmpty(_nextLink)" ,"!String.IsNullOrEmpty(_nextLink) && this._top <= 0"); # Following are common directives which are normally required in all the RPs diff --git a/src/Support/Support.Autorest/docs/Get-AzSupportChatTranscript.md b/src/Support/Support.Autorest/docs/Get-AzSupportChatTranscript.md index 79a47a476b10..096ae0e5d461 100644 --- a/src/Support/Support.Autorest/docs/Get-AzSupportChatTranscript.md +++ b/src/Support/Support.Autorest/docs/Get-AzSupportChatTranscript.md @@ -46,11 +46,10 @@ Returns chatTranscript details for a support ticket under a subscription. ``` ```output -Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModi - fiedAt ----- ------------------- ------------------- ----------------------- ------------------ -595df7b4-167f-4f3e-8292-f0ba2b8a53f9 -f8b45cd6-a8ec-40e2-b846-a28b848553cf +Name StartTime +---- --------- +595df7b4-167f-4f3e-8292-f0ba2b8a53f9 8/11/2023 7:27:49 PM +f8b45cd6-a8ec-40e2-b846-a28b848553cf 8/11/2023 7:52:44 PM ``` Lists all chat transcripts for a support ticket under subscription diff --git a/src/Support/Support.Autorest/docs/Get-AzSupportChatTranscriptsNoSubscription.md b/src/Support/Support.Autorest/docs/Get-AzSupportChatTranscriptsNoSubscription.md index 3e1cb5b11092..0aacae0e85d1 100644 --- a/src/Support/Support.Autorest/docs/Get-AzSupportChatTranscriptsNoSubscription.md +++ b/src/Support/Support.Autorest/docs/Get-AzSupportChatTranscriptsNoSubscription.md @@ -41,27 +41,67 @@ Returns chatTranscript details for a no subscription support ticket. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: List chat transcripts under a no subscription support ticket ```powershell -{{ Add code here }} +Get-AzSupportChatTranscriptsNoSubscription -SupportTicketName test12345 ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name StartTime +---- --------- +595df7b4-167f-4f3e-8292-f0ba2b8a53f9 8/11/2023 7:27:49 PM +f8b45cd6-a8ec-40e2-b846-a28b848553cf 8/11/2023 7:52:44 PM ``` -{{ Add description here }} +List chat transcripts under a no subscription support ticket -### Example 2: {{ Add title here }} +### Example 2: Get details of a chat transcript under a no subscription support ticket ```powershell -{{ Add code here }} +Get-AzSupportChatTranscriptsNoSubscription -SupportTicketName test12345 -Name 595df7b4-167f-4f3e-8292-f0ba2b8a53f9 ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} +Id : /providers/Microsoft.Support/supportT + ickets/58cf91d7-bedfb285-617ecf73-d627-4bfd-9298-5950da2170b7/chatTranscripts/595df7b4-1 + 67f-4f3e-8292-f0ba2b8a53f9 +Message : {{ + "contentType": "text", + "communicationDirection": "Inbound", + "sender": "", + "body": "Hey", + "createdDate": "2023-08-11T19:19:33.0000000Z" + }, { + "contentType": "text", + "communicationDirection": "Outbound", + "sender": "Aditi Takle", + "body": "hi", + "createdDate": "2023-08-11T19:19:38.0000000Z" + }, { + "contentType": "text", + "communicationDirection": "Outbound", + "sender": "Damian Spoltore", + "body": "hi Aditi, I\u0027m Damian", + "createdDate": "2023-08-11T19:24:19.0000000Z" + }, { + "contentType": "text", + "communicationDirection": "Outbound", + "sender": "Damian Spoltore", + "body": "I was entering to test", + "createdDate": "2023-08-11T19:24:24.0000000Z" + }} +Name : 595df7b4-167f-4f3e-8292-f0ba2b8a53f9 +ResourceGroupName : +StartTime : 8/11/2023 7:27:49 PM +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Support/chatTranscripts +``` + +Get details of a chat transcript under a no subscription support ticket ## PARAMETERS @@ -71,7 +111,7 @@ ChatTranscript name. ```yaml Type: System.String Parameter Sets: Get, GetViaIdentitySupportTicket -Aliases: +Aliases: Name Required: True Position: Named diff --git a/src/Support/Support.Autorest/docs/Get-AzSupportCommunication.md b/src/Support/Support.Autorest/docs/Get-AzSupportCommunication.md index 1ab8b7885f65..125b9d0d8f5d 100644 --- a/src/Support/Support.Autorest/docs/Get-AzSupportCommunication.md +++ b/src/Support/Support.Autorest/docs/Get-AzSupportCommunication.md @@ -46,15 +46,10 @@ Returns communication details for a support ticket. ``` ```output -Name ResourceGroupName ----- ----------------- -9079281d-0fcc-ee11-9079-6045bdef78de -test123 -9ffd523a-5acb-ee11-9079-6045bdef7a0a -590629b9-44cb-ee11-9079-6045bdef700d -8a03e5d5-8eca-ee11-9079-6045bdeb5f9a -14696079-8eca-ee11-9079-6045bdeb5f9a -e0d2b429-7bca-ee11-907a-0022482a4908 +Name Sender Subject CreatedDate +---- ------ ------- ----------- +590629b9-44cb-ee11-9079-6045bdef700d support@mail.support.microsoft.com test - TrackingID#2403080040012292 3/9/2024 2:21:58 AM +ee25b14e-8fdd-ee11-904d-0022482a4908 support@mail.support.microsoft.com … 3/8/2024 9:03:35 PM ``` Lists all communications (attachments not included) for a support ticket. diff --git a/src/Support/Support.Autorest/docs/Get-AzSupportCommunicationsNoSubscription.md b/src/Support/Support.Autorest/docs/Get-AzSupportCommunicationsNoSubscription.md index aec070226d3a..dce16d82dd0e 100644 --- a/src/Support/Support.Autorest/docs/Get-AzSupportCommunicationsNoSubscription.md +++ b/src/Support/Support.Autorest/docs/Get-AzSupportCommunicationsNoSubscription.md @@ -41,27 +41,40 @@ Returns communication details for a support ticket. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: List all communications under a no subscription support ticket ```powershell -{{ Add code here }} +Get-AzSupportCommunicationsNoSubscription -SupportTicketName test1234 ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name Sender Subject CreatedDate +---- ------ ------- ----------- +testCommunication1 sender@sender.com this is a test subject - TrackingID#2403070040015890 3/11/2024 3:46:43 PM +testCommunication2 sender@sender.com this is a test subject - TrackingID#2403070040015890 3/11/2024 3:46:43 PM ``` -{{ Add description here }} +List all communications under a no subscription support ticket -### Example 2: {{ Add title here }} +### Example 2: Get a communication under a no subscription support ticket ```powershell -{{ Add code here }} +Get-AzSupportCommunicationsNoSubscription -SupportTicketName test1234 -Name testCommunication1 + ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Body : 
this is a test body
+CommunicationDirection : Inbound +CommunicationType : Web +CreatedDate : 3/7/2024 11:53:33 PM +Id : /providers/Microsoft.Support/supportTickets/test1234/communications/testCommunication1 +Name : testCommunication +ResourceGroupName : +Sender : sender@sender.com +Subject : this is a test subject - TrackingID#2403070040015890 +Type : Microsoft.Support/communications ``` -{{ Add description here }} +Get a communication under a no subscription support ticket ## PARAMETERS @@ -71,7 +84,7 @@ Communication name. ```yaml Type: System.String Parameter Sets: Get, GetViaIdentitySupportTicket -Aliases: +Aliases: Name Required: True Position: Named diff --git a/src/Support/Support.Autorest/docs/Get-AzSupportOperation.md b/src/Support/Support.Autorest/docs/Get-AzSupportOperation.md index cd0e6a9d6cea..4d7ab0b55c4d 100644 --- a/src/Support/Support.Autorest/docs/Get-AzSupportOperation.md +++ b/src/Support/Support.Autorest/docs/Get-AzSupportOperation.md @@ -21,7 +21,7 @@ Lists all the available Microsoft Support REST API operations. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: List Azure Support operations ```powershell Get-AzSupportOperation ``` diff --git a/src/Support/Support.Autorest/docs/Get-AzSupportProblemClassification.md b/src/Support/Support.Autorest/docs/Get-AzSupportProblemClassification.md index eb59b6c0ac20..7590512f4334 100644 --- a/src/Support/Support.Autorest/docs/Get-AzSupportProblemClassification.md +++ b/src/Support/Support.Autorest/docs/Get-AzSupportProblemClassification.md @@ -46,11 +46,11 @@ Get-AzSupportProblemClassification -ServiceName "6f16735c-b0ae-b275-ad3a-03479cf ``` ```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 +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 ``` Lists all the problem classifications (categories) available for a specific Azure service. diff --git a/src/Support/Support.Autorest/docs/Get-AzSupportTicket.md b/src/Support/Support.Autorest/docs/Get-AzSupportTicket.md index 8f256163dda3..c05ac4e7201c 100644 --- a/src/Support/Support.Autorest/docs/Get-AzSupportTicket.md +++ b/src/Support/Support.Autorest/docs/Get-AzSupportTicket.md @@ -40,17 +40,14 @@ If a ticket was created more than 18 months ago, a request for data might cause ### Example 1: Get list of support tickets at subscription level ```powershell - Get-AzSupportTicket -Filter "CreatedDate ge 2024-02-21" + Get-AzSupportTicket ``` ```output -Name ResourceGroupName ----- ----------------- -test1-5dda17d0-a60d-4f4c-82e3-0fe3604c0ed4 -test-5dda17d0-a60d-4f4c-82e3-0fe3604c0ed4 -test1-8fd280ac-966b-41da-b6f5-ad630c784feb -test-8fd280ac-966b-41da-b6f5-ad630c784feb -test1-a31f113b-8f99-4a8d-8016-33aec8165a20 +Name Title SupportTicketId Severity ServiceDisplayName CreatedDate +---- ----- --------------- -------- ------------------ ----------- +517f2da6-9bc71cda-278fc71b-7b86-4289-baec-922e8be1a04a test 2403080040012292 Minimal Billing 3/8/2024 9:03:26 PM +test1-5dda17d0-a60d-4f4c-82e3-0fe3604c0ed4 test ticket - please ignore and close 2403060040007460 Minimal Billing 3/6/2024 3:09:28 PM Lists all the support tickets for an Azure subscription diff --git a/src/Support/Support.Autorest/docs/Get-AzSupportTicketsNoSubscription.md b/src/Support/Support.Autorest/docs/Get-AzSupportTicketsNoSubscription.md index 7d67d34a5635..e7a79b91af8a 100644 --- a/src/Support/Support.Autorest/docs/Get-AzSupportTicketsNoSubscription.md +++ b/src/Support/Support.Autorest/docs/Get-AzSupportTicketsNoSubscription.md @@ -45,17 +45,13 @@ If a ticket was created more than 18 months ago, a request for data might cause ``` ```output -Name ResourceGroupName ----- ----------------- -test1-5dda17d0-a60d-4f4c-82e3-0fe3604c0ed4 -test-5dda17d0-a60d-4f4c-82e3-0fe3604c0ed4 -test1-8fd280ac-966b-41da-b6f5-ad630c784feb -test-8fd280ac-966b-41da-b6f5-ad630c784feb -test1-a31f113b-8f99-4a8d-8016-33aec8165a20 -test-a31f113b-8f99-4a8d-8016-33aec8165a20 -test1-9fbdfed4-20e5-47ee-b36e-455ca16bb46b -test-9fbdfed4-20e5-47ee-b36e-455ca16bb46b -test-1c0ad9a1-f2fb-44a7-b776-7400e0b286a8 +Name Title SupportTicketId Severity ServiceDisplayName CreatedDate +---- ----- --------------- -------- ------------------ ----------- +2403110040009092 test ticket please ignore and close 2403110040009092 Minimal Billing 3/11/2024 3:46:20 PM +test-41b4ec72-8634-4e03-978e-15bde625be00 test ticket - please ignore and close 2403070040010395 Minimal Billing 3/7/2024 5:35:55 PM +test-270a8ba4-7083-4b02-8b32-b5c2cdc55e78 test ticket - please ignore and close 2403070040010346 Minimal Billing 3/7/2024 5:32:40 PM +test-8dad4b97-5ff5-4a1e-bb6e-d323348db3f2 test ticket - please ignore and close 2403070040009816 Minimal Billing 3/7/2024 5:04:36 PM +test-0d8ee1f2-89d6-4078-8c1a-5845673966a1 test ticket - please ignore and close 2403070040009769 Minimal Billing 3/7/2024 5:02:44 PM ``` Lists all the support tickets. @@ -113,7 +109,7 @@ Title : test ticket - please ignore and clo Type : Microsoft.Support/supportTickets ``` -Lists all the support tickets +Gets details of a support ticket ## PARAMETERS @@ -174,7 +170,7 @@ Support ticket name. ```yaml Type: System.String Parameter Sets: Get -Aliases: +Aliases: Name Required: True Position: Named diff --git a/src/Support/Support.Autorest/docs/New-AzSupportCommunicationsNoSubscription.md b/src/Support/Support.Autorest/docs/New-AzSupportCommunicationsNoSubscription.md index 7a33f27c510a..5dd7edf95af4 100644 --- a/src/Support/Support.Autorest/docs/New-AzSupportCommunicationsNoSubscription.md +++ b/src/Support/Support.Autorest/docs/New-AzSupportCommunicationsNoSubscription.md @@ -23,27 +23,26 @@ Adds a new customer communication to an Azure support ticket. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: Create a new communication under a no subscription ticket ```powershell -{{ Add code here }} +New-AzSupportCommunicationsNoSubscription -SupportTicketName test1234 -Name testCommunication2 -Subject test -Body test ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Body : 
test
+CommunicationDirection : Inbound +CommunicationType : Web +CreatedDate : 3/11/2024 2:21:32 PM +Id : /providers/Microsoft.Support/supportTickets/test-7d6ad184-eb1d-40b1-ae43-5b4312b702d4/communications/33445ea3-b + 2df-ee11-904d-00224835ac0b +Name : 33445ea3-b2df-ee11-904d-00224835ac0b +ResourceGroupName : +Sender : bhshah@TestTest06172019GBL.onmicrosoft.com +Subject : test - TrackingID#2403070040015890 +Type : Microsoft.Support/communications ``` -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} +Create a new communication under a no subscription ticket ## PARAMETERS @@ -83,7 +82,7 @@ Communication name. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Name Required: True Position: Named diff --git a/src/Support/Support.Autorest/docs/New-AzSupportTicketsNoSubscription.md b/src/Support/Support.Autorest/docs/New-AzSupportTicketsNoSubscription.md index 06679b9f92c0..7c0747a5a6e9 100644 --- a/src/Support/Support.Autorest/docs/New-AzSupportTicketsNoSubscription.md +++ b/src/Support/Support.Autorest/docs/New-AzSupportTicketsNoSubscription.md @@ -517,7 +517,7 @@ Support ticket name. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Name Required: True Position: Named diff --git a/src/Support/Support.Autorest/docs/Update-AzSupportTicketsNoSubscription.md b/src/Support/Support.Autorest/docs/Update-AzSupportTicketsNoSubscription.md index a3b84a3cdeb9..f90e140d4989 100644 --- a/src/Support/Support.Autorest/docs/Update-AzSupportTicketsNoSubscription.md +++ b/src/Support/Support.Autorest/docs/Update-AzSupportTicketsNoSubscription.md @@ -41,27 +41,57 @@ In such a case, contact your support engineer to request severity update by addi ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: Update a support ticket at no subscription level ```powershell -{{ Add code here }} +Update-AzSupportTicketsNoSubscription -Name test12345 -AdvancedDiagnosticConsent Yes ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +AdvancedDiagnosticConsent : Yes +ContactDetailAdditionalEmailAddress : +ContactDetailCountry : USA +ContactDetailFirstName : test +ContactDetailLastName : test +ContactDetailPhoneNumber : +ContactDetailPreferredContactMethod : Email +ContactDetailPreferredSupportLanguage : en-US +ContactDetailPreferredTimeZone : Pacific Standard Time +ContactDetailPrimaryEmailAddress : test@test.com +CreatedDate : 3/7/2024 5:35:55 PM +Description : test ticket - please ignore and close +EnrollmentId : +FileWorkspaceName : 2403070040010395 +Id : /providers/Microsoft.Support/supportTickets/test12345 +ModifiedDate : 3/7/2024 6:12:56 PM +Name : test12345 +ProblemClassificationDisplayName : Add or update VAT, tax id, PO number or profile information +ProblemClassificationId : /providers/Microsoft.Support/services/517f2da6-78fd-0498-4e22-ad26996b1dfc/problemClassifications/3ec1a070-f242-9ecf-5a7c-e1a88ce029ef +ProblemScopingQuestion : +ProblemStartTime : +QuotaTicketDetailQuotaChangeRequest : +QuotaTicketDetailQuotaChangeRequestSubType : +QuotaTicketDetailQuotaChangeRequestVersion : +Require24X7Response : False +ResourceGroupName : +SecondaryConsent : +ServiceDisplayName : Billing +ServiceId : /providers/Microsoft.Support/services/517f2da6-78fd-0498-4e22-ad26996b1dfc +ServiceLevelAgreementExpirationTime : 3/8/2024 1:35:55 AM +ServiceLevelAgreementSlaMinute : 480 +ServiceLevelAgreementStartTime : 3/7/2024 5:35:55 PM +Severity : Minimal +Status : Open +SupportEngineerEmailAddress : test@microsoft.com +SupportPlanDisplayName : Basic support +SupportPlanId : U291cmNlOkZyZWUsRnJlZUlkOjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwOSw= +SupportPlanType : Basic +SupportTicketId : 2403070040010395 +TechnicalTicketDetailResourceId : +Title : test ticket - please ignore and close +Type : Microsoft.Support/supportTickets ``` -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} +Update a tenant-level support ticket ## PARAMETERS @@ -306,7 +336,7 @@ Support ticket name. ```yaml Type: System.String Parameter Sets: UpdateExpanded -Aliases: +Aliases: Name Required: True Position: Named diff --git a/src/Support/Support.Autorest/examples/Get-AzSupportChatTranscript.md b/src/Support/Support.Autorest/examples/Get-AzSupportChatTranscript.md index e4b82630d790..709c5d4fea79 100644 --- a/src/Support/Support.Autorest/examples/Get-AzSupportChatTranscript.md +++ b/src/Support/Support.Autorest/examples/Get-AzSupportChatTranscript.md @@ -4,11 +4,10 @@ ``` ```output -Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModi - fiedAt ----- ------------------- ------------------- ----------------------- ------------------ -595df7b4-167f-4f3e-8292-f0ba2b8a53f9 -f8b45cd6-a8ec-40e2-b846-a28b848553cf +Name StartTime +---- --------- +595df7b4-167f-4f3e-8292-f0ba2b8a53f9 8/11/2023 7:27:49 PM +f8b45cd6-a8ec-40e2-b846-a28b848553cf 8/11/2023 7:52:44 PM ``` Lists all chat transcripts for a support ticket under subscription diff --git a/src/Support/Support.Autorest/examples/Get-AzSupportChatTranscriptsNoSubscription.md b/src/Support/Support.Autorest/examples/Get-AzSupportChatTranscriptsNoSubscription.md index 0371f56c36d2..3e82690b8cb3 100644 --- a/src/Support/Support.Autorest/examples/Get-AzSupportChatTranscriptsNoSubscription.md +++ b/src/Support/Support.Autorest/examples/Get-AzSupportChatTranscriptsNoSubscription.md @@ -1,22 +1,62 @@ -### Example 1: {{ Add title here }} +### Example 1: List chat transcripts under a no subscription support ticket ```powershell -{{ Add code here }} +Get-AzSupportChatTranscriptsNoSubscription -SupportTicketName test12345 ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name StartTime +---- --------- +595df7b4-167f-4f3e-8292-f0ba2b8a53f9 8/11/2023 7:27:49 PM +f8b45cd6-a8ec-40e2-b846-a28b848553cf 8/11/2023 7:52:44 PM ``` -{{ Add description here }} +List chat transcripts under a no subscription support ticket -### Example 2: {{ Add title here }} +### Example 2: Get details of a chat transcript under a no subscription support ticket ```powershell -{{ Add code here }} +Get-AzSupportChatTranscriptsNoSubscription -SupportTicketName test12345 -Name 595df7b4-167f-4f3e-8292-f0ba2b8a53f9 ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Id : /providers/Microsoft.Support/supportT + ickets/58cf91d7-bedfb285-617ecf73-d627-4bfd-9298-5950da2170b7/chatTranscripts/595df7b4-1 + 67f-4f3e-8292-f0ba2b8a53f9 +Message : {{ + "contentType": "text", + "communicationDirection": "Inbound", + "sender": "", + "body": "Hey", + "createdDate": "2023-08-11T19:19:33.0000000Z" + }, { + "contentType": "text", + "communicationDirection": "Outbound", + "sender": "Aditi Takle", + "body": "hi", + "createdDate": "2023-08-11T19:19:38.0000000Z" + }, { + "contentType": "text", + "communicationDirection": "Outbound", + "sender": "Damian Spoltore", + "body": "hi Aditi, I\u0027m Damian", + "createdDate": "2023-08-11T19:24:19.0000000Z" + }, { + "contentType": "text", + "communicationDirection": "Outbound", + "sender": "Damian Spoltore", + "body": "I was entering to test", + "createdDate": "2023-08-11T19:24:24.0000000Z" + }} +Name : 595df7b4-167f-4f3e-8292-f0ba2b8a53f9 +ResourceGroupName : +StartTime : 8/11/2023 7:27:49 PM +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Support/chatTranscripts ``` -{{ Add description here }} +Get details of a chat transcript under a no subscription support ticket diff --git a/src/Support/Support.Autorest/examples/Get-AzSupportCommunication.md b/src/Support/Support.Autorest/examples/Get-AzSupportCommunication.md index faaf899e3fd0..b74438782e44 100644 --- a/src/Support/Support.Autorest/examples/Get-AzSupportCommunication.md +++ b/src/Support/Support.Autorest/examples/Get-AzSupportCommunication.md @@ -4,15 +4,10 @@ ``` ```output -Name ResourceGroupName ----- ----------------- -9079281d-0fcc-ee11-9079-6045bdef78de -test123 -9ffd523a-5acb-ee11-9079-6045bdef7a0a -590629b9-44cb-ee11-9079-6045bdef700d -8a03e5d5-8eca-ee11-9079-6045bdeb5f9a -14696079-8eca-ee11-9079-6045bdeb5f9a -e0d2b429-7bca-ee11-907a-0022482a4908 +Name Sender Subject CreatedDate +---- ------ ------- ----------- +590629b9-44cb-ee11-9079-6045bdef700d support@mail.support.microsoft.com test - TrackingID#2403080040012292 3/9/2024 2:21:58 AM +ee25b14e-8fdd-ee11-904d-0022482a4908 support@mail.support.microsoft.com … 3/8/2024 9:03:35 PM ``` Lists all communications (attachments not included) for a support ticket. diff --git a/src/Support/Support.Autorest/examples/Get-AzSupportCommunicationsNoSubscription.md b/src/Support/Support.Autorest/examples/Get-AzSupportCommunicationsNoSubscription.md index 0371f56c36d2..497158ca5ae9 100644 --- a/src/Support/Support.Autorest/examples/Get-AzSupportCommunicationsNoSubscription.md +++ b/src/Support/Support.Autorest/examples/Get-AzSupportCommunicationsNoSubscription.md @@ -1,22 +1,35 @@ -### Example 1: {{ Add title here }} +### Example 1: List all communications under a no subscription support ticket ```powershell -{{ Add code here }} +Get-AzSupportCommunicationsNoSubscription -SupportTicketName test1234 ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name Sender Subject CreatedDate +---- ------ ------- ----------- +testCommunication1 sender@sender.com this is a test subject - TrackingID#2403070040015890 3/11/2024 3:46:43 PM +testCommunication2 sender@sender.com this is a test subject - TrackingID#2403070040015890 3/11/2024 3:46:43 PM ``` -{{ Add description here }} +List all communications under a no subscription support ticket -### Example 2: {{ Add title here }} +### Example 2: Get a communication under a no subscription support ticket ```powershell -{{ Add code here }} +Get-AzSupportCommunicationsNoSubscription -SupportTicketName test1234 -Name testCommunication1 + ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Body : 
this is a test body
+CommunicationDirection : Inbound +CommunicationType : Web +CreatedDate : 3/7/2024 11:53:33 PM +Id : /providers/Microsoft.Support/supportTickets/test1234/communications/testCommunication1 +Name : testCommunication +ResourceGroupName : +Sender : sender@sender.com +Subject : this is a test subject - TrackingID#2403070040015890 +Type : Microsoft.Support/communications ``` -{{ Add description here }} +Get a communication under a no subscription support ticket diff --git a/src/Support/Support.Autorest/examples/Get-AzSupportOperation.md b/src/Support/Support.Autorest/examples/Get-AzSupportOperation.md index ba39dfad7ff7..bd636d1ec66e 100644 --- a/src/Support/Support.Autorest/examples/Get-AzSupportOperation.md +++ b/src/Support/Support.Autorest/examples/Get-AzSupportOperation.md @@ -1,4 +1,4 @@ -### Example 1: {{ Add title here }} +### Example 1: List Azure Support operations ```powershell Get-AzSupportOperation ``` diff --git a/src/Support/Support.Autorest/examples/Get-AzSupportProblemClassification.md b/src/Support/Support.Autorest/examples/Get-AzSupportProblemClassification.md index 064cfb1f6f9d..6f6afd44a312 100644 --- a/src/Support/Support.Autorest/examples/Get-AzSupportProblemClassification.md +++ b/src/Support/Support.Autorest/examples/Get-AzSupportProblemClassification.md @@ -4,11 +4,11 @@ Get-AzSupportProblemClassification -ServiceName "6f16735c-b0ae-b275-ad3a-03479cf ``` ```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 +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 ``` 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. diff --git a/src/Support/Support.Autorest/examples/Get-AzSupportTicket.md b/src/Support/Support.Autorest/examples/Get-AzSupportTicket.md index e2b2f463cd0a..9de5e1e119d7 100644 --- a/src/Support/Support.Autorest/examples/Get-AzSupportTicket.md +++ b/src/Support/Support.Autorest/examples/Get-AzSupportTicket.md @@ -1,16 +1,13 @@ ### Example 1: Get list of support tickets at subscription level ```powershell - Get-AzSupportTicket -Filter "CreatedDate ge 2024-02-21" + Get-AzSupportTicket ``` ```output -Name ResourceGroupName ----- ----------------- -test1-5dda17d0-a60d-4f4c-82e3-0fe3604c0ed4 -test-5dda17d0-a60d-4f4c-82e3-0fe3604c0ed4 -test1-8fd280ac-966b-41da-b6f5-ad630c784feb -test-8fd280ac-966b-41da-b6f5-ad630c784feb -test1-a31f113b-8f99-4a8d-8016-33aec8165a20 +Name Title SupportTicketId Severity ServiceDisplayName CreatedDate +---- ----- --------------- -------- ------------------ ----------- +517f2da6-9bc71cda-278fc71b-7b86-4289-baec-922e8be1a04a test 2403080040012292 Minimal Billing 3/8/2024 9:03:26 PM +test1-5dda17d0-a60d-4f4c-82e3-0fe3604c0ed4 test ticket - please ignore and close 2403060040007460 Minimal Billing 3/6/2024 3:09:28 PM Lists all the support tickets for an Azure subscription diff --git a/src/Support/Support.Autorest/examples/Get-AzSupportTicketsNoSubscription.md b/src/Support/Support.Autorest/examples/Get-AzSupportTicketsNoSubscription.md index 85f056494714..3b5f18f44217 100644 --- a/src/Support/Support.Autorest/examples/Get-AzSupportTicketsNoSubscription.md +++ b/src/Support/Support.Autorest/examples/Get-AzSupportTicketsNoSubscription.md @@ -4,17 +4,13 @@ ``` ```output -Name ResourceGroupName ----- ----------------- -test1-5dda17d0-a60d-4f4c-82e3-0fe3604c0ed4 -test-5dda17d0-a60d-4f4c-82e3-0fe3604c0ed4 -test1-8fd280ac-966b-41da-b6f5-ad630c784feb -test-8fd280ac-966b-41da-b6f5-ad630c784feb -test1-a31f113b-8f99-4a8d-8016-33aec8165a20 -test-a31f113b-8f99-4a8d-8016-33aec8165a20 -test1-9fbdfed4-20e5-47ee-b36e-455ca16bb46b -test-9fbdfed4-20e5-47ee-b36e-455ca16bb46b -test-1c0ad9a1-f2fb-44a7-b776-7400e0b286a8 +Name Title SupportTicketId Severity ServiceDisplayName CreatedDate +---- ----- --------------- -------- ------------------ ----------- +2403110040009092 test ticket please ignore and close 2403110040009092 Minimal Billing 3/11/2024 3:46:20 PM +test-41b4ec72-8634-4e03-978e-15bde625be00 test ticket - please ignore and close 2403070040010395 Minimal Billing 3/7/2024 5:35:55 PM +test-270a8ba4-7083-4b02-8b32-b5c2cdc55e78 test ticket - please ignore and close 2403070040010346 Minimal Billing 3/7/2024 5:32:40 PM +test-8dad4b97-5ff5-4a1e-bb6e-d323348db3f2 test ticket - please ignore and close 2403070040009816 Minimal Billing 3/7/2024 5:04:36 PM +test-0d8ee1f2-89d6-4078-8c1a-5845673966a1 test ticket - please ignore and close 2403070040009769 Minimal Billing 3/7/2024 5:02:44 PM ``` Lists all the support tickets. @@ -72,4 +68,4 @@ Title : test ticket - please ignore and clo Type : Microsoft.Support/supportTickets ``` -Lists all the support tickets \ No newline at end of file +Gets details of a support ticket \ No newline at end of file diff --git a/src/Support/Support.Autorest/examples/New-AzSupportCommunicationsNoSubscription.md b/src/Support/Support.Autorest/examples/New-AzSupportCommunicationsNoSubscription.md index 0371f56c36d2..07354e67d4c9 100644 --- a/src/Support/Support.Autorest/examples/New-AzSupportCommunicationsNoSubscription.md +++ b/src/Support/Support.Autorest/examples/New-AzSupportCommunicationsNoSubscription.md @@ -1,22 +1,22 @@ -### Example 1: {{ Add title here }} +### Example 1: Create a new communication under a no subscription ticket ```powershell -{{ Add code here }} +New-AzSupportCommunicationsNoSubscription -SupportTicketName test1234 -Name testCommunication2 -Subject test -Body test ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Body : 
test
+CommunicationDirection : Inbound +CommunicationType : Web +CreatedDate : 3/11/2024 2:21:32 PM +Id : /providers/Microsoft.Support/supportTickets/test-7d6ad184-eb1d-40b1-ae43-5b4312b702d4/communications/33445ea3-b + 2df-ee11-904d-00224835ac0b +Name : 33445ea3-b2df-ee11-904d-00224835ac0b +ResourceGroupName : +Sender : bhshah@TestTest06172019GBL.onmicrosoft.com +Subject : test - TrackingID#2403070040015890 +Type : Microsoft.Support/communications ``` -{{ Add description here }} +Create a new communication under a no subscription ticket -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} diff --git a/src/Support/Support.Autorest/examples/Update-AzSupportTicketsNoSubscription.md b/src/Support/Support.Autorest/examples/Update-AzSupportTicketsNoSubscription.md index 0371f56c36d2..4b7d5c63c8a0 100644 --- a/src/Support/Support.Autorest/examples/Update-AzSupportTicketsNoSubscription.md +++ b/src/Support/Support.Autorest/examples/Update-AzSupportTicketsNoSubscription.md @@ -1,22 +1,52 @@ -### Example 1: {{ Add title here }} +### Example 1: Update a support ticket at no subscription level ```powershell -{{ Add code here }} +Update-AzSupportTicketsNoSubscription -Name test12345 -AdvancedDiagnosticConsent Yes ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +AdvancedDiagnosticConsent : Yes +ContactDetailAdditionalEmailAddress : +ContactDetailCountry : USA +ContactDetailFirstName : test +ContactDetailLastName : test +ContactDetailPhoneNumber : +ContactDetailPreferredContactMethod : Email +ContactDetailPreferredSupportLanguage : en-US +ContactDetailPreferredTimeZone : Pacific Standard Time +ContactDetailPrimaryEmailAddress : test@test.com +CreatedDate : 3/7/2024 5:35:55 PM +Description : test ticket - please ignore and close +EnrollmentId : +FileWorkspaceName : 2403070040010395 +Id : /providers/Microsoft.Support/supportTickets/test12345 +ModifiedDate : 3/7/2024 6:12:56 PM +Name : test12345 +ProblemClassificationDisplayName : Add or update VAT, tax id, PO number or profile information +ProblemClassificationId : /providers/Microsoft.Support/services/517f2da6-78fd-0498-4e22-ad26996b1dfc/problemClassifications/3ec1a070-f242-9ecf-5a7c-e1a88ce029ef +ProblemScopingQuestion : +ProblemStartTime : +QuotaTicketDetailQuotaChangeRequest : +QuotaTicketDetailQuotaChangeRequestSubType : +QuotaTicketDetailQuotaChangeRequestVersion : +Require24X7Response : False +ResourceGroupName : +SecondaryConsent : +ServiceDisplayName : Billing +ServiceId : /providers/Microsoft.Support/services/517f2da6-78fd-0498-4e22-ad26996b1dfc +ServiceLevelAgreementExpirationTime : 3/8/2024 1:35:55 AM +ServiceLevelAgreementSlaMinute : 480 +ServiceLevelAgreementStartTime : 3/7/2024 5:35:55 PM +Severity : Minimal +Status : Open +SupportEngineerEmailAddress : test@microsoft.com +SupportPlanDisplayName : Basic support +SupportPlanId : U291cmNlOkZyZWUsRnJlZUlkOjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwOSw= +SupportPlanType : Basic +SupportTicketId : 2403070040010395 +TechnicalTicketDetailResourceId : +Title : test ticket - please ignore and close +Type : Microsoft.Support/supportTickets ``` -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} +Update a tenant-level support ticket From 862ddd74c941c22ea8d75caf4a64803eacfc1ddb Mon Sep 17 00:00:00 2001 From: "Grace Huang (from Dev Box)" Date: Mon, 11 Mar 2024 13:44:36 -0400 Subject: [PATCH 2/3] add directive back in --- src/Support/Support.Autorest/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/Support/Support.Autorest/README.md b/src/Support/Support.Autorest/README.md index d6a7b8491a39..c2b23af0a4c2 100644 --- a/src/Support/Support.Autorest/README.md +++ b/src/Support/Support.Autorest/README.md @@ -120,6 +120,11 @@ directive: parameter-name: ChatTranscriptName set: alias: Name + - where: + subject: UploadFile + parameter-name: FileWorkspaceName + set: + alias: WorkspaceName - where: subject: UploadFilesNoSubscription parameter-name: FileWorkspaceName From 4600eba1eeece070f35f5b42a1b2ec4ce451a5a1 Mon Sep 17 00:00:00 2001 From: "Grace Huang (from Dev Box)" Date: Tue, 12 Mar 2024 12:58:59 -0400 Subject: [PATCH 3/3] make advanced diagnostic consent required --- src/Support/Support.Autorest/README.md | 5 +++++ .../Support.Autorest/docs/New-AzSupportTicket.md | 14 +++++++------- .../docs/New-AzSupportTicketsNoSubscription.md | 12 ++++++------ 3 files changed, 18 insertions(+), 13 deletions(-) diff --git a/src/Support/Support.Autorest/README.md b/src/Support/Support.Autorest/README.md index c2b23af0a4c2..d9ceb6228a61 100644 --- a/src/Support/Support.Autorest/README.md +++ b/src/Support/Support.Autorest/README.md @@ -183,6 +183,11 @@ directive: - from: swagger-document where: $.definitions.SupportTicketDetails transform: $.required = ['properties'] + # only needed for 2022 preview version, should be able to remove for GA + - from: swagger-document + where: $.definitions.SupportTicketDetailsProperties + transform: $.required = ['serviceId','title','description','problemClassificationId','severity','contactDetails', 'advancedDiagnosticConsent'] + - from: swagger-document where: $.paths["/providers/Microsoft.Support/supportTickets/{supportTicketName}/chatTranscripts"].get.operationId transform: >- diff --git a/src/Support/Support.Autorest/docs/New-AzSupportTicket.md b/src/Support/Support.Autorest/docs/New-AzSupportTicket.md index 5de64d50662e..8271fa8ee99b 100644 --- a/src/Support/Support.Autorest/docs/New-AzSupportTicket.md +++ b/src/Support/Support.Autorest/docs/New-AzSupportTicket.md @@ -19,12 +19,12 @@ The auxiliary token will be from the Cloud solution provider (CSP) partner tenan ## SYNTAX ``` -New-AzSupportTicket -Name -ContactDetailCountry -ContactDetailFirstName - -ContactDetailLastName -ContactDetailPreferredContactMethod - -ContactDetailPreferredSupportLanguage -ContactDetailPreferredTimeZone - -ContactDetailPrimaryEmailAddress -Description -ProblemClassificationId - -ServiceId -Severity -Title [-SubscriptionId ] - [-AdvancedDiagnosticConsent ] [-ContactDetailAdditionalEmailAddress ] +New-AzSupportTicket -Name -AdvancedDiagnosticConsent -ContactDetailCountry + -ContactDetailFirstName -ContactDetailLastName + -ContactDetailPreferredContactMethod -ContactDetailPreferredSupportLanguage + -ContactDetailPreferredTimeZone -ContactDetailPrimaryEmailAddress -Description + -ProblemClassificationId -ServiceId -Severity -Title + [-SubscriptionId ] [-ContactDetailAdditionalEmailAddress ] [-ContactDetailPhoneNumber ] [-FileWorkspaceName ] [-ProblemScopingQuestion ] [-ProblemStartTime ] [-QuotaTicketDetailQuotaChangeRequest ] [-QuotaTicketDetailQuotaChangeRequestSubType ] [-QuotaTicketDetailQuotaChangeRequestVersion ] @@ -109,7 +109,7 @@ Type: System.String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False diff --git a/src/Support/Support.Autorest/docs/New-AzSupportTicketsNoSubscription.md b/src/Support/Support.Autorest/docs/New-AzSupportTicketsNoSubscription.md index 7c0747a5a6e9..e02d6256f318 100644 --- a/src/Support/Support.Autorest/docs/New-AzSupportTicketsNoSubscription.md +++ b/src/Support/Support.Autorest/docs/New-AzSupportTicketsNoSubscription.md @@ -16,14 +16,14 @@ The Azure support engineer working on your ticket will reach out to you for cons ## SYNTAX ``` -New-AzSupportTicketsNoSubscription -SupportTicketName -ContactDetailCountry - -ContactDetailFirstName -ContactDetailLastName +New-AzSupportTicketsNoSubscription -SupportTicketName -AdvancedDiagnosticConsent + -ContactDetailCountry -ContactDetailFirstName -ContactDetailLastName -ContactDetailPreferredContactMethod -ContactDetailPreferredSupportLanguage -ContactDetailPreferredTimeZone -ContactDetailPrimaryEmailAddress -Description -ProblemClassificationId -ServiceId -Severity -Title - [-AdvancedDiagnosticConsent ] [-ContactDetailAdditionalEmailAddress ] - [-ContactDetailPhoneNumber ] [-FileWorkspaceName ] [-ProblemScopingQuestion ] - [-ProblemStartTime ] [-QuotaTicketDetailQuotaChangeRequest ] + [-ContactDetailAdditionalEmailAddress ] [-ContactDetailPhoneNumber ] + [-FileWorkspaceName ] [-ProblemScopingQuestion ] [-ProblemStartTime ] + [-QuotaTicketDetailQuotaChangeRequest ] [-QuotaTicketDetailQuotaChangeRequestSubType ] [-QuotaTicketDetailQuotaChangeRequestVersion ] [-Require24X7Response] [-SecondaryConsent ] [-SupportPlanId ] [-SupportTicketId ] [-TechnicalTicketDetailResourceId ] [-DefaultProfile ] [-AsJob] @@ -102,7 +102,7 @@ Type: System.String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False