{"files":{"SKILL.md":"---\nname: microsoftsupport\ndescription: \"Microsoft.Support API skill. Use when working with Microsoft.Support for providers, subscriptions. Covers 14 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# Microsoft.Support\nAPI version: 2019-05-01-preview\n\n## Auth\nOAuth2\n\n## Base URL\nhttps://management.azure.com\n\n## Setup\n1. Configure auth: OAuth2\n2. GET /providers/Microsoft.Support/operations -- this lists all the available microsoft support rest api operations.\n3. POST /subscriptions/{subscriptionId}/providers/Microsoft.Support/checkNameAvailability -- create first checkNameAvailability\n\n## Endpoints\n14 endpoints across 2 groups. See references/api-spec.lap for full details.\n\n### Providers\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /providers/Microsoft.Support/operations | This lists all the available Microsoft Support REST API operations. |\n| GET | /providers/Microsoft.Support/services | 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: Issue typeService IdBilling'/providers/Microsoft.Support/services/517f2da6-78fd-0498-4e22-ad26996b1dfc'Subscription Management'/providers/Microsoft.Support/services/f3dc5421-79ef-1efa-41a5-42bf3cbb52c6'Quota'/providers/Microsoft.Support/services/06bfd9d3-516b-d5c6-5802-169c800dec89'  For **Technical** issues, select the Service Id that maps to the Azure service/product as displayed in the **Services** drop-down list on the Azure portal's New support request 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. |\n| GET | /providers/Microsoft.Support/services/{serviceName} | Gets a specific Azure service for support ticket creation. |\n| GET | /providers/Microsoft.Support/services/{serviceName}/problemClassifications | 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. |\n| GET | /providers/Microsoft.Support/services/{serviceName}/problemClassifications/{problemClassificationName} | Gets the details of a specific problem classification for a specific Azure service. |\n\n### Subscriptions\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /subscriptions/{subscriptionId}/providers/Microsoft.Support/checkNameAvailability | 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. |\n| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets | 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 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error. |\n| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName} | Gets details for a specific support ticket in an Azure subscription. Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error. |\n| PATCH | /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName} | 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. |\n| PUT | /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName} | 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. Learn more  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. |\n| POST | /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/checkNameAvailability | 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. |\n| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications | 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 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error. |\n| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName} | Returns details of a specific communication in a support ticket. |\n| PUT | /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName} | 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 Manage support ticket page in the Azure portal, select the support ticket, and use the file upload control to add a new file. |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"List all operations?\" -> GET /providers/Microsoft.Support/operations\n- \"List all services?\" -> GET /providers/Microsoft.Support/services\n- \"Get service details?\" -> GET /providers/Microsoft.Support/services/{serviceName}\n- \"List all problemClassifications?\" -> GET /providers/Microsoft.Support/services/{serviceName}/problemClassifications\n- \"Get problemClassification details?\" -> GET /providers/Microsoft.Support/services/{serviceName}/problemClassifications/{problemClassificationName}\n- \"Create a checkNameAvailability?\" -> POST /subscriptions/{subscriptionId}/providers/Microsoft.Support/checkNameAvailability\n- \"List all supportTickets?\" -> GET /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets\n- \"Get supportTicket details?\" -> GET /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}\n- \"Partially update a supportTicket?\" -> PATCH /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}\n- \"Update a supportTicket?\" -> PUT /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}\n- \"List all communications?\" -> GET /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications\n- \"Get communication details?\" -> GET /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}\n- \"Update a communication?\" -> PUT /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Create/update endpoints return the modified resource on success\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Microsoft.Support\n@base https://management.azure.com\n@version 2019-05-01-preview\n@auth OAuth2\n@common_fields {api-version: any # Api version}\n@endpoints 14\n@toc providers(5), subscriptions(9)\n\n@group providers\n@endpoint GET /providers/Microsoft.Support/operations\n@desc This lists all the available Microsoft Support REST API operations.\n@returns(200) Successfully retrieved list of operations.\n\n@endpoint GET /providers/Microsoft.Support/services\n@desc 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: Issue typeService IdBilling'/providers/Microsoft.Support/services/517f2da6-78fd-0498-4e22-ad26996b1dfc'Subscription Management'/providers/Microsoft.Support/services/f3dc5421-79ef-1efa-41a5-42bf3cbb52c6'Quota'/providers/Microsoft.Support/services/06bfd9d3-516b-d5c6-5802-169c800dec89'  For **Technical** issues, select the Service Id that maps to the Azure service/product as displayed in the **Services** drop-down list on the Azure portal's New support request 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.\n@returns(200) Successfully retrieved list of Azure services available for support.\n\n@endpoint GET /providers/Microsoft.Support/services/{serviceName}\n@desc Gets a specific Azure service for support ticket creation.\n@required {serviceName: any # Name of Azure service}\n@returns(200) Successfully retrieved Azure service for support ticket creation.\n\n@endpoint GET /providers/Microsoft.Support/services/{serviceName}/problemClassifications\n@desc 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.\n@required {serviceName: any # Name of Azure service for which the problem classifications need to be retrieved.}\n@returns(200) Successfully retrieved list of problem classifications for the specified Azure service.\n\n@endpoint GET /providers/Microsoft.Support/services/{serviceName}/problemClassifications/{problemClassificationName}\n@desc Gets the details of a specific problem classification for a specific Azure service.\n@required {serviceName: any # Name of Azure service available for support., problemClassificationName: any # Name of problem classification.}\n@returns(200) Successfully retrieved problem classification details.\n\n@endgroup\n\n@group subscriptions\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.Support/checkNameAvailability\n@desc 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.\n@required {checkNameAvailabilityInput: map # Input to check., subscriptionId: any # Azure subscription id}\n@returns(200) OK. The request has succeeded.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets\n@desc 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 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.\n@required {subscriptionId: any # Azure subscription id}\n@optional {$top: any # The number of values to return in the collection. Default is 25 and max is 100., $filter: any # The filter to apply on the operation. We support 'odata v4.0' filter semantics. Learn more 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'.}\n@returns(200) Successfully retrieved support tickets.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}\n@desc Gets details for a specific support ticket in an Azure subscription. Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.\n@required {supportTicketName: any # Support ticket name, subscriptionId: any # Azure subscription id}\n@returns(200) Successfully retrieved support ticket.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}\n@desc 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.\n@required {supportTicketName: any # Support ticket name, updateSupportTicket: map # UpdateSupportTicket object, subscriptionId: any # Azure subscription id}\n@returns(200) Successfully updated support ticket.\n\n@endpoint PUT /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}\n@desc 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. Learn more  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.\n@required {supportTicketName: any # Support ticket name., createSupportTicketParameters: map # Support ticket request payload., subscriptionId: any # Azure subscription id}\n@returns(200) OK - SupportTicket created successfully\n@returns(202) Accepted, SupportTicket will be created asynchronously\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/checkNameAvailability\n@desc 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.\n@required {supportTicketName: any # Support ticket name, checkNameAvailabilityInput: map # Input to check, subscriptionId: any # Azure subscription id}\n@returns(200) OK. The request has succeeded.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications\n@desc 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 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.\n@required {supportTicketName: any # Support ticket name, subscriptionId: any # Azure subscription id}\n@optional {$top: any # The number of values to return in the collection. Default is 10 and max is 10., $filter: any # 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.}\n@returns(200) Successfully retrieved communications for a support ticket.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}\n@desc Returns details of a specific communication in a support ticket.\n@required {supportTicketName: any # Support ticket name, communicationName: any # Communication name, subscriptionId: any # Azure subscription id}\n@returns(200) Successfully retrieved communication details.\n\n@endpoint PUT /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}\n@desc 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 Manage support ticket page in the Azure portal, select the support ticket, and use the file upload control to add a new file.\n@required {supportTicketName: any # Support ticket name, communicationName: any # Communication name, createCommunicationParameters: map # Communication object, subscriptionId: any # Azure subscription id}\n@returns(200) OK - Communication created successfully.\n@returns(202) Accepted, Communication will be created asynchronously\n\n@endgroup\n\n@end\n"}}