openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 89 kB

JSON

{"openapi":"3.0.0","info":{"description":"Microsoft Azure Support Resource Provider.","title":"Microsoft.Support","version":"2019-05-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/support/resource-manager/Microsoft.Support/preview/2019-05-01-preview/support.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"support","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/providers/Microsoft.Support/operations":{"get":{"description":"This lists all the available Microsoft Support REST API operations.","operationId":"Operations_List","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved list of operations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationsListResult"},"examples":{"Get all operations":{"$ref":"#/components/examples/Get_all_operations"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}}}},"tags":["Operations"],"x-ms-pageable":{}}},"/providers/Microsoft.Support/services":{"get":{"description":"Lists all the Azure services available for support ticket creation. Here are the Service Ids for **Billing**, **Subscription Management**, and **Service and subscription limits (Quotas)** issues: <table><tr><td>Issue type</td><td>Service Id</td></tr><tr><td>Billing</td><td>'/providers/Microsoft.Support/services/517f2da6-78fd-0498-4e22-ad26996b1dfc'</td></tr><tr><td>Subscription Management</td><td>'/providers/Microsoft.Support/services/f3dc5421-79ef-1efa-41a5-42bf3cbb52c6'</td></tr><tr><td>Quota</td><td>'/providers/Microsoft.Support/services/06bfd9d3-516b-d5c6-5802-169c800dec89'</td></tr></table> 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 <a target='_blank' href='https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/overview'>New support request</a> page. Always use the service and it's 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.","operationId":"Services_List","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved list of Azure services available for support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicesListResult"},"examples":{"Gets list of services for which a support ticket can be created":{"$ref":"#/components/examples/Gets_list_of_services_for_which_a_support_ticket_can_be_created"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}}}},"tags":["Services"],"x-ms-pageable":{}}},"/providers/Microsoft.Support/services/{serviceName}":{"get":{"description":"Gets a specific Azure service for support ticket creation.","operationId":"Services_Get","parameters":[{"description":"Name of Azure service","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"Gets details of Azure service":{"value":"service_guid"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved Azure service for support ticket creation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Service"},"examples":{"Gets details of Azure service":{"$ref":"#/components/examples/Gets_details_of_Azure_service"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}}}},"tags":["Services"]}},"/providers/Microsoft.Support/services/{serviceName}/problemClassifications":{"get":{"description":"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.","operationId":"ProblemClassifications_List","parameters":[{"description":"Name of Azure service for which the problem classifications need to be retrieved.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"Gets list of problemClassifications for a service for which a support ticket can be created":{"value":"service_guid"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved list of problem classifications for the specified Azure service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemClassificationsListResult"},"examples":{"Gets list of problemClassifications for a service for which a support ticket can be created":{"$ref":"#/components/examples/Gets_list_of_problemClassifications_for_a_service_for_which_a_support_ticket_can_be_created"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}}}},"tags":["ProblemClassifications"],"x-ms-pageable":{}}},"/providers/Microsoft.Support/services/{serviceName}/problemClassifications/{problemClassificationName}":{"get":{"description":"Gets the details of a specific problem classification for a specific Azure service.","operationId":"ProblemClassifications_Get","parameters":[{"description":"Name of Azure service available for support.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"Gets details of problemClassification for Azure service":{"value":"service_guid"}}},{"description":"Name of problem classification.","in":"path","name":"problemClassificationName","required":true,"schema":{"type":"string"},"examples":{"Gets details of problemClassification for Azure service":{"value":"problemClassification_guid"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved problem classification details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemClassification"},"examples":{"Gets details of problemClassification for Azure service":{"$ref":"#/components/examples/Gets_details_of_problemClassification_for_Azure_service"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}}}},"tags":["ProblemClassifications"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.Support/checkNameAvailability":{"post":{"description":"Check the availability of a resource name. This API should to be used to check the uniqueness of the name for support ticket creation for the selected subscription.","operationId":"SupportTickets_CheckNameAvailability","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckNameAvailabilityInput"}}},"description":"Input to check.","required":true},"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckNameAvailabilityOutput"},"examples":{"Checks whether name is available for SupportTicket resource":{"$ref":"#/components/examples/Checks_whether_name_is_available_for_SupportTicket_resource"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}}}},"tags":["SupportTickets"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets":{"get":{"description":"Lists all the support tickets for an Azure subscription. You can also filter the support tickets by Status or CreatedDate using the $filter parameter. Output will be a paged result with nextLink, using which you can retrieve the next set of support tickets. Support ticket data is available for 12 months after ticket creation. If a ticket was created more than 12 months ago, a request for data might cause an error.","operationId":"SupportTickets_List","parameters":[{"description":"The number of values to return in the collection. Default is 25 and max is 100.","in":"query","name":"$top","required":false,"schema":{"type":"integer"}},{"description":"The filter to apply on the operation. We support 'odata v4.0' filter semantics. <a target='_blank' href='https://docs.microsoft.com/odata/concepts/queryoptions-overview'>Learn more</a> Status filter can only be used with 'eq' operator. For CreatedDate filter, the supported operators are 'gt' and 'ge'. When using both filters, combine them using the logical 'AND'.","in":"query","name":"$filter","required":false,"schema":{"type":"string"},"examples":{"List support tickets created on or after a certain date and in open state for a subscription":{"value":"createdDate ge 2019-12-10T22:08:51Z and status eq 'Open'"},"List support tickets in open state for a subscription":{"value":"status eq 'Open'"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved support tickets.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportTicketsListResult"},"examples":{"List support tickets created on or after a certain date and in open state for a subscription":{"$ref":"#/components/examples/List_support_tickets_created_on_or_after_a_certain_date_and_in_open_state_for_a_subscription"},"List support tickets for a subscription":{"$ref":"#/components/examples/List_support_tickets_for_a_subscription"},"List support tickets in open state for a subscription":{"$ref":"#/components/examples/List_support_tickets_in_open_state_for_a_subscription"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}}}},"tags":["SupportTickets"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}":{"get":{"description":"Gets details for a specific support ticket in an Azure subscription. Support ticket data is available for 12 months after ticket creation. If a ticket was created more than 12 months ago, a request for data might cause an error.","operationId":"SupportTickets_Get","parameters":[{"description":"Support ticket name","in":"path","name":"supportTicketName","required":true,"schema":{"type":"string"},"examples":{"Get details of a subscription ticket":{"value":"testticket"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved support ticket.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportTicketDetails"},"examples":{"Get details of a subscription ticket":{"$ref":"#/components/examples/Get_details_of_a_subscription_ticket"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}}}},"tags":["SupportTickets"]},"patch":{"description":"This API allows you to update the severity level or your contact information in the support ticket. Note: The severity levels cannot be changed if a support ticket is actively being worked upon by an Azure support engineer. In such a case, contact your support engineer to request severity update by adding a new communication using the Communications API.","operationId":"SupportTickets_Update","parameters":[{"description":"Support ticket name","in":"path","name":"supportTicketName","required":true,"schema":{"type":"string"},"examples":{"UpdateSupportTicketForSubscription":{"value":"testticket"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSupportTicket"}}},"description":"UpdateSupportTicket object","required":true},"responses":{"200":{"description":"Successfully updated support ticket.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportTicketDetails"},"examples":{"UpdateSupportTicketForSubscription":{"$ref":"#/components/examples/UpdateSupportTicketForSubscription"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}}}},"tags":["SupportTickets"]},"put":{"description":"Creates a new support ticket for Quota increase, Technical, Billing, and Subscription Management issues for the specified subscription. A paid technical support plan is required to create a support ticket using this API. <a href='https://aka.ms/supportticketAPI'>Learn more</a> Use the Services API to map the right Service Id to the issue type. For example: For billing tickets set *serviceId* to *'/providers/Microsoft.Support/services/517f2da6-78fd-0498-4e22-ad26996b1dfc'*. For Technical issues, the Service id will map to the Azure service you want to raise a support ticket for. Always call the Services and ProblemClassifications API to get the most recent set of services and problem categories required for support ticket creation.","operationId":"SupportTickets_Create","parameters":[{"description":"Support ticket name.","in":"path","name":"supportTicketName","required":true,"schema":{"type":"string"},"examples":{"Create a ticket for Billing related issues":{"value":"testticket"},"Create a ticket for Subscription Management related issues":{"value":"testticket"},"Create a ticket for Technical issue related to a specific resource":{"value":"testticket"},"Create a ticket to request Quota increase for Active Jobs and Job Schedules for a Batch account":{"value":"testticket"},"Create a ticket to request Quota increase for Compute VM Cores":{"value":"testticket"},"Create a ticket to request Quota increase for DTUs for SQL Data Warehouse":{"value":"testticket"},"Create a ticket to request Quota increase for DTUs for SQL Database":{"value":"testticket"},"Create a ticket to request Quota increase for Low-priority cores for Machine Learning service":{"value":"testticket"},"Create a ticket to request Quota increase for Low-priority cores for a Batch account":{"value":"testticket"},"Create a ticket to request Quota increase for Pools for a Batch account":{"value":"testticket"},"Create a ticket to request Quota increase for Servers for SQL Data Warehouse":{"value":"testticket"},"Create a ticket to request Quota increase for Servers for SQL Database":{"value":"testticket"},"Create a ticket to request Quota increase for number of Batch accounts for a subscription":{"value":"testticket"},"Create a ticket to request Quota increase for specific VM family cores for Machine Learning service":{"value":"testticket"},"Create a ticket to request Quota increase for specific VM family cores for a Batch account":{"value":"testticket"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportTicketDetails"}}},"description":"Support ticket request payload.","required":true},"responses":{"200":{"description":"OK - SupportTicket created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportTicketDetails"},"examples":{"Create a ticket for Billing related issues":{"$ref":"#/components/examples/Create_a_ticket_for_Billing_related_issues"},"Create a ticket for Subscription Management related issues":{"$ref":"#/components/examples/Create_a_ticket_for_Subscription_Management_related_issues"},"Create a ticket for Technical issue related to a specific resource":{"$ref":"#/components/examples/Create_a_ticket_for_Technical_issue_related_to_a_specific_resource"},"Create a ticket to request Quota increase for Active Jobs and Job Schedules for a Batch account":{"$ref":"#/components/examples/Create_a_ticket_to_request_Quota_increase_for_Active_Jobs_and_Job_Schedules_for_a_Batch_account"},"Create a ticket to request Quota increase for Compute VM Cores":{"$ref":"#/components/examples/Create_a_ticket_to_request_Quota_increase_for_Compute_VM_Cores"},"Create a ticket to request Quota increase for DTUs for SQL Data Warehouse":{"$ref":"#/components/examples/Create_a_ticket_to_request_Quota_increase_for_DTUs_for_SQL_Data_Warehouse"},"Create a ticket to request Quota increase for DTUs for SQL Database":{"$ref":"#/components/examples/Create_a_ticket_to_request_Quota_increase_for_DTUs_for_SQL_Database"},"Create a ticket to request Quota increase for Low-priority cores for Machine Learning service":{"$ref":"#/components/examples/Create_a_ticket_to_request_Quota_increase_for_Low-priority_cores_for_Machine_Learning_service"},"Create a ticket to request Quota increase for Low-priority cores for a Batch account":{"$ref":"#/components/examples/Create_a_ticket_to_request_Quota_increase_for_Low-priority_cores_for_a_Batch_account"},"Create a ticket to request Quota increase for Pools for a Batch account":{"$ref":"#/components/examples/Create_a_ticket_to_request_Quota_increase_for_Pools_for_a_Batch_account"},"Create a ticket to request Quota increase for Servers for SQL Data Warehouse":{"$ref":"#/components/examples/Create_a_ticket_to_request_Quota_increase_for_Servers_for_SQL_Data_Warehouse"},"Create a ticket to request Quota increase for Servers for SQL Database":{"$ref":"#/components/examples/Create_a_ticket_to_request_Quota_increase_for_Servers_for_SQL_Database"},"Create a ticket to request Quota increase for number of Batch accounts for a subscription":{"$ref":"#/components/examples/Create_a_ticket_to_request_Quota_increase_for_number_of_Batch_accounts_for_a_subscription"},"Create a ticket to request Quota increase for specific VM family cores for Machine Learning service":{"$ref":"#/components/examples/Create_a_ticket_to_request_Quota_increase_for_specific_VM_family_cores_for_Machine_Learning_service"},"Create a ticket to request Quota increase for specific VM family cores for a Batch account":{"$ref":"#/components/examples/Create_a_ticket_to_request_Quota_increase_for_specific_VM_family_cores_for_a_Batch_account"}}}}},"202":{"description":"Accepted, SupportTicket will be created asynchronously"},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}}}},"tags":["SupportTickets"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"azure-async-operation"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/checkNameAvailability":{"post":{"description":"Check the availability of a resource name. This API should to be used to check the uniqueness of the name for adding a new communication to the support ticket.","operationId":"Communications_CheckNameAvailability","parameters":[{"description":"Support ticket name","in":"path","name":"supportTicketName","required":true,"schema":{"type":"string"},"examples":{"Checks whether name is available for Communication resource":{"value":"testticket"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckNameAvailabilityInput"}}},"description":"Input to check","required":true},"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckNameAvailabilityOutput"},"examples":{"Checks whether name is available for Communication resource":{"$ref":"#/components/examples/Checks_whether_name_is_available_for_Communication_resource"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}}}},"tags":["Communications"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications":{"get":{"description":"Lists all communications (attachments not included) for a support ticket. 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. Support ticket data is available for 12 months after ticket creation. If a ticket was created more than 12 months ago, a request for data might cause an error.","operationId":"Communications_List","parameters":[{"description":"Support ticket name","in":"path","name":"supportTicketName","required":true,"schema":{"type":"string"},"examples":{"List communications for a subscription support ticket":{"value":"testticket"},"List web communication created on or after a specific date for a subscription support ticket":{"value":"testticket"},"List web communications for a subscription support ticket":{"value":"testticket"}}},{"description":"The number of values to return in the collection. Default is 10 and max is 10.","in":"query","name":"$top","required":false,"schema":{"type":"integer"}},{"description":"The filter to apply on the operation. You can filter by communicationType and createdDate properties. CommunicationType supports Equals ('eq') operator and createdDate supports Greater Than ('gt') and Greater Than or Equals ('ge') operators. You may combine the CommunicationType and CreatedDate filters by Logical And ('and') operator.","in":"query","name":"$filter","required":false,"schema":{"type":"string"},"examples":{"List web communication created on or after a specific date for a subscription support ticket":{"value":"communicationType eq 'web' and createdDate ge 2019-12-10T22:08:51Z"},"List web communications for a subscription support ticket":{"value":"communicationType eq 'web'"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved communications for a support ticket.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunicationsListResult"},"examples":{"List communications for a subscription support ticket":{"$ref":"#/components/examples/List_communications_for_a_subscription_support_ticket"},"List web communication created on or after a specific date for a subscription support ticket":{"$ref":"#/components/examples/List_web_communication_created_on_or_after_a_specific_date_for_a_subscription_support_ticket"},"List web communications for a subscription support ticket":{"$ref":"#/components/examples/List_web_communications_for_a_subscription_support_ticket"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}}}},"tags":["Communications"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}":{"get":{"description":"Returns details of a specific communication in a support ticket.","operationId":"Communications_Get","parameters":[{"description":"Support ticket name","in":"path","name":"supportTicketName","required":true,"schema":{"type":"string"},"examples":{"Get communication details for a subscription support ticket":{"value":"testticket"}}},{"description":"Communication name","in":"path","name":"communicationName","required":true,"schema":{"type":"string"},"examples":{"Get communication details for a subscription support ticket":{"value":"testmessage"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved communication details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunicationDetails"},"examples":{"Get communication details for a subscription support ticket":{"$ref":"#/components/examples/Get_communication_details_for_a_subscription_support_ticket"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}}}},"tags":["Communications"]},"put":{"description":"Adds a new customer communication to an Azure support ticket. Adding attachments are not currently supported via the API. To add a file to a support ticket, visit the <a target='_blank' href='https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/managesupportrequest'>Manage support ticket</a> page in the Azure portal, select the support ticket, and use the file upload control to add a new file.","operationId":"Communications_Create","parameters":[{"description":"Support ticket name","in":"path","name":"supportTicketName","required":true,"schema":{"type":"string"},"examples":{"AddCommunicationToSubscriptionTicket":{"value":"testticket"}}},{"description":"Communication name","in":"path","name":"communicationName","required":true,"schema":{"type":"string"},"examples":{"AddCommunicationToSubscriptionTicket":{"value":"testcommunication"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunicationDetails"}}},"description":"Communication object","required":true},"responses":{"200":{"description":"OK - Communication created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunicationDetails"},"examples":{"AddCommunicationToSubscriptionTicket":{"$ref":"#/components/examples/AddCommunicationToSubscriptionTicket"}}}}},"202":{"description":"Accepted, Communication will be created asynchronously"},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}}}},"tags":["Communications"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"azure-async-operation"}}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"Get_all_operations":{"value":{"value":[{"display":{"description":"Gets all the Azure services available for support","operation":"Reads Services","provider":"Microsoft Support","resource":"Service"},"name":"Microsoft.Support/services/read"},{"display":{"description":"Gets all the problem classifications available for a specific Azure service","operation":"Reads Problem Classifications","provider":"Microsoft Support","resource":"Problem Classification"},"name":"Microsoft.Support/problemClassifications/read"},{"display":{"description":"Gets all the support tickets","operation":"Reads Support Tickets","provider":"Microsoft Support","resource":"Support Ticket"},"name":"Microsoft.Support/supportTickets/read"},{"display":{"description":"Updates support ticket","operation":"Updates support ticket","provider":"Microsoft Support","resource":"Support Ticket"},"name":"Microsoft.Support/supportTickets/write"},{"display":{"description":"Gets all the communications","operation":"Reads Communications","provider":"Microsoft Support","resource":"Communication"},"name":"Microsoft.Support/communications/read"},{"display":{"description":"Creates a communication","operation":"Creates a communication","provider":"Microsoft Support","resource":"Communication"},"name":"Microsoft.Support/communications/write"},{"display":{"description":"Registers Support Resource Provider","operation":"Registers Support Resource Provider","provider":"Registers Support Resource Provider","resource":"Support Registration"},"name":"Microsoft.Support/register/action"},{"display":{"description":"Creates support ticket","operation":"Registers Support Resource Provider","provider":"Microsoft Support","resource":"SupportTicket"},"name":"Microsoft.Support/createSupportTicket/action"},{"display":{"description":"Add communication to support ticket","operation":"Registers Support Resource Provider","provider":"Microsoft Support","resource":"Communication"},"name":"Microsoft.Support/addCommunication/action"}]}},"Gets_list_of_services_for_which_a_support_ticket_can_be_created":{"value":{"value":[{"id":"/providers/Microsoft.Support/services/service_guid_1","name":"service_guid_1","properties":{"displayName":"Billing"},"type":"Microsoft.Support/services"},{"id":"/providers/Microsoft.Support/services/service_guid_2","name":"service_guid_2","properties":{"displayName":"Service and subscription limits (quotas)"},"type":"Microsoft.Support/services"},{"id":"/providers/Microsoft.Support/services/service_guid_3","name":"service_guid_3","properties":{"displayName":"Subscription management"},"type":"Microsoft.Support/services"},{"id":"/providers/Microsoft.Support/services/service_guid_4","name":"service_guid_4","properties":{"displayName":"Data Explorer"},"type":"Microsoft.Support/services"}]}},"Gets_details_of_Azure_service":{"value":{"id":"/providers/Microsoft.Support/services/service_guid","name":"service_guid","properties":{"displayName":"Billing"},"type":"Microsoft.Support/services"}},"Gets_list_of_problemClassifications_for_a_service_for_which_a_support_ticket_can_be_created":{"value":{"value":[{"id":"/providers/Microsoft.Support/services/service_guid/problemClassifications/problemClassification_guid_1","name":"problemClassification_guid_1","properties":{"displayName":"Reservation Management / Exchanges and Refunds"},"type":"Microsoft.Support/problemClassifications"},{"id":"/providers/Microsoft.Support/services/service_guid/problemClassifications/problemClassification_guid_2","name":"problemClassification_guid_2","properties":{"displayName":"Reservation Management / Request Invoices"},"type":"Microsoft.Support/problemClassifications"},{"id":"/providers/Microsoft.Support/services/service_guid/problemClassifications/problemClassification_guid_3","name":"problemClassification_guid_3","properties":{"displayName":"Reservation Management / Other Iissues or Requests"},"type":"Microsoft.Support/problemClassifications"},{"id":"/providers/Microsoft.Support/services/service_guid/problemClassifications/problemClassification_guid_4","name":"problemClassification_guid_4","properties":{"displayName":"Other General Billing Questions"},"type":"Microsoft.Support/problemClassifications"}]}},"Gets_details_of_problemClassification_for_Azure_service":{"value":{"id":"/providers/Microsoft.Support/services/service_guid/problemClassifications/problemClassification_guid","name":"problemClassification_guid","properties":{"displayName":"Reservation Management / Exchanges and Refunds"},"type":"Microsoft.Support/problemClassifications"}},"Checks_whether_name_is_available_for_SupportTicket_resource":{"value":{"message":"Name not available","nameAvailable":false,"reason":"Name is already in use"}},"List_support_tickets_created_on_or_after_a_certain_date_and_in_open_state_for_a_subscription":{"value":{"value":[{"id":"/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket","name":"testticket","properties":{"contactDetails":{"country":"usa","firstName":"abc","lastName":"xyz","preferredContactMethod":"email","preferredSupportLanguage":"en-US","preferredTimeZone":"Pacific Standard Time","primaryEmailAddress":"abc@contoso.com"},"createdDate":"2019-12-20T21:36:18Z","description":"my description","modifiedDate":"2019-12-20T21:36:23Z","problemClassificationDisplayName":"Connectivity / Cannot connect to virtual machine by using RDP or SSH","problemClassificationId":"/providers/Microsoft.Support/services/virtual_machine_service_guid/problemClassifications/problemClassification_guid","productionOutage":false,"require24X7Response":false,"serviceDisplayName":"Virtual Machine running Linux","serviceId":"/providers/Microsoft.Support/services/virtual_machine_service_guid","serviceLevelAgreement":{"expirationTime":"2019-12-21T17:36:18Z","slaMinutes":240,"startTime":"2019-12-20T21:36:18Z"},"severity":"moderate","status":"Open","supportPlanType":"Premier","supportTicketId":"119120321001170","technicalTicketDetails":{"resourceId":"/subscriptions/subid/resourceGroups/test/providers/Microsoft.Compute/virtualMachines/testserver"},"title":"my title"},"type":"Microsoft.Support/supportTickets"},{"id":"/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket2","name":"testticket2","properties":{"contactDetails":{"country":"USA","firstName":"abc","lastName":"xyz","preferredContactMethod":"email","preferredSupportLanguage":"en-US","preferredTimeZone":"Pacific Standard Time","primaryEmailAddress":"abc@contoso.com"},"createdDate":"2019-12-20T21:36:18Z","description":"This is a test - please ignore","modifiedDate":"2019-12-20T21:36:23Z","problemClassificationDisplayName":"Add or Edit VAT, TAX ID, or PO Number","problemClassificationId":"/providers/Microsoft.Support/services/subscription_management_service_guid/problemClassifications/problemClassification_guid","productionOutage":false,"require24X7Response":false,"serviceDisplayName":"Subscription management","serviceId":"/providers/Microsoft.Support/services/subscription_management_service_guid","serviceLevelAgreement":{"expirationTime":"2019-12-21T17:36:18Z","slaMinutes":240,"startTime":"2019-12-20T21:36:18Z"},"severity":"minimal","status":"Open","supportPlanType":"Premier","supportTicketId":"118032014183771","title":"Test - please ignore"},"type":"Microsoft.Support/supportTickets"}]}},"List_support_tickets_for_a_subscription":{"value":{"value":[{"id":"/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket","name":"testticket","properties":{"contactDetails":{"country":"usa","firstName":"abc","lastName":"xyz","preferredContactMethod":"email","preferredSupportLanguage":"en-US","preferredTimeZone":"Pacific Standard Time","primaryEmailAddress":"abc@contoso.com"},"createdDate":"2018-03-20T21:36:18Z","description":"my description","modifiedDate":"2018-03-20T21:36:23Z","problemClassificationDisplayName":"Connectivity / Cannot connect to virtual machine by using RDP or SSH","problemClassificationId":"/providers/Microsoft.Support/services/virtual_machine_service_guid/problemClassifications/problemClassification_guid","productionOutage":false,"require24X7Response":false,"serviceDisplayName":"Virtual Machine running Linux","serviceId":"/providers/Microsoft.Support/services/virtual_machine_service_guid","serviceLevelAgreement":{"expirationTime":"2018-03-21T17:36:18Z","slaMinutes":240,"startTime":"2018-03-20T21:36:18Z"},"severity":"moderate","status":"Open","supportPlanType":"Premier","supportTicketId":"119120321001170","technicalTicketDetails":{"resourceId":"/subscriptions/subid/resourceGroups/test/providers/Microsoft.Compute/virtualMachines/testserver"},"title":"my title"},"type":"Microsoft.Support/supportTickets"},{"id":"/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket2","name":"testticket2","properties":{"contactDetails":{"country":"USA","firstName":"abc","lastName":"xyz","preferredContactMethod":"email","preferredSupportLanguage":"en-US","preferredTimeZone":"Pacific Standard Time","primaryEmailAddress":"abc@contoso.com"},"createdDate":"2018-03-20T21:36:18Z","description":"This is a test - please ignore","modifiedDate":"2018-03-20T21:36:23Z","problemClassificationDisplayName":"Add or Edit VAT, TAX ID, or PO Number","problemClassificationId":"/providers/Microsoft.Support/services/subscription_management_service_guid/problemClassifications/problemClassification_guid","productionOutage":false,"require24X7Response":false,"serviceDisplayName":"Subscription management","serviceId":"/providers/Microsoft.Support/services/subscription_management_service_guid","serviceLevelAgreement":{"expirationTime":"2018-03-21T17:36:18Z","slaMinutes":240,"startTime":"2018-03-20T21:36:18Z"},"severity":"minimal","status":"Open","supportPlanType":"Premier","supportTicketId":"118032014183771","title":"Test - please ignore"},"type":"Microsoft.Support/supportTickets"}]}},"List_support_tickets_in_open_state_for_a_subscription":{"value":{"value":[{"id":"/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket","name":"testticket","properties":{"contactDetails":{"country":"usa","firstName":"abc","lastName":"xyz","preferredContactMethod":"email","preferredSupportLanguage":"en-US","preferredTimeZone":"Pacific Standard Time","primaryEmailAddress":"abc@contoso.com"},"createdDate":"2018-03-20T21:36:18Z","description":"my description","modifiedDate":"2018-03-20T21:36:23Z","problemClassificationDisplayName":"Connectivity / Cannot connect to virtual machine by using RDP or SSH","problemClassificationId":"/providers/Microsoft.Support/services/virtual_machine_service_guid/problemClassifications/problemClassification_guid","productionOutage":false,"require24X7Response":false,"serviceDisplayName":"Virtual Machine running Linux","serviceId":"/providers/Microsoft.Support/services/virtual_machine_service_guid","serviceLevelAgreement":{"expirationTime":"2018-03-21T17:36:18Z","slaMinutes":240,"startTime":"2018-03-20T21:36:18Z"},"severity":"moderate","status":"Open","supportPlanType":"Premier","supportTicketId":"119120321001170","technicalTicketDetails":{"resourceId":"/subscriptions/subid/resourceGroups/test/providers/Microsoft.Compute/virtualMachines/testserver"},"title":"my title"},"type":"Microsoft.Support/supportTickets"},{"id":"/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket2","name":"testticket2","properties":{"contactDetails":{"country":"USA","firstName":"abc","lastName":"xyz","preferredContactMethod":"email","preferredSupportLanguage":"en-US","preferredTimeZone":"Pacific Standard Time","primaryEmailAddress":"abc@contoso.com"},"createdDate":"2018-03-20T21:36:18Z","description":"This is a test - please ignore","modifiedDate":"2018-03-20T21:36:23Z","problemClassificationDisplayName":"Add or Edit VAT, TAX ID, or PO Number","problemClassificationId":"/providers/Microsoft.Support/services/subscription_management_service_guid/problemClassifications/problemClassification_guid","productionOutage":false,"require24X7Response":false,"serviceDisplayName":"Subscription management","serviceId":"/providers/Microsoft.Support/services/subscription_management_service_guid","serviceLevelAgreement":{"expirationTime":"2018-03-21T17:36:18Z","slaMinutes":240,"startTime":"2018-03-20T21:36:18Z"},"severity":"minimal","status":"Open","supportPlanType":"Premier","supportTicketId":"118032014183771","title":"Test - please ignore"},"type":"Microsoft.Support/supportTickets"}]}},"Get_details_of_a_subscription_ticket":{"value":{"id":"/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket","name":"testticket","properties":{"contactDetails":{"country":"USA","firstName":"abc","lastName":"xyz","preferredContactMethod":"email","preferredSupportLanguage":"en-US","preferredTimeZone":"Pacific Standard Time","primaryEmailAddress":"abc@contoso.com"},"createdDate":"2018-03-20T21:36:18Z","description":"This is a test - please ignore","modifiedDate":"2018-03-20T21:36:23Z","problemClassificationDisplayName":"Add or Edit VAT, TAX ID, or PO Number","problemClassificationId":"/providers/Microsoft.Support/services/subscription_management_service_guid/problemClassifications/problemClassification_guid","productionOutage":false,"require24X7Response":false,"serviceDisplayName":"Subscription management","serviceId":"/providers/Microsoft.Support/services/subscription_management_service_guid","serviceLevelAgreement":{"expirationTime":"2018-03-21T17:36:18Z","slaMinutes":240,"startTime":"2018-03-20T21:36:18Z"},"severity":"minimal","status":"Open","supportPlanType":"Premier","supportTicketId":"118032014183770","title":"Test - please ignore"},"type":"Microsoft.Support/supportTickets"}},"UpdateSupportTicketForSubscription":{"value":{"id":"/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket","name":"testticket","properties":{"contactDetails":{"country":"USA","firstName":"abc","lastName":"xyz","preferredContactMethod":"email","preferredSupportLanguage":"en-US","preferredTimeZone":"Pacific Standard Time","primaryEmailAddress":"abc@contoso.com"},"createdDate":"2018-03-20T21:36:18Z","description":"This is a test - please ignore","modifiedDate":"2018-03-20T21:36:23Z","problemClassificationDisplayName":"Add or Edit VAT, TAX ID, or PO Number","problemClassificationId":"/providers/Microsoft.Support/services/subscription_management_service_guid/problemClassifications/problemClassification_guid","productionOutage":false,"require24X7Response":false,"serviceDisplayName":"Subscription management","serviceId":"/providers/Microsoft.Support/services/subscription_management_service_guid","serviceLevelAgreement":{"expirationTime":"2018-03-21T17:36:18Z","slaMinutes":240,"startTime":"2018-03-20T21:36:18Z"},"severity":"critical","status":"Open","supportPlanType":"Premier","supportTicketId":"118032014183770","title":"Test - please ignore"},"type":"Microsoft.Support/supportTickets"}},"Create_a_ticket_for_Billing_related_issues":{"value":{"id":"/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket","name":"testticket","properties":{"contactDetails":{"country":"usa","firstName":"abc","lastName":"xyz","preferredContactMethod":"email","preferredSupportLanguage":"en-US","preferredTimeZone":"Pacific Standard Time","primaryEmailAddress":"abc@contoso.com"},"createdDate":"2018-03-20T21:36:18Z","description":"my description","modifiedDate":"2018-03-20T21:36:23Z","problemClassificationDisplayName":"Refund request","problemClassificationId":"/providers/Microsoft.Support/services/billing_service_guid/problemClassifications/billing_problemClassification_guid","productionOutage":false,"require24X7Response":false,"serviceDisplayName":"Billing","serviceId":"/providers/Microsoft.Support/services/billing_service_guid","serviceLevelAgreement":{"expirationTime":"2018-03-21T17:36:18Z","slaMinutes":240,"startTime":"2018-03-20T21:36:18Z"},"severity":"moderate","status":"Open","supportPlanType":"Premier","supportTicketId":"119120321001170","title":"my title"},"type":"Microsoft.Support/supportTickets"}},"Create_a_ticket_for_Subscription_Management_related_issues":{"value":{"id":"/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket","name":"testticket","properties":{"contactDetails":{"country":"usa","firstName":"abc","lastName":"xyz","preferredContactMethod":"email","preferredSupportLanguage":"en-US","preferredTimeZone":"Pacific Standard Time","primaryEmailAddress":"abc@contoso.com"},"createdDate":"2018-03-20T21:36:18Z","description":"my description","modifiedDate":"2018-03-20T21:36:23Z","problemClassificationDisplayName":"Transfer ownership of my subscription","problemClassificationId":"/providers/Microsoft.Support/services/subscription_management_service_guid/problemClassifications/subscription_management_problemClassification_guid","productionOutage":false,"require24X7Response":false,"serviceDisplayName":"Subscription management","serviceId":"/providers/Microsoft.Support/services/subscription_management_service_guid","serviceLevelAgreement":{"expirationTime":"2018-03-21T17:36:18Z","slaMinutes":240,"startTime":"2018-03-20T21:36:18Z"},"severity":"moderate","status":"Open","supportPlanType":"Premier","supportTicketId":"119120321001170","title":"my title"},"type":"Microsoft.Support/supportTickets"}},"Create_a_ticket_for_Technical_issue_related_to_a_specific_resource":{"value":{"id":"/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket","name":"testticket","properties":{"contactDetails":{"country":"usa","firstName":"abc","lastName":"xyz","preferredContactMethod":"email","preferredSupportLanguage":"en-US","preferredTimeZone":"Pacific Standard Time","primaryEmailAddress":"abc@contoso.com"},"createdDate":"2018-03-20T21:36:18Z","description":"my description","modifiedDate":"2018-03-20T21:36:23Z","problemClassificationDisplayName":"Connectivity / Cannot connect to virtual machine by using RDP or SSH","problemClassificationId":"/providers/Microsoft.Support/services/virtual_machine_running_linux_service_guid/problemClassifications/problemClassification_guid","productionOutage":false,"require24X7Response":false,"serviceDisplayName":"Virtual Machine running Linux","serviceId":"/providers/Microsoft.Support/services/virtual_machine_running_linux_service_guid","serviceLevelAgreement":{"expirationTime":"2018-03-21T17:36:18Z","slaMinutes":240,"startTime":"2018-03-20T21:36:18Z"},"severity":"moderate","status":"Open","supportPlanType":"Premier","supportTicketId":"119120321001170","technicalTicketDetails":{"resourceId":"/subscriptions/subid/resourceGroups/test/providers/Microsoft.Compute/virtualMachines/testserver"},"title":"my title"},"type":"Microsoft.Support/supportTickets"}},"Create_a_ticket_to_request_Quota_increase_for_Active_Jobs_and_Job_Schedules_for_a_Batch_account":{"value":{"id":"/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket","name":"testticket","properties":{"contactDetails":{"country":"usa","firstName":"abc","lastName":"xyz","preferredContactMethod":"email","preferredSupportLanguage":"en-US","preferredTimeZone":"Pacific Standard Time","primaryEmailAddress":"abc@contoso.com"},"createdDate":"2018-03-20T21:36:18Z","description":"my description","modifiedDate":"2018-03-20T21:36:23Z","problemClassificationDisplayName":"Batch","problemClassificationId":"/providers/Microsoft.Support/services/quota_service_guid/problemClassifications/batch_problemClassification_guid","productionOutage":false,"quotaTicketDetails":{"quotaChangeRequestSubType":"Account","quotaChangeRequestVersion":"1.0","quotaChangeRequests":[{"payload":"{\"AccountName\":\"test\",\"NewLimit\":200,\"Type\":\"Jobs\"}","region":"EastUS"}]},"require24X7Response":false,"serviceDisplayName":"Service and subscription limits (quotas)","serviceId":"/providers/Microsoft.Support/services/quota_service_guid","serviceLevelAgreement":{"expirationTime":"2018-03-21T17:36:18Z","slaMinutes":240,"startTime":"2018-03-20T21:36:18Z"},"severity":"moderate","status":"Open","supportPlanType":"Premier","supportTicketId":"119120321001170","title":"my title"},"type":"Microsoft.Support/supportTickets"}},"Create_a_ticket_to_request_Quota_increase_for_Compute_VM_Cores":{"value":{"id":"/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket","name":"testticket","properties":{"contactDetails":{"country":"usa","firstName":"abc","lastName":"xyz","preferredContactMethod":"email","preferredSupportLanguage":"en-US","preferredTimeZone":"Pacific Standard Time","primaryEmailAddress":"abc@contoso.com"},"createdDate":"2018-03-20T21:36:18Z","description":"my description","modifiedDate":"2018-03-20T21:36:23Z","problemClassificationDisplayName":"Compute-VM (cores-vCPUs) subscription limit increases","problemClassificationId":"/providers/Microsoft.Support/services/quota_service_guid/problemClassifications/cores_problemClassification_guid","productionOutage":false,"quotaTicketDetails":{"quotaChangeRequestVersion":"1.0","quotaChangeRequests":[{"payload":"{\"VmFamily\":\"DSv3 Series\",\"NewLimit\":104}","region":"EastUS"}]},"require24X7Response":false,"serviceDisplayName":"Service and subscription limits (quotas)","serviceId":"/providers/Microsoft.Support/services/quota_service_guid","serviceLevelAgreement":{"expirationTime":"2018-03-21T17:36:18Z","slaMinutes":240,"startTime":"2018-03-20T21:36:18Z"},"severity":"moderate","status":"Open","supportPlanType":"Premier","supportTicketId":"119120321001170","title":"my title"},"type":"Microsoft.Support/supportTickets"}},"Create_a_ticket_to_request_Quota_increase_for_DTUs_for_SQL_Data_Warehouse":{"value":{"id":"/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket","name":"testticket","properties":{"contactDetails":{"country":"usa","firstName":"abc","lastName":"xyz","preferredContactMethod":"email","preferredSupportLanguage":"en-US","preferredTimeZone":"Pacific Standard Time","primaryEmailAddress":"abc@contoso.com"},"createdDate":"2018-03-20T21:36:18Z","description":"my description","modifiedDate":"2018-03-20T21:36:23Z","problemClassificationDisplayName":"SQL Data Warehouse","problemClassificationId":"/providers/Microsoft.Support/services/quota_service_guid/problemClassifications/sql_datawarehouse_problemClassification_guid","productionOutage":false,"quotaTicketDetails":{"quotaChangeRequestSubType":"DTUs","quotaChangeRequestVersion":"1.0","quotaChangeRequests":[{"payload":"{\"ServerName\":\"testserver\",\"NewLimit\":54000}","region":"EastUS"}]},"require24X7Response":false,"serviceDisplayName":"Service and subscription limits (quotas)","serviceId":"/providers/Microsoft.Support/service