Microsoft.Support (stable:2024-04-01)

2025/09/12 • 39 new, 39 deleted methods

SupportTicketsNoSubscription_CheckNameAvailability (new)
Description :  Check the availability of a resource name. This API should be used to check the uniqueness of the name for support ticket creation for the selected subscription.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Support/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
checkNameAvailabilityInput:
{
Description: The request body ,
Required: True ,
}
{
name:
{
Description: The resource name to validate. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource. ,
Enum:
{
Microsoft.Support/supportTickets: No description available. ,
Microsoft.Support/communications: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates whether the name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the name is not available. ,
Required: False ,
}
string ,
message:
{
Description: The detailed error message describing why the name is not available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileWorkspacesNoSubscription_Get (new)
Description :  Gets details for a specific file workspace.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when file workspace is going to expire. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileWorkspacesNoSubscription_Create (new)
Description :  Creates a new file workspace.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when file workspace is going to expire. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FilesNoSubscription_List (new)
Description :  Lists all the Files information under a workspace for an Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: [Placeholder] Description for nextLink property ,
Required: False ,
}
string ,
value:
{
Description: [Placeholder] Description for value property ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
chunkSize:
{
Description: Size of each chunk. The size of each chunk should be provided in bytes and must not exceed 2.5 megabytes (MB). ,
Format: int32 ,
Required: False ,
}
integer ,
fileSize:
{
Description: Size of the file to be uploaded. The file size must not exceed 5 MB and should be provided in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfChunks:
{
Description: Number of chunks to be uploaded. The maximum number of allowed chunks is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FilesNoSubscription_Get (new)
Description :  Returns details of a specific file in a work space.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
fileName:
{
Description: The name of the FileDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
chunkSize:
{
Description: Size of each chunk. The size of each chunk should be provided in bytes and must not exceed 2.5 megabytes (MB). ,
Format: int32 ,
Required: False ,
}
integer ,
fileSize:
{
Description: Size of the file to be uploaded. The file size must not exceed 5 MB and should be provided in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfChunks:
{
Description: Number of chunks to be uploaded. The maximum number of allowed chunks is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FilesNoSubscription_Create (new)
Description :  Creates a new file under a workspace.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
fileName:
{
Description: The name of the FileDetails ,
Required: True ,
}
string ,
createFileParameters:
{
Description: Create file object ,
Required: True ,
}
{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
chunkSize:
{
Description: Size of each chunk. The size of each chunk should be provided in bytes and must not exceed 2.5 megabytes (MB). ,
Format: int32 ,
Required: False ,
}
integer ,
fileSize:
{
Description: Size of the file to be uploaded. The file size must not exceed 5 MB and should be provided in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfChunks:
{
Description: Number of chunks to be uploaded. The maximum number of allowed chunks is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
chunkSize:
{
Description: Size of each chunk. The size of each chunk should be provided in bytes and must not exceed 2.5 megabytes (MB). ,
Format: int32 ,
Required: False ,
}
integer ,
fileSize:
{
Description: Size of the file to be uploaded. The file size must not exceed 5 MB and should be provided in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfChunks:
{
Description: Number of chunks to be uploaded. The maximum number of allowed chunks is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FilesNoSubscription_Upload (new)
Description :  This API allows you to upload content to a file
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}/upload
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
fileName:
{
Description: The name of the FileDetails ,
Required: True ,
}
string ,
uploadFile:
{
Description: UploadFile object ,
Required: True ,
}
{
content:
{
Description: File Content in base64 encoded format ,
Required: False ,
}
string ,
chunkIndex:
{
Description: Index of the uploaded chunk (Index starts at 0) ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Services_List (new)
Description :  Lists all the Azure services available for support ticket creation. For **Technical** issues, select the Service Id that maps to the Azure service/product as displayed in the **Services** drop-down list on the Azure portal's [New support request](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/overview) page. Always use the service and its corresponding problem classification(s) obtained programmatically for support ticket creation. This practice ensures that you always have the most recent set of service and problem classification Ids.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/services
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of items ,
Required: False ,
}
string ,
value:
{
Description: List of Service resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the resource. ,
Required: False ,
}
{
displayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: ARM Resource types. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Services_Get (new)
Description :  Gets a specific Azure service for support ticket creation.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/services/{serviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
serviceName:
{
Description: Name of the Azure service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: False ,
}
{
displayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: ARM Resource types. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProblemClassifications_List (new)
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.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/services/{serviceName}/problemClassifications
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
serviceName:
{
Description: Name of the Azure service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of items ,
Required: False ,
}
string ,
value:
{
Description: List of ProblemClassification resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the resource. ,
Required: False ,
}
{
displayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
secondaryConsentEnabled:
{
Description: This property indicates whether secondary consent is present for problem classification ,
Required: False ,
}
[
{
description:
{
Description: User consent description. ,
Required: False ,
}
string ,
type:
{
Description: The Azure service for which secondary consent is needed for case creation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProblemClassifications_Get (new)
Description :  Get problem classification details for a specific Azure service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/services/{serviceName}/problemClassifications/{problemClassificationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
serviceName:
{
Description: Name of the Azure service. ,
Required: True ,
}
string ,
problemClassificationName:
{
Description: Name of problem classification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: False ,
}
{
displayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
secondaryConsentEnabled:
{
Description: This property indicates whether secondary consent is present for problem classification ,
Required: False ,
}
[
{
description:
{
Description: User consent description. ,
Required: False ,
}
string ,
type:
{
Description: The Azure service for which secondary consent is needed for case creation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SupportTicketsNoSubscription_List (new)
Description :  Lists all the support tickets.

You can also filter the support tickets by Status, CreatedDate, , ServiceId, and ProblemClassificationId 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.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/supportTickets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$top:
{
Description: The number of values to return in the collection. Default is 25 and max is 100. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply on the operation. We support 'odata v4.0' filter semantics. Learn more
Status , ServiceId, and ProblemClassificationId filters 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'. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: [Placeholder] Description for nextLink property ,
Required: False ,
}
string ,
value:
{
Description: [Placeholder] Description for value property ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
supportTicketId:
{
Description: System generated support ticket Id that is unique. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the question or issue. ,
Required: True ,
}
string ,
problemClassificationId:
{
Description: Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. ,
Required: True ,
}
string ,
problemClassificationDisplayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
severity:
{
Description: A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: True ,
}
enum ,
enrollmentId:
{
Description: Enrollment Id associated with the support ticket. ,
Required: False ,
}
string ,
require24X7Response:
{
Description: Indicates if this requires a 24x7 response from Azure. ,
Required: False ,
}
boolean ,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: True ,
}
enum ,
problemScopingQuestions:
{
Description: Problem scoping questions associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanId:
{
Description: Support plan id associated with the support ticket. ,
Required: False ,
}
string ,
contactDetails:
{
Description: Contact information of the user requesting to create a support ticket. ,
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: True ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: True ,
}
string ,
additionalEmailAddresses:
{
Description: Additional email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: True ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: True ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: True ,
}
string ,
}
,
serviceLevelAgreement:
{
Description: Service Level Agreement information for this support ticket. ,
Required: False ,
}
{
startTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement starts. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
slaMinutes:
{
Description: Service Level Agreement in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportEngineer:
{
Description: Information about the support engineer working on this support ticket. ,
Required: False ,
}
{
emailAddress:
{
Description: Email address of the Azure Support engineer assigned to the support ticket. ,
Required: False ,
}
string ,
}
,
supportPlanType:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanDisplayName:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
title:
{
Description: Title of the support ticket. ,
Required: True ,
}
string ,
problemStartTime:
{
Description: Time in UTC (ISO 8601 format) when the problem started. ,
Format: date-time ,
Required: False ,
}
string ,
serviceId:
{
Description: This is the resource Id of the Azure service resource associated with the support ticket. ,
Required: True ,
}
string ,
serviceDisplayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
status:
{
Description: Status of the support ticket. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
fileWorkspaceName:
{
Description: File workspace name. ,
Required: False ,
}
string ,
isTemporaryTicket:
{
Description: This property indicates if support ticket is a temporary ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
technicalTicketDetails:
{
Description: Additional ticket details associated with a technical support ticket request. ,
Required: False ,
}
{
resourceId:
{
Description: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. ,
Required: False ,
}
string ,
}
,
quotaTicketDetails:
{
Description: Additional ticket details associated with a quota support ticket request. ,
Required: False ,
}
{
quotaChangeRequestSubType:
{
Description: Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. ,
Required: False ,
}
string ,
quotaChangeRequestVersion:
{
Description: Quota change request version. ,
Required: False ,
}
string ,
quotaChangeRequests:
{
Description: This property is required for providing the region and new quota limits. ,
Required: False ,
}
[
{
region:
{
Description: Region for which the quota increase request is being made. ,
Required: False ,
}
string ,
payload:
{
Description: Payload of the quota increase request. ,
Required: False ,
}
string ,
}
,
]
,
}
,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SupportTicketsNoSubscription_Get (new)
Description :  Gets details for a specific support ticket. 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.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/supportTickets/{supportTicketName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
supportTicketId:
{
Description: System generated support ticket Id that is unique. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the question or issue. ,
Required: True ,
}
string ,
problemClassificationId:
{
Description: Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. ,
Required: True ,
}
string ,
problemClassificationDisplayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
severity:
{
Description: A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: True ,
}
enum ,
enrollmentId:
{
Description: Enrollment Id associated with the support ticket. ,
Required: False ,
}
string ,
require24X7Response:
{
Description: Indicates if this requires a 24x7 response from Azure. ,
Required: False ,
}
boolean ,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: True ,
}
enum ,
problemScopingQuestions:
{
Description: Problem scoping questions associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanId:
{
Description: Support plan id associated with the support ticket. ,
Required: False ,
}
string ,
contactDetails:
{
Description: Contact information of the user requesting to create a support ticket. ,
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: True ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: True ,
}
string ,
additionalEmailAddresses:
{
Description: Additional email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: True ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: True ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: True ,
}
string ,
}
,
serviceLevelAgreement:
{
Description: Service Level Agreement information for this support ticket. ,
Required: False ,
}
{
startTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement starts. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
slaMinutes:
{
Description: Service Level Agreement in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportEngineer:
{
Description: Information about the support engineer working on this support ticket. ,
Required: False ,
}
{
emailAddress:
{
Description: Email address of the Azure Support engineer assigned to the support ticket. ,
Required: False ,
}
string ,
}
,
supportPlanType:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanDisplayName:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
title:
{
Description: Title of the support ticket. ,
Required: True ,
}
string ,
problemStartTime:
{
Description: Time in UTC (ISO 8601 format) when the problem started. ,
Format: date-time ,
Required: False ,
}
string ,
serviceId:
{
Description: This is the resource Id of the Azure service resource associated with the support ticket. ,
Required: True ,
}
string ,
serviceDisplayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
status:
{
Description: Status of the support ticket. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
fileWorkspaceName:
{
Description: File workspace name. ,
Required: False ,
}
string ,
isTemporaryTicket:
{
Description: This property indicates if support ticket is a temporary ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
technicalTicketDetails:
{
Description: Additional ticket details associated with a technical support ticket request. ,
Required: False ,
}
{
resourceId:
{
Description: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. ,
Required: False ,
}
string ,
}
,
quotaTicketDetails:
{
Description: Additional ticket details associated with a quota support ticket request. ,
Required: False ,
}
{
quotaChangeRequestSubType:
{
Description: Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. ,
Required: False ,
}
string ,
quotaChangeRequestVersion:
{
Description: Quota change request version. ,
Required: False ,
}
string ,
quotaChangeRequests:
{
Description: This property is required for providing the region and new quota limits. ,
Required: False ,
}
[
{
region:
{
Description: Region for which the quota increase request is being made. ,
Required: False ,
}
string ,
payload:
{
Description: Payload of the quota increase request. ,
Required: False ,
}
string ,
}
,
]
,
}
,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SupportTicketsNoSubscription_Create (new)
Description :  Creates a new support ticket for Billing, and Subscription Management issues. Learn the [prerequisites](https://aka.ms/supportAPI) required to create a support ticket.

Always call the Services and ProblemClassifications API to get the most recent set of services and problem categories required for support ticket creation.

Adding attachments is not currently supported via the API. To add a file to an existing support ticket, visit the [Manage support ticket](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/managesupportrequest) page in the Azure portal, select the support ticket, and use the file upload control to add a new file.

Providing consent to share diagnostic information with Azure support is currently not supported via the API. The Azure support engineer working on your ticket will reach out to you for consent if your issue requires gathering diagnostic information from your Azure resources.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Support/supportTickets/{supportTicketName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
createSupportTicketParameters:
{
Description: Support ticket request payload. ,
Required: True ,
}
{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
supportTicketId:
{
Description: System generated support ticket Id that is unique. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the question or issue. ,
Required: True ,
}
string ,
problemClassificationId:
{
Description: Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. ,
Required: True ,
}
string ,
problemClassificationDisplayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
severity:
{
Description: A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: True ,
}
enum ,
enrollmentId:
{
Description: Enrollment Id associated with the support ticket. ,
Required: False ,
}
string ,
require24X7Response:
{
Description: Indicates if this requires a 24x7 response from Azure. ,
Required: False ,
}
boolean ,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: True ,
}
enum ,
problemScopingQuestions:
{
Description: Problem scoping questions associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanId:
{
Description: Support plan id associated with the support ticket. ,
Required: False ,
}
string ,
contactDetails:
{
Description: Contact information of the user requesting to create a support ticket. ,
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: True ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: True ,
}
string ,
additionalEmailAddresses:
{
Description: Additional email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: True ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: True ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: True ,
}
string ,
}
,
serviceLevelAgreement:
{
Description: Service Level Agreement information for this support ticket. ,
Required: False ,
}
{
startTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement starts. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
slaMinutes:
{
Description: Service Level Agreement in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportEngineer:
{
Description: Information about the support engineer working on this support ticket. ,
Required: False ,
}
{
emailAddress:
{
Description: Email address of the Azure Support engineer assigned to the support ticket. ,
Required: False ,
}
string ,
}
,
supportPlanType:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanDisplayName:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
title:
{
Description: Title of the support ticket. ,
Required: True ,
}
string ,
problemStartTime:
{
Description: Time in UTC (ISO 8601 format) when the problem started. ,
Format: date-time ,
Required: False ,
}
string ,
serviceId:
{
Description: This is the resource Id of the Azure service resource associated with the support ticket. ,
Required: True ,
}
string ,
serviceDisplayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
status:
{
Description: Status of the support ticket. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
fileWorkspaceName:
{
Description: File workspace name. ,
Required: False ,
}
string ,
isTemporaryTicket:
{
Description: This property indicates if support ticket is a temporary ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
technicalTicketDetails:
{
Description: Additional ticket details associated with a technical support ticket request. ,
Required: False ,
}
{
resourceId:
{
Description: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. ,
Required: False ,
}
string ,
}
,
quotaTicketDetails:
{
Description: Additional ticket details associated with a quota support ticket request. ,
Required: False ,
}
{
quotaChangeRequestSubType:
{
Description: Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. ,
Required: False ,
}
string ,
quotaChangeRequestVersion:
{
Description: Quota change request version. ,
Required: False ,
}
string ,
quotaChangeRequests:
{
Description: This property is required for providing the region and new quota limits. ,
Required: False ,
}
[
{
region:
{
Description: Region for which the quota increase request is being made. ,
Required: False ,
}
string ,
payload:
{
Description: Payload of the quota increase request. ,
Required: False ,
}
string ,
}
,
]
,
}
,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
supportTicketId:
{
Description: System generated support ticket Id that is unique. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the question or issue. ,
Required: True ,
}
string ,
problemClassificationId:
{
Description: Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. ,
Required: True ,
}
string ,
problemClassificationDisplayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
severity:
{
Description: A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: True ,
}
enum ,
enrollmentId:
{
Description: Enrollment Id associated with the support ticket. ,
Required: False ,
}
string ,
require24X7Response:
{
Description: Indicates if this requires a 24x7 response from Azure. ,
Required: False ,
}
boolean ,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: True ,
}
enum ,
problemScopingQuestions:
{
Description: Problem scoping questions associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanId:
{
Description: Support plan id associated with the support ticket. ,
Required: False ,
}
string ,
contactDetails:
{
Description: Contact information of the user requesting to create a support ticket. ,
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: True ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: True ,
}
string ,
additionalEmailAddresses:
{
Description: Additional email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: True ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: True ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: True ,
}
string ,
}
,
serviceLevelAgreement:
{
Description: Service Level Agreement information for this support ticket. ,
Required: False ,
}
{
startTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement starts. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
slaMinutes:
{
Description: Service Level Agreement in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportEngineer:
{
Description: Information about the support engineer working on this support ticket. ,
Required: False ,
}
{
emailAddress:
{
Description: Email address of the Azure Support engineer assigned to the support ticket. ,
Required: False ,
}
string ,
}
,
supportPlanType:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanDisplayName:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
title:
{
Description: Title of the support ticket. ,
Required: True ,
}
string ,
problemStartTime:
{
Description: Time in UTC (ISO 8601 format) when the problem started. ,
Format: date-time ,
Required: False ,
}
string ,
serviceId:
{
Description: This is the resource Id of the Azure service resource associated with the support ticket. ,
Required: True ,
}
string ,
serviceDisplayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
status:
{
Description: Status of the support ticket. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
fileWorkspaceName:
{
Description: File workspace name. ,
Required: False ,
}
string ,
isTemporaryTicket:
{
Description: This property indicates if support ticket is a temporary ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
technicalTicketDetails:
{
Description: Additional ticket details associated with a technical support ticket request. ,
Required: False ,
}
{
resourceId:
{
Description: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. ,
Required: False ,
}
string ,
}
,
quotaTicketDetails:
{
Description: Additional ticket details associated with a quota support ticket request. ,
Required: False ,
}
{
quotaChangeRequestSubType:
{
Description: Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. ,
Required: False ,
}
string ,
quotaChangeRequestVersion:
{
Description: Quota change request version. ,
Required: False ,
}
string ,
quotaChangeRequests:
{
Description: This property is required for providing the region and new quota limits. ,
Required: False ,
}
[
{
region:
{
Description: Region for which the quota increase request is being made. ,
Required: False ,
}
string ,
payload:
{
Description: Payload of the quota increase request. ,
Required: False ,
}
string ,
}
,
]
,
}
,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SupportTicketsNoSubscription_Update (new)
Description :  This API allows you to update the severity level, ticket status, and 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.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Support/supportTickets/{supportTicketName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
updateSupportTicket:
{
Description: UpdateSupportTicket object. ,
Required: True ,
}
{
severity:
{
Description: Severity level. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status to be updated on the ticket. ,
Enum:
{
open: No description available. ,
closed: No description available. ,
}
,
Required: False ,
}
enum ,
contactDetails:
{
Description: Contact details to be updated on the support ticket. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: False ,
}
string ,
additionalEmailAddresses:
{
Description: Email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: False ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: False ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response/). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: False ,
}
string ,
}
,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
supportTicketId:
{
Description: System generated support ticket Id that is unique. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the question or issue. ,
Required: True ,
}
string ,
problemClassificationId:
{
Description: Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. ,
Required: True ,
}
string ,
problemClassificationDisplayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
severity:
{
Description: A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: True ,
}
enum ,
enrollmentId:
{
Description: Enrollment Id associated with the support ticket. ,
Required: False ,
}
string ,
require24X7Response:
{
Description: Indicates if this requires a 24x7 response from Azure. ,
Required: False ,
}
boolean ,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: True ,
}
enum ,
problemScopingQuestions:
{
Description: Problem scoping questions associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanId:
{
Description: Support plan id associated with the support ticket. ,
Required: False ,
}
string ,
contactDetails:
{
Description: Contact information of the user requesting to create a support ticket. ,
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: True ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: True ,
}
string ,
additionalEmailAddresses:
{
Description: Additional email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: True ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: True ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: True ,
}
string ,
}
,
serviceLevelAgreement:
{
Description: Service Level Agreement information for this support ticket. ,
Required: False ,
}
{
startTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement starts. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
slaMinutes:
{
Description: Service Level Agreement in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportEngineer:
{
Description: Information about the support engineer working on this support ticket. ,
Required: False ,
}
{
emailAddress:
{
Description: Email address of the Azure Support engineer assigned to the support ticket. ,
Required: False ,
}
string ,
}
,
supportPlanType:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanDisplayName:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
title:
{
Description: Title of the support ticket. ,
Required: True ,
}
string ,
problemStartTime:
{
Description: Time in UTC (ISO 8601 format) when the problem started. ,
Format: date-time ,
Required: False ,
}
string ,
serviceId:
{
Description: This is the resource Id of the Azure service resource associated with the support ticket. ,
Required: True ,
}
string ,
serviceDisplayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
status:
{
Description: Status of the support ticket. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
fileWorkspaceName:
{
Description: File workspace name. ,
Required: False ,
}
string ,
isTemporaryTicket:
{
Description: This property indicates if support ticket is a temporary ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
technicalTicketDetails:
{
Description: Additional ticket details associated with a technical support ticket request. ,
Required: False ,
}
{
resourceId:
{
Description: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. ,
Required: False ,
}
string ,
}
,
quotaTicketDetails:
{
Description: Additional ticket details associated with a quota support ticket request. ,
Required: False ,
}
{
quotaChangeRequestSubType:
{
Description: Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. ,
Required: False ,
}
string ,
quotaChangeRequestVersion:
{
Description: Quota change request version. ,
Required: False ,
}
string ,
quotaChangeRequests:
{
Description: This property is required for providing the region and new quota limits. ,
Required: False ,
}
[
{
region:
{
Description: Region for which the quota increase request is being made. ,
Required: False ,
}
string ,
payload:
{
Description: Payload of the quota increase request. ,
Required: False ,
}
string ,
}
,
]
,
}
,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ChatTranscriptsNoSubscription_List (new)
Description :  Lists all chat transcripts for a support ticket
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/supportTickets/{supportTicketName}/chatTranscripts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: [Placeholder] Description for nextLink property ,
Required: False ,
}
string ,
value:
{
Description: [Placeholder] Description for value property ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the resource. ,
Required: False ,
}
{
messages:
{
Description: List of chat transcript communication resources. ,
Required: False ,
}
[
{
contentType:
{
Description: Content type. ,
Required: False ,
}
string ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Name of the sender. ,
Required: False ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: Time in UTC (ISO 8601 format) when the chat began. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ChatTranscriptsNoSubscription_Get (new)
Description :  Returns chatTranscript details for a no subscription support ticket.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/supportTickets/{supportTicketName}/chatTranscripts/{chatTranscriptName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
chatTranscriptName:
{
Description: The name of the ChatTranscriptDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: False ,
}
{
messages:
{
Description: List of chat transcript communication resources. ,
Required: False ,
}
[
{
contentType:
{
Description: Content type. ,
Required: False ,
}
string ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Name of the sender. ,
Required: False ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: Time in UTC (ISO 8601 format) when the chat began. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CommunicationsNoSubscription_CheckNameAvailability (new)
Description :  Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication to the support ticket.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Support/supportTickets/{supportTicketName}/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
checkNameAvailabilityInput:
{
Description: Input to check. ,
Required: True ,
}
{
name:
{
Description: The resource name to validate. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource. ,
Enum:
{
Microsoft.Support/supportTickets: No description available. ,
Microsoft.Support/communications: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates whether the name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the name is not available. ,
Required: False ,
}
string ,
message:
{
Description: The detailed error message describing why the name is not available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CommunicationsNoSubscription_List (new)
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 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/supportTickets/{supportTicketName}/communications
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
$top:
{
Description: The number of values to return in the collection. Default is 10 and max is 10. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: [Placeholder] Description for nextLink property ,
Required: False ,
}
string ,
value:
{
Description: [Placeholder] Description for value property ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
communicationType:
{
Description: Communication type. ,
Enum:
{
web: No description available. ,
phone: No description available. ,
}
,
Required: False ,
}
enum ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Email address of the sender. This property is required if called by a service principal. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the communication. ,
Required: True ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: True ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CommunicationsNoSubscription_Get (new)
Description :  Returns communication details for a support ticket.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
communicationName:
{
Description: The name of the CommunicationDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
communicationType:
{
Description: Communication type. ,
Enum:
{
web: No description available. ,
phone: No description available. ,
}
,
Required: False ,
}
enum ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Email address of the sender. This property is required if called by a service principal. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the communication. ,
Required: True ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: True ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CommunicationsNoSubscription_Create (new)
Description :  Adds a new customer communication to an Azure support ticket.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
communicationName:
{
Description: The name of the CommunicationDetails ,
Required: True ,
}
string ,
createCommunicationParameters:
{
Description: Communication object. ,
Required: True ,
}
{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
communicationType:
{
Description: Communication type. ,
Enum:
{
web: No description available. ,
phone: No description available. ,
}
,
Required: False ,
}
enum ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Email address of the sender. This property is required if called by a service principal. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the communication. ,
Required: True ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: True ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
communicationType:
{
Description: Communication type. ,
Enum:
{
web: No description available. ,
phone: No description available. ,
}
,
Required: False ,
}
enum ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Email address of the sender. This property is required if called by a service principal. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the communication. ,
Required: True ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: True ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SupportTickets_CheckNameAvailability (new)
Description :  Check the availability of a resource name. This API should be used to check the uniqueness of the name for support ticket creation for the selected subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
checkNameAvailabilityInput:
{
Description: The request body ,
Required: True ,
}
{
name:
{
Description: The resource name to validate. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource. ,
Enum:
{
Microsoft.Support/supportTickets: No description available. ,
Microsoft.Support/communications: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates whether the name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the name is not available. ,
Required: False ,
}
string ,
message:
{
Description: The detailed error message describing why the name is not available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileWorkspaces_Get (new)
Description :  Gets details for a specific file workspace in an Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when file workspace is going to expire. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileWorkspaces_Create (new)
Description :  Creates a new file workspace for the specified subscription.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when file workspace is going to expire. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Files_List (new)
Description :  Lists all the Files information under a workspace for an Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: [Placeholder] Description for nextLink property ,
Required: False ,
}
string ,
value:
{
Description: [Placeholder] Description for value property ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
chunkSize:
{
Description: Size of each chunk. The size of each chunk should be provided in bytes and must not exceed 2.5 megabytes (MB). ,
Format: int32 ,
Required: False ,
}
integer ,
fileSize:
{
Description: Size of the file to be uploaded. The file size must not exceed 5 MB and should be provided in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfChunks:
{
Description: Number of chunks to be uploaded. The maximum number of allowed chunks is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Files_Get (new)
Description :  Returns details of a specific file in a work space.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
fileName:
{
Description: The name of the FileDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
chunkSize:
{
Description: Size of each chunk. The size of each chunk should be provided in bytes and must not exceed 2.5 megabytes (MB). ,
Format: int32 ,
Required: False ,
}
integer ,
fileSize:
{
Description: Size of the file to be uploaded. The file size must not exceed 5 MB and should be provided in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfChunks:
{
Description: Number of chunks to be uploaded. The maximum number of allowed chunks is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Files_Create (new)
Description :  Creates a new file under a workspace for the specified subscription.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
fileName:
{
Description: The name of the FileDetails ,
Required: True ,
}
string ,
createFileParameters:
{
Description: Create file object ,
Required: True ,
}
{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
chunkSize:
{
Description: Size of each chunk. The size of each chunk should be provided in bytes and must not exceed 2.5 megabytes (MB). ,
Format: int32 ,
Required: False ,
}
integer ,
fileSize:
{
Description: Size of the file to be uploaded. The file size must not exceed 5 MB and should be provided in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfChunks:
{
Description: Number of chunks to be uploaded. The maximum number of allowed chunks is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
chunkSize:
{
Description: Size of each chunk. The size of each chunk should be provided in bytes and must not exceed 2.5 megabytes (MB). ,
Format: int32 ,
Required: False ,
}
integer ,
fileSize:
{
Description: Size of the file to be uploaded. The file size must not exceed 5 MB and should be provided in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfChunks:
{
Description: Number of chunks to be uploaded. The maximum number of allowed chunks is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Files_Upload (new)
Description :  This API allows you to upload content to a file
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}/upload
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
fileName:
{
Description: The name of the FileDetails ,
Required: True ,
}
string ,
uploadFile:
{
Description: UploadFile object ,
Required: True ,
}
{
content:
{
Description: File Content in base64 encoded format ,
Required: False ,
}
string ,
chunkIndex:
{
Description: Index of the uploaded chunk (Index starts at 0) ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SupportTickets_List (new)
Description :  Lists all the support tickets for an Azure subscription. You can also filter the support tickets by _Status_, _CreatedDate_, _ServiceId_, and _ProblemClassificationId_ 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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$top:
{
Description: The number of values to return in the collection. Default is 25 and max is 100. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply on the operation. We support 'odata v4.0' filter semantics. [Learn more](https://docs.microsoft.com/odata/concepts/queryoptions-overview). _Status_, _ServiceId_, and _ProblemClassificationId_ filters can only be used with Equals ('eq') operator. For _CreatedDate_ filter, the supported operators are Greater Than ('gt') and Greater Than or Equals ('ge'). When using both filters, combine them using the logical 'AND'. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: [Placeholder] Description for nextLink property ,
Required: False ,
}
string ,
value:
{
Description: [Placeholder] Description for value property ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
supportTicketId:
{
Description: System generated support ticket Id that is unique. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the question or issue. ,
Required: True ,
}
string ,
problemClassificationId:
{
Description: Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. ,
Required: True ,
}
string ,
problemClassificationDisplayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
severity:
{
Description: A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: True ,
}
enum ,
enrollmentId:
{
Description: Enrollment Id associated with the support ticket. ,
Required: False ,
}
string ,
require24X7Response:
{
Description: Indicates if this requires a 24x7 response from Azure. ,
Required: False ,
}
boolean ,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: True ,
}
enum ,
problemScopingQuestions:
{
Description: Problem scoping questions associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanId:
{
Description: Support plan id associated with the support ticket. ,
Required: False ,
}
string ,
contactDetails:
{
Description: Contact information of the user requesting to create a support ticket. ,
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: True ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: True ,
}
string ,
additionalEmailAddresses:
{
Description: Additional email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: True ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: True ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: True ,
}
string ,
}
,
serviceLevelAgreement:
{
Description: Service Level Agreement information for this support ticket. ,
Required: False ,
}
{
startTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement starts. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
slaMinutes:
{
Description: Service Level Agreement in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportEngineer:
{
Description: Information about the support engineer working on this support ticket. ,
Required: False ,
}
{
emailAddress:
{
Description: Email address of the Azure Support engineer assigned to the support ticket. ,
Required: False ,
}
string ,
}
,
supportPlanType:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanDisplayName:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
title:
{
Description: Title of the support ticket. ,
Required: True ,
}
string ,
problemStartTime:
{
Description: Time in UTC (ISO 8601 format) when the problem started. ,
Format: date-time ,
Required: False ,
}
string ,
serviceId:
{
Description: This is the resource Id of the Azure service resource associated with the support ticket. ,
Required: True ,
}
string ,
serviceDisplayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
status:
{
Description: Status of the support ticket. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
fileWorkspaceName:
{
Description: File workspace name. ,
Required: False ,
}
string ,
isTemporaryTicket:
{
Description: This property indicates if support ticket is a temporary ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
technicalTicketDetails:
{
Description: Additional ticket details associated with a technical support ticket request. ,
Required: False ,
}
{
resourceId:
{
Description: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. ,
Required: False ,
}
string ,
}
,
quotaTicketDetails:
{
Description: Additional ticket details associated with a quota support ticket request. ,
Required: False ,
}
{
quotaChangeRequestSubType:
{
Description: Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. ,
Required: False ,
}
string ,
quotaChangeRequestVersion:
{
Description: Quota change request version. ,
Required: False ,
}
string ,
quotaChangeRequests:
{
Description: This property is required for providing the region and new quota limits. ,
Required: False ,
}
[
{
region:
{
Description: Region for which the quota increase request is being made. ,
Required: False ,
}
string ,
payload:
{
Description: Payload of the quota increase request. ,
Required: False ,
}
string ,
}
,
]
,
}
,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SupportTickets_Get (new)
Description :  Get ticket details for 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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
supportTicketId:
{
Description: System generated support ticket Id that is unique. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the question or issue. ,
Required: True ,
}
string ,
problemClassificationId:
{
Description: Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. ,
Required: True ,
}
string ,
problemClassificationDisplayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
severity:
{
Description: A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: True ,
}
enum ,
enrollmentId:
{
Description: Enrollment Id associated with the support ticket. ,
Required: False ,
}
string ,
require24X7Response:
{
Description: Indicates if this requires a 24x7 response from Azure. ,
Required: False ,
}
boolean ,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: True ,
}
enum ,
problemScopingQuestions:
{
Description: Problem scoping questions associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanId:
{
Description: Support plan id associated with the support ticket. ,
Required: False ,
}
string ,
contactDetails:
{
Description: Contact information of the user requesting to create a support ticket. ,
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: True ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: True ,
}
string ,
additionalEmailAddresses:
{
Description: Additional email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: True ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: True ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: True ,
}
string ,
}
,
serviceLevelAgreement:
{
Description: Service Level Agreement information for this support ticket. ,
Required: False ,
}
{
startTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement starts. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
slaMinutes:
{
Description: Service Level Agreement in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportEngineer:
{
Description: Information about the support engineer working on this support ticket. ,
Required: False ,
}
{
emailAddress:
{
Description: Email address of the Azure Support engineer assigned to the support ticket. ,
Required: False ,
}
string ,
}
,
supportPlanType:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanDisplayName:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
title:
{
Description: Title of the support ticket. ,
Required: True ,
}
string ,
problemStartTime:
{
Description: Time in UTC (ISO 8601 format) when the problem started. ,
Format: date-time ,
Required: False ,
}
string ,
serviceId:
{
Description: This is the resource Id of the Azure service resource associated with the support ticket. ,
Required: True ,
}
string ,
serviceDisplayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
status:
{
Description: Status of the support ticket. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
fileWorkspaceName:
{
Description: File workspace name. ,
Required: False ,
}
string ,
isTemporaryTicket:
{
Description: This property indicates if support ticket is a temporary ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
technicalTicketDetails:
{
Description: Additional ticket details associated with a technical support ticket request. ,
Required: False ,
}
{
resourceId:
{
Description: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. ,
Required: False ,
}
string ,
}
,
quotaTicketDetails:
{
Description: Additional ticket details associated with a quota support ticket request. ,
Required: False ,
}
{
quotaChangeRequestSubType:
{
Description: Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. ,
Required: False ,
}
string ,
quotaChangeRequestVersion:
{
Description: Quota change request version. ,
Required: False ,
}
string ,
quotaChangeRequests:
{
Description: This property is required for providing the region and new quota limits. ,
Required: False ,
}
[
{
region:
{
Description: Region for which the quota increase request is being made. ,
Required: False ,
}
string ,
payload:
{
Description: Payload of the quota increase request. ,
Required: False ,
}
string ,
}
,
]
,
}
,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SupportTickets_Create (new)
Description :  Creates a new support ticket for Subscription and Service limits (Quota), Technical, Billing, and Subscription Management issues for the specified subscription. Learn the [prerequisites](https://aka.ms/supportAPI) required to create a support ticket.

Always call the Services and ProblemClassifications API to get the most recent set of services and problem categories required for support ticket creation.

Adding attachments is not currently supported via the API. To add a file to an existing support ticket, visit the [Manage support ticket](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/managesupportrequest) page in the Azure portal, select the support ticket, and use the file upload control to add a new file.

Providing consent to share diagnostic information with Azure support is currently not supported via the API. The Azure support engineer working on your ticket will reach out to you for consent if your issue requires gathering diagnostic information from your Azure resources.

**Creating a support ticket for on-behalf-of**: Include _x-ms-authorization-auxiliary_ header to provide an auxiliary token as per [documentation](https://docs.microsoft.com/azure/azure-resource-manager/management/authenticate-multi-tenant). The primary token will be from the tenant for whom a support ticket is being raised against the subscription, i.e. Cloud solution provider (CSP) customer tenant. The auxiliary token will be from the Cloud solution provider (CSP) partner tenant.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
createSupportTicketParameters:
{
Description: Support ticket request payload. ,
Required: True ,
}
{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
supportTicketId:
{
Description: System generated support ticket Id that is unique. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the question or issue. ,
Required: True ,
}
string ,
problemClassificationId:
{
Description: Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. ,
Required: True ,
}
string ,
problemClassificationDisplayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
severity:
{
Description: A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: True ,
}
enum ,
enrollmentId:
{
Description: Enrollment Id associated with the support ticket. ,
Required: False ,
}
string ,
require24X7Response:
{
Description: Indicates if this requires a 24x7 response from Azure. ,
Required: False ,
}
boolean ,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: True ,
}
enum ,
problemScopingQuestions:
{
Description: Problem scoping questions associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanId:
{
Description: Support plan id associated with the support ticket. ,
Required: False ,
}
string ,
contactDetails:
{
Description: Contact information of the user requesting to create a support ticket. ,
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: True ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: True ,
}
string ,
additionalEmailAddresses:
{
Description: Additional email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: True ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: True ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: True ,
}
string ,
}
,
serviceLevelAgreement:
{
Description: Service Level Agreement information for this support ticket. ,
Required: False ,
}
{
startTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement starts. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
slaMinutes:
{
Description: Service Level Agreement in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportEngineer:
{
Description: Information about the support engineer working on this support ticket. ,
Required: False ,
}
{
emailAddress:
{
Description: Email address of the Azure Support engineer assigned to the support ticket. ,
Required: False ,
}
string ,
}
,
supportPlanType:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanDisplayName:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
title:
{
Description: Title of the support ticket. ,
Required: True ,
}
string ,
problemStartTime:
{
Description: Time in UTC (ISO 8601 format) when the problem started. ,
Format: date-time ,
Required: False ,
}
string ,
serviceId:
{
Description: This is the resource Id of the Azure service resource associated with the support ticket. ,
Required: True ,
}
string ,
serviceDisplayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
status:
{
Description: Status of the support ticket. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
fileWorkspaceName:
{
Description: File workspace name. ,
Required: False ,
}
string ,
isTemporaryTicket:
{
Description: This property indicates if support ticket is a temporary ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
technicalTicketDetails:
{
Description: Additional ticket details associated with a technical support ticket request. ,
Required: False ,
}
{
resourceId:
{
Description: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. ,
Required: False ,
}
string ,
}
,
quotaTicketDetails:
{
Description: Additional ticket details associated with a quota support ticket request. ,
Required: False ,
}
{
quotaChangeRequestSubType:
{
Description: Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. ,
Required: False ,
}
string ,
quotaChangeRequestVersion:
{
Description: Quota change request version. ,
Required: False ,
}
string ,
quotaChangeRequests:
{
Description: This property is required for providing the region and new quota limits. ,
Required: False ,
}
[
{
region:
{
Description: Region for which the quota increase request is being made. ,
Required: False ,
}
string ,
payload:
{
Description: Payload of the quota increase request. ,
Required: False ,
}
string ,
}
,
]
,
}
,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
supportTicketId:
{
Description: System generated support ticket Id that is unique. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the question or issue. ,
Required: True ,
}
string ,
problemClassificationId:
{
Description: Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. ,
Required: True ,
}
string ,
problemClassificationDisplayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
severity:
{
Description: A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: True ,
}
enum ,
enrollmentId:
{
Description: Enrollment Id associated with the support ticket. ,
Required: False ,
}
string ,
require24X7Response:
{
Description: Indicates if this requires a 24x7 response from Azure. ,
Required: False ,
}
boolean ,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: True ,
}
enum ,
problemScopingQuestions:
{
Description: Problem scoping questions associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanId:
{
Description: Support plan id associated with the support ticket. ,
Required: False ,
}
string ,
contactDetails:
{
Description: Contact information of the user requesting to create a support ticket. ,
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: True ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: True ,
}
string ,
additionalEmailAddresses:
{
Description: Additional email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: True ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: True ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: True ,
}
string ,
}
,
serviceLevelAgreement:
{
Description: Service Level Agreement information for this support ticket. ,
Required: False ,
}
{
startTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement starts. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
slaMinutes:
{
Description: Service Level Agreement in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportEngineer:
{
Description: Information about the support engineer working on this support ticket. ,
Required: False ,
}
{
emailAddress:
{
Description: Email address of the Azure Support engineer assigned to the support ticket. ,
Required: False ,
}
string ,
}
,
supportPlanType:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanDisplayName:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
title:
{
Description: Title of the support ticket. ,
Required: True ,
}
string ,
problemStartTime:
{
Description: Time in UTC (ISO 8601 format) when the problem started. ,
Format: date-time ,
Required: False ,
}
string ,
serviceId:
{
Description: This is the resource Id of the Azure service resource associated with the support ticket. ,
Required: True ,
}
string ,
serviceDisplayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
status:
{
Description: Status of the support ticket. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
fileWorkspaceName:
{
Description: File workspace name. ,
Required: False ,
}
string ,
isTemporaryTicket:
{
Description: This property indicates if support ticket is a temporary ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
technicalTicketDetails:
{
Description: Additional ticket details associated with a technical support ticket request. ,
Required: False ,
}
{
resourceId:
{
Description: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. ,
Required: False ,
}
string ,
}
,
quotaTicketDetails:
{
Description: Additional ticket details associated with a quota support ticket request. ,
Required: False ,
}
{
quotaChangeRequestSubType:
{
Description: Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. ,
Required: False ,
}
string ,
quotaChangeRequestVersion:
{
Description: Quota change request version. ,
Required: False ,
}
string ,
quotaChangeRequests:
{
Description: This property is required for providing the region and new quota limits. ,
Required: False ,
}
[
{
region:
{
Description: Region for which the quota increase request is being made. ,
Required: False ,
}
string ,
payload:
{
Description: Payload of the quota increase request. ,
Required: False ,
}
string ,
}
,
]
,
}
,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SupportTickets_Update (new)
Description :  This API allows you to update the severity level, ticket status, advanced diagnostic consent and 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.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
updateSupportTicket:
{
Description: UpdateSupportTicket object. ,
Required: True ,
}
{
severity:
{
Description: Severity level. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status to be updated on the ticket. ,
Enum:
{
open: No description available. ,
closed: No description available. ,
}
,
Required: False ,
}
enum ,
contactDetails:
{
Description: Contact details to be updated on the support ticket. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: False ,
}
string ,
additionalEmailAddresses:
{
Description: Email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: False ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: False ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response/). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: False ,
}
string ,
}
,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
supportTicketId:
{
Description: System generated support ticket Id that is unique. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the question or issue. ,
Required: True ,
}
string ,
problemClassificationId:
{
Description: Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. ,
Required: True ,
}
string ,
problemClassificationDisplayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
severity:
{
Description: A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: True ,
}
enum ,
enrollmentId:
{
Description: Enrollment Id associated with the support ticket. ,
Required: False ,
}
string ,
require24X7Response:
{
Description: Indicates if this requires a 24x7 response from Azure. ,
Required: False ,
}
boolean ,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: True ,
}
enum ,
problemScopingQuestions:
{
Description: Problem scoping questions associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanId:
{
Description: Support plan id associated with the support ticket. ,
Required: False ,
}
string ,
contactDetails:
{
Description: Contact information of the user requesting to create a support ticket. ,
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: True ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: True ,
}
string ,
additionalEmailAddresses:
{
Description: Additional email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: True ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: True ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: True ,
}
string ,
}
,
serviceLevelAgreement:
{
Description: Service Level Agreement information for this support ticket. ,
Required: False ,
}
{
startTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement starts. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
slaMinutes:
{
Description: Service Level Agreement in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportEngineer:
{
Description: Information about the support engineer working on this support ticket. ,
Required: False ,
}
{
emailAddress:
{
Description: Email address of the Azure Support engineer assigned to the support ticket. ,
Required: False ,
}
string ,
}
,
supportPlanType:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanDisplayName:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
title:
{
Description: Title of the support ticket. ,
Required: True ,
}
string ,
problemStartTime:
{
Description: Time in UTC (ISO 8601 format) when the problem started. ,
Format: date-time ,
Required: False ,
}
string ,
serviceId:
{
Description: This is the resource Id of the Azure service resource associated with the support ticket. ,
Required: True ,
}
string ,
serviceDisplayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
status:
{
Description: Status of the support ticket. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
fileWorkspaceName:
{
Description: File workspace name. ,
Required: False ,
}
string ,
isTemporaryTicket:
{
Description: This property indicates if support ticket is a temporary ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
technicalTicketDetails:
{
Description: Additional ticket details associated with a technical support ticket request. ,
Required: False ,
}
{
resourceId:
{
Description: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. ,
Required: False ,
}
string ,
}
,
quotaTicketDetails:
{
Description: Additional ticket details associated with a quota support ticket request. ,
Required: False ,
}
{
quotaChangeRequestSubType:
{
Description: Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. ,
Required: False ,
}
string ,
quotaChangeRequestVersion:
{
Description: Quota change request version. ,
Required: False ,
}
string ,
quotaChangeRequests:
{
Description: This property is required for providing the region and new quota limits. ,
Required: False ,
}
[
{
region:
{
Description: Region for which the quota increase request is being made. ,
Required: False ,
}
string ,
payload:
{
Description: Payload of the quota increase request. ,
Required: False ,
}
string ,
}
,
]
,
}
,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ChatTranscripts_List (new)
Description :  Lists all chat transcripts for a support ticket under subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/chatTranscripts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: [Placeholder] Description for nextLink property ,
Required: False ,
}
string ,
value:
{
Description: [Placeholder] Description for value property ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the resource. ,
Required: False ,
}
{
messages:
{
Description: List of chat transcript communication resources. ,
Required: False ,
}
[
{
contentType:
{
Description: Content type. ,
Required: False ,
}
string ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Name of the sender. ,
Required: False ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: Time in UTC (ISO 8601 format) when the chat began. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ChatTranscripts_Get (new)
Description :  Returns chatTranscript details for a support ticket under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/chatTranscripts/{chatTranscriptName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
chatTranscriptName:
{
Description: The name of the ChatTranscriptDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: False ,
}
{
messages:
{
Description: List of chat transcript communication resources. ,
Required: False ,
}
[
{
contentType:
{
Description: Content type. ,
Required: False ,
}
string ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Name of the sender. ,
Required: False ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: Time in UTC (ISO 8601 format) when the chat began. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Communications_CheckNameAvailability (new)
Description :  Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication to the support ticket.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
checkNameAvailabilityInput:
{
Description: Input to check. ,
Required: True ,
}
{
name:
{
Description: The resource name to validate. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource. ,
Enum:
{
Microsoft.Support/supportTickets: No description available. ,
Microsoft.Support/communications: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates whether the name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the name is not available. ,
Required: False ,
}
string ,
message:
{
Description: The detailed error message describing why the name is not available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Communications_List (new)
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 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
$top:
{
Description: The number of values to return in the collection. Default is 10 and max is 10. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: [Placeholder] Description for nextLink property ,
Required: False ,
}
string ,
value:
{
Description: [Placeholder] Description for value property ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
communicationType:
{
Description: Communication type. ,
Enum:
{
web: No description available. ,
phone: No description available. ,
}
,
Required: False ,
}
enum ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Email address of the sender. This property is required if called by a service principal. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the communication. ,
Required: True ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: True ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Communications_Get (new)
Description :  Returns communication details for a support ticket.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
communicationName:
{
Description: The name of the CommunicationDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
communicationType:
{
Description: Communication type. ,
Enum:
{
web: No description available. ,
phone: No description available. ,
}
,
Required: False ,
}
enum ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Email address of the sender. This property is required if called by a service principal. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the communication. ,
Required: True ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: True ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Communications_Create (new)
Description :  Adds a new customer communication to an Azure support ticket.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
communicationName:
{
Description: The name of the CommunicationDetails ,
Required: True ,
}
string ,
createCommunicationParameters:
{
Description: Communication object. ,
Required: True ,
}
{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
communicationType:
{
Description: Communication type. ,
Enum:
{
web: No description available. ,
phone: No description available. ,
}
,
Required: False ,
}
enum ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Email address of the sender. This property is required if called by a service principal. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the communication. ,
Required: True ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: True ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
communicationType:
{
Description: Communication type. ,
Enum:
{
web: No description available. ,
phone: No description available. ,
}
,
Required: False ,
}
enum ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Email address of the sender. This property is required if called by a service principal. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the communication. ,
Required: True ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: True ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SupportTicketsNoSubscription_CheckNameAvailability (removed)
Description :  Check the availability of a resource name. This API should be used to check the uniqueness of the name for support ticket creation for the selected subscription.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Support/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
checkNameAvailabilityInput:
{
Description: The request body ,
Required: True ,
}
{
name:
{
Description: The resource name to validate. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource. ,
Enum:
{
Microsoft.Support/supportTickets: No description available. ,
Microsoft.Support/communications: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates whether the name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the name is not available. ,
Required: False ,
}
string ,
message:
{
Description: The detailed error message describing why the name is not available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileWorkspacesNoSubscription_Get (removed)
Description :  Gets details for a specific file workspace.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when file workspace is going to expire. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileWorkspacesNoSubscription_Create (removed)
Description :  Creates a new file workspace.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when file workspace is going to expire. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FilesNoSubscription_List (removed)
Description :  Lists all the Files information under a workspace for an Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: [Placeholder] Description for nextLink property ,
Required: False ,
}
string ,
value:
{
Description: [Placeholder] Description for value property ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
chunkSize:
{
Description: Size of each chunk. The size of each chunk should be provided in bytes and must not exceed 2.5 megabytes (MB). ,
Format: int32 ,
Required: False ,
}
integer ,
fileSize:
{
Description: Size of the file to be uploaded. The file size must not exceed 5 MB and should be provided in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfChunks:
{
Description: Number of chunks to be uploaded. The maximum number of allowed chunks is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FilesNoSubscription_Get (removed)
Description :  Returns details of a specific file in a work space.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
fileName:
{
Description: The name of the FileDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
chunkSize:
{
Description: Size of each chunk. The size of each chunk should be provided in bytes and must not exceed 2.5 megabytes (MB). ,
Format: int32 ,
Required: False ,
}
integer ,
fileSize:
{
Description: Size of the file to be uploaded. The file size must not exceed 5 MB and should be provided in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfChunks:
{
Description: Number of chunks to be uploaded. The maximum number of allowed chunks is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FilesNoSubscription_Create (removed)
Description :  Creates a new file under a workspace.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
fileName:
{
Description: The name of the FileDetails ,
Required: True ,
}
string ,
createFileParameters:
{
Description: Create file object ,
Required: True ,
}
{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
chunkSize:
{
Description: Size of each chunk. The size of each chunk should be provided in bytes and must not exceed 2.5 megabytes (MB). ,
Format: int32 ,
Required: False ,
}
integer ,
fileSize:
{
Description: Size of the file to be uploaded. The file size must not exceed 5 MB and should be provided in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfChunks:
{
Description: Number of chunks to be uploaded. The maximum number of allowed chunks is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
chunkSize:
{
Description: Size of each chunk. The size of each chunk should be provided in bytes and must not exceed 2.5 megabytes (MB). ,
Format: int32 ,
Required: False ,
}
integer ,
fileSize:
{
Description: Size of the file to be uploaded. The file size must not exceed 5 MB and should be provided in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfChunks:
{
Description: Number of chunks to be uploaded. The maximum number of allowed chunks is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FilesNoSubscription_Upload (removed)
Description :  This API allows you to upload content to a file
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}/upload
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
fileName:
{
Description: The name of the FileDetails ,
Required: True ,
}
string ,
uploadFile:
{
Description: UploadFile object ,
Required: True ,
}
{
content:
{
Description: File Content in base64 encoded format ,
Required: False ,
}
string ,
chunkIndex:
{
Description: Index of the uploaded chunk (Index starts at 0) ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Services_List (removed)
Description :  Lists all the Azure services available for support ticket creation. For **Technical** issues, select the Service Id that maps to the Azure service/product as displayed in the **Services** drop-down list on the Azure portal's [New support request](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/overview) page. Always use the service and its corresponding problem classification(s) obtained programmatically for support ticket creation. This practice ensures that you always have the most recent set of service and problem classification Ids.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/services
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of items ,
Required: False ,
}
string ,
value:
{
Description: List of Service resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the resource. ,
Required: False ,
}
{
displayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: ARM Resource types. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Services_Get (removed)
Description :  Gets a specific Azure service for support ticket creation.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/services/{serviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
serviceName:
{
Description: Name of the Azure service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: False ,
}
{
displayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: ARM Resource types. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProblemClassifications_List (removed)
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.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/services/{serviceName}/problemClassifications
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
serviceName:
{
Description: Name of the Azure service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of items ,
Required: False ,
}
string ,
value:
{
Description: List of ProblemClassification resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the resource. ,
Required: False ,
}
{
displayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
secondaryConsentEnabled:
{
Description: This property indicates whether secondary consent is present for problem classification ,
Required: False ,
}
[
{
description:
{
Description: User consent description. ,
Required: False ,
}
string ,
type:
{
Description: The Azure service for which secondary consent is needed for case creation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProblemClassifications_Get (removed)
Description :  Get problem classification details for a specific Azure service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/services/{serviceName}/problemClassifications/{problemClassificationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
serviceName:
{
Description: Name of the Azure service. ,
Required: True ,
}
string ,
problemClassificationName:
{
Description: Name of problem classification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: False ,
}
{
displayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
secondaryConsentEnabled:
{
Description: This property indicates whether secondary consent is present for problem classification ,
Required: False ,
}
[
{
description:
{
Description: User consent description. ,
Required: False ,
}
string ,
type:
{
Description: The Azure service for which secondary consent is needed for case creation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SupportTicketsNoSubscription_List (removed)
Description :  Lists all the support tickets.

You can also filter the support tickets by Status, CreatedDate, , ServiceId, and ProblemClassificationId 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.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/supportTickets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$top:
{
Description: The number of values to return in the collection. Default is 25 and max is 100. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply on the operation. We support 'odata v4.0' filter semantics. Learn more
Status , ServiceId, and ProblemClassificationId filters 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'. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: [Placeholder] Description for nextLink property ,
Required: False ,
}
string ,
value:
{
Description: [Placeholder] Description for value property ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
supportTicketId:
{
Description: System generated support ticket Id that is unique. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the question or issue. ,
Required: True ,
}
string ,
problemClassificationId:
{
Description: Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. ,
Required: True ,
}
string ,
problemClassificationDisplayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
severity:
{
Description: A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: True ,
}
enum ,
enrollmentId:
{
Description: Enrollment Id associated with the support ticket. ,
Required: False ,
}
string ,
require24X7Response:
{
Description: Indicates if this requires a 24x7 response from Azure. ,
Required: False ,
}
boolean ,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: True ,
}
enum ,
problemScopingQuestions:
{
Description: Problem scoping questions associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanId:
{
Description: Support plan id associated with the support ticket. ,
Required: False ,
}
string ,
contactDetails:
{
Description: Contact information of the user requesting to create a support ticket. ,
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: True ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: True ,
}
string ,
additionalEmailAddresses:
{
Description: Additional email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: True ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: True ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: True ,
}
string ,
}
,
serviceLevelAgreement:
{
Description: Service Level Agreement information for this support ticket. ,
Required: False ,
}
{
startTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement starts. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
slaMinutes:
{
Description: Service Level Agreement in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportEngineer:
{
Description: Information about the support engineer working on this support ticket. ,
Required: False ,
}
{
emailAddress:
{
Description: Email address of the Azure Support engineer assigned to the support ticket. ,
Required: False ,
}
string ,
}
,
supportPlanType:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanDisplayName:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
title:
{
Description: Title of the support ticket. ,
Required: True ,
}
string ,
problemStartTime:
{
Description: Time in UTC (ISO 8601 format) when the problem started. ,
Format: date-time ,
Required: False ,
}
string ,
serviceId:
{
Description: This is the resource Id of the Azure service resource associated with the support ticket. ,
Required: True ,
}
string ,
serviceDisplayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
status:
{
Description: Status of the support ticket. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
fileWorkspaceName:
{
Description: File workspace name. ,
Required: False ,
}
string ,
isTemporaryTicket:
{
Description: This property indicates if support ticket is a temporary ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
technicalTicketDetails:
{
Description: Additional ticket details associated with a technical support ticket request. ,
Required: False ,
}
{
resourceId:
{
Description: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. ,
Required: False ,
}
string ,
}
,
quotaTicketDetails:
{
Description: Additional ticket details associated with a quota support ticket request. ,
Required: False ,
}
{
quotaChangeRequestSubType:
{
Description: Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. ,
Required: False ,
}
string ,
quotaChangeRequestVersion:
{
Description: Quota change request version. ,
Required: False ,
}
string ,
quotaChangeRequests:
{
Description: This property is required for providing the region and new quota limits. ,
Required: False ,
}
[
{
region:
{
Description: Region for which the quota increase request is being made. ,
Required: False ,
}
string ,
payload:
{
Description: Payload of the quota increase request. ,
Required: False ,
}
string ,
}
,
]
,
}
,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SupportTicketsNoSubscription_Get (removed)
Description :  Gets details for a specific support ticket. 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.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/supportTickets/{supportTicketName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
supportTicketId:
{
Description: System generated support ticket Id that is unique. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the question or issue. ,
Required: True ,
}
string ,
problemClassificationId:
{
Description: Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. ,
Required: True ,
}
string ,
problemClassificationDisplayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
severity:
{
Description: A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: True ,
}
enum ,
enrollmentId:
{
Description: Enrollment Id associated with the support ticket. ,
Required: False ,
}
string ,
require24X7Response:
{
Description: Indicates if this requires a 24x7 response from Azure. ,
Required: False ,
}
boolean ,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: True ,
}
enum ,
problemScopingQuestions:
{
Description: Problem scoping questions associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanId:
{
Description: Support plan id associated with the support ticket. ,
Required: False ,
}
string ,
contactDetails:
{
Description: Contact information of the user requesting to create a support ticket. ,
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: True ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: True ,
}
string ,
additionalEmailAddresses:
{
Description: Additional email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: True ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: True ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: True ,
}
string ,
}
,
serviceLevelAgreement:
{
Description: Service Level Agreement information for this support ticket. ,
Required: False ,
}
{
startTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement starts. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
slaMinutes:
{
Description: Service Level Agreement in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportEngineer:
{
Description: Information about the support engineer working on this support ticket. ,
Required: False ,
}
{
emailAddress:
{
Description: Email address of the Azure Support engineer assigned to the support ticket. ,
Required: False ,
}
string ,
}
,
supportPlanType:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanDisplayName:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
title:
{
Description: Title of the support ticket. ,
Required: True ,
}
string ,
problemStartTime:
{
Description: Time in UTC (ISO 8601 format) when the problem started. ,
Format: date-time ,
Required: False ,
}
string ,
serviceId:
{
Description: This is the resource Id of the Azure service resource associated with the support ticket. ,
Required: True ,
}
string ,
serviceDisplayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
status:
{
Description: Status of the support ticket. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
fileWorkspaceName:
{
Description: File workspace name. ,
Required: False ,
}
string ,
isTemporaryTicket:
{
Description: This property indicates if support ticket is a temporary ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
technicalTicketDetails:
{
Description: Additional ticket details associated with a technical support ticket request. ,
Required: False ,
}
{
resourceId:
{
Description: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. ,
Required: False ,
}
string ,
}
,
quotaTicketDetails:
{
Description: Additional ticket details associated with a quota support ticket request. ,
Required: False ,
}
{
quotaChangeRequestSubType:
{
Description: Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. ,
Required: False ,
}
string ,
quotaChangeRequestVersion:
{
Description: Quota change request version. ,
Required: False ,
}
string ,
quotaChangeRequests:
{
Description: This property is required for providing the region and new quota limits. ,
Required: False ,
}
[
{
region:
{
Description: Region for which the quota increase request is being made. ,
Required: False ,
}
string ,
payload:
{
Description: Payload of the quota increase request. ,
Required: False ,
}
string ,
}
,
]
,
}
,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SupportTicketsNoSubscription_Create (removed)
Description :  Creates a new support ticket for Billing, and Subscription Management issues. Learn the [prerequisites](https://aka.ms/supportAPI) required to create a support ticket.

Always call the Services and ProblemClassifications API to get the most recent set of services and problem categories required for support ticket creation.

Adding attachments is not currently supported via the API. To add a file to an existing support ticket, visit the [Manage support ticket](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/managesupportrequest) page in the Azure portal, select the support ticket, and use the file upload control to add a new file.

Providing consent to share diagnostic information with Azure support is currently not supported via the API. The Azure support engineer working on your ticket will reach out to you for consent if your issue requires gathering diagnostic information from your Azure resources.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Support/supportTickets/{supportTicketName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
createSupportTicketParameters:
{
Description: Support ticket request payload. ,
Required: True ,
}
{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
supportTicketId:
{
Description: System generated support ticket Id that is unique. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the question or issue. ,
Required: True ,
}
string ,
problemClassificationId:
{
Description: Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. ,
Required: True ,
}
string ,
problemClassificationDisplayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
severity:
{
Description: A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: True ,
}
enum ,
enrollmentId:
{
Description: Enrollment Id associated with the support ticket. ,
Required: False ,
}
string ,
require24X7Response:
{
Description: Indicates if this requires a 24x7 response from Azure. ,
Required: False ,
}
boolean ,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: True ,
}
enum ,
problemScopingQuestions:
{
Description: Problem scoping questions associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanId:
{
Description: Support plan id associated with the support ticket. ,
Required: False ,
}
string ,
contactDetails:
{
Description: Contact information of the user requesting to create a support ticket. ,
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: True ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: True ,
}
string ,
additionalEmailAddresses:
{
Description: Additional email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: True ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: True ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: True ,
}
string ,
}
,
serviceLevelAgreement:
{
Description: Service Level Agreement information for this support ticket. ,
Required: False ,
}
{
startTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement starts. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
slaMinutes:
{
Description: Service Level Agreement in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportEngineer:
{
Description: Information about the support engineer working on this support ticket. ,
Required: False ,
}
{
emailAddress:
{
Description: Email address of the Azure Support engineer assigned to the support ticket. ,
Required: False ,
}
string ,
}
,
supportPlanType:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanDisplayName:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
title:
{
Description: Title of the support ticket. ,
Required: True ,
}
string ,
problemStartTime:
{
Description: Time in UTC (ISO 8601 format) when the problem started. ,
Format: date-time ,
Required: False ,
}
string ,
serviceId:
{
Description: This is the resource Id of the Azure service resource associated with the support ticket. ,
Required: True ,
}
string ,
serviceDisplayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
status:
{
Description: Status of the support ticket. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
fileWorkspaceName:
{
Description: File workspace name. ,
Required: False ,
}
string ,
isTemporaryTicket:
{
Description: This property indicates if support ticket is a temporary ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
technicalTicketDetails:
{
Description: Additional ticket details associated with a technical support ticket request. ,
Required: False ,
}
{
resourceId:
{
Description: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. ,
Required: False ,
}
string ,
}
,
quotaTicketDetails:
{
Description: Additional ticket details associated with a quota support ticket request. ,
Required: False ,
}
{
quotaChangeRequestSubType:
{
Description: Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. ,
Required: False ,
}
string ,
quotaChangeRequestVersion:
{
Description: Quota change request version. ,
Required: False ,
}
string ,
quotaChangeRequests:
{
Description: This property is required for providing the region and new quota limits. ,
Required: False ,
}
[
{
region:
{
Description: Region for which the quota increase request is being made. ,
Required: False ,
}
string ,
payload:
{
Description: Payload of the quota increase request. ,
Required: False ,
}
string ,
}
,
]
,
}
,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
supportTicketId:
{
Description: System generated support ticket Id that is unique. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the question or issue. ,
Required: True ,
}
string ,
problemClassificationId:
{
Description: Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. ,
Required: True ,
}
string ,
problemClassificationDisplayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
severity:
{
Description: A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: True ,
}
enum ,
enrollmentId:
{
Description: Enrollment Id associated with the support ticket. ,
Required: False ,
}
string ,
require24X7Response:
{
Description: Indicates if this requires a 24x7 response from Azure. ,
Required: False ,
}
boolean ,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: True ,
}
enum ,
problemScopingQuestions:
{
Description: Problem scoping questions associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanId:
{
Description: Support plan id associated with the support ticket. ,
Required: False ,
}
string ,
contactDetails:
{
Description: Contact information of the user requesting to create a support ticket. ,
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: True ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: True ,
}
string ,
additionalEmailAddresses:
{
Description: Additional email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: True ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: True ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: True ,
}
string ,
}
,
serviceLevelAgreement:
{
Description: Service Level Agreement information for this support ticket. ,
Required: False ,
}
{
startTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement starts. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
slaMinutes:
{
Description: Service Level Agreement in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportEngineer:
{
Description: Information about the support engineer working on this support ticket. ,
Required: False ,
}
{
emailAddress:
{
Description: Email address of the Azure Support engineer assigned to the support ticket. ,
Required: False ,
}
string ,
}
,
supportPlanType:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanDisplayName:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
title:
{
Description: Title of the support ticket. ,
Required: True ,
}
string ,
problemStartTime:
{
Description: Time in UTC (ISO 8601 format) when the problem started. ,
Format: date-time ,
Required: False ,
}
string ,
serviceId:
{
Description: This is the resource Id of the Azure service resource associated with the support ticket. ,
Required: True ,
}
string ,
serviceDisplayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
status:
{
Description: Status of the support ticket. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
fileWorkspaceName:
{
Description: File workspace name. ,
Required: False ,
}
string ,
isTemporaryTicket:
{
Description: This property indicates if support ticket is a temporary ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
technicalTicketDetails:
{
Description: Additional ticket details associated with a technical support ticket request. ,
Required: False ,
}
{
resourceId:
{
Description: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. ,
Required: False ,
}
string ,
}
,
quotaTicketDetails:
{
Description: Additional ticket details associated with a quota support ticket request. ,
Required: False ,
}
{
quotaChangeRequestSubType:
{
Description: Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. ,
Required: False ,
}
string ,
quotaChangeRequestVersion:
{
Description: Quota change request version. ,
Required: False ,
}
string ,
quotaChangeRequests:
{
Description: This property is required for providing the region and new quota limits. ,
Required: False ,
}
[
{
region:
{
Description: Region for which the quota increase request is being made. ,
Required: False ,
}
string ,
payload:
{
Description: Payload of the quota increase request. ,
Required: False ,
}
string ,
}
,
]
,
}
,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SupportTicketsNoSubscription_Update (removed)
Description :  This API allows you to update the severity level, ticket status, and 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.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Support/supportTickets/{supportTicketName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
updateSupportTicket:
{
Description: UpdateSupportTicket object. ,
Required: True ,
}
{
severity:
{
Description: Severity level. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status to be updated on the ticket. ,
Enum:
{
open: No description available. ,
closed: No description available. ,
}
,
Required: False ,
}
enum ,
contactDetails:
{
Description: Contact details to be updated on the support ticket. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: False ,
}
string ,
additionalEmailAddresses:
{
Description: Email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: False ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: False ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response/). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: False ,
}
string ,
}
,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
supportTicketId:
{
Description: System generated support ticket Id that is unique. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the question or issue. ,
Required: True ,
}
string ,
problemClassificationId:
{
Description: Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. ,
Required: True ,
}
string ,
problemClassificationDisplayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
severity:
{
Description: A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: True ,
}
enum ,
enrollmentId:
{
Description: Enrollment Id associated with the support ticket. ,
Required: False ,
}
string ,
require24X7Response:
{
Description: Indicates if this requires a 24x7 response from Azure. ,
Required: False ,
}
boolean ,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: True ,
}
enum ,
problemScopingQuestions:
{
Description: Problem scoping questions associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanId:
{
Description: Support plan id associated with the support ticket. ,
Required: False ,
}
string ,
contactDetails:
{
Description: Contact information of the user requesting to create a support ticket. ,
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: True ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: True ,
}
string ,
additionalEmailAddresses:
{
Description: Additional email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: True ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: True ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: True ,
}
string ,
}
,
serviceLevelAgreement:
{
Description: Service Level Agreement information for this support ticket. ,
Required: False ,
}
{
startTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement starts. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
slaMinutes:
{
Description: Service Level Agreement in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportEngineer:
{
Description: Information about the support engineer working on this support ticket. ,
Required: False ,
}
{
emailAddress:
{
Description: Email address of the Azure Support engineer assigned to the support ticket. ,
Required: False ,
}
string ,
}
,
supportPlanType:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanDisplayName:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
title:
{
Description: Title of the support ticket. ,
Required: True ,
}
string ,
problemStartTime:
{
Description: Time in UTC (ISO 8601 format) when the problem started. ,
Format: date-time ,
Required: False ,
}
string ,
serviceId:
{
Description: This is the resource Id of the Azure service resource associated with the support ticket. ,
Required: True ,
}
string ,
serviceDisplayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
status:
{
Description: Status of the support ticket. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
fileWorkspaceName:
{
Description: File workspace name. ,
Required: False ,
}
string ,
isTemporaryTicket:
{
Description: This property indicates if support ticket is a temporary ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
technicalTicketDetails:
{
Description: Additional ticket details associated with a technical support ticket request. ,
Required: False ,
}
{
resourceId:
{
Description: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. ,
Required: False ,
}
string ,
}
,
quotaTicketDetails:
{
Description: Additional ticket details associated with a quota support ticket request. ,
Required: False ,
}
{
quotaChangeRequestSubType:
{
Description: Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. ,
Required: False ,
}
string ,
quotaChangeRequestVersion:
{
Description: Quota change request version. ,
Required: False ,
}
string ,
quotaChangeRequests:
{
Description: This property is required for providing the region and new quota limits. ,
Required: False ,
}
[
{
region:
{
Description: Region for which the quota increase request is being made. ,
Required: False ,
}
string ,
payload:
{
Description: Payload of the quota increase request. ,
Required: False ,
}
string ,
}
,
]
,
}
,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ChatTranscriptsNoSubscription_List (removed)
Description :  Lists all chat transcripts for a support ticket
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/supportTickets/{supportTicketName}/chatTranscripts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: [Placeholder] Description for nextLink property ,
Required: False ,
}
string ,
value:
{
Description: [Placeholder] Description for value property ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the resource. ,
Required: False ,
}
{
messages:
{
Description: List of chat transcript communication resources. ,
Required: False ,
}
[
{
contentType:
{
Description: Content type. ,
Required: False ,
}
string ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Name of the sender. ,
Required: False ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: Time in UTC (ISO 8601 format) when the chat began. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ChatTranscriptsNoSubscription_Get (removed)
Description :  Returns chatTranscript details for a no subscription support ticket.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/supportTickets/{supportTicketName}/chatTranscripts/{chatTranscriptName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
chatTranscriptName:
{
Description: The name of the ChatTranscriptDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: False ,
}
{
messages:
{
Description: List of chat transcript communication resources. ,
Required: False ,
}
[
{
contentType:
{
Description: Content type. ,
Required: False ,
}
string ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Name of the sender. ,
Required: False ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: Time in UTC (ISO 8601 format) when the chat began. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CommunicationsNoSubscription_CheckNameAvailability (removed)
Description :  Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication to the support ticket.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Support/supportTickets/{supportTicketName}/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
checkNameAvailabilityInput:
{
Description: Input to check. ,
Required: True ,
}
{
name:
{
Description: The resource name to validate. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource. ,
Enum:
{
Microsoft.Support/supportTickets: No description available. ,
Microsoft.Support/communications: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates whether the name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the name is not available. ,
Required: False ,
}
string ,
message:
{
Description: The detailed error message describing why the name is not available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CommunicationsNoSubscription_List (removed)
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 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/supportTickets/{supportTicketName}/communications
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
$top:
{
Description: The number of values to return in the collection. Default is 10 and max is 10. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: [Placeholder] Description for nextLink property ,
Required: False ,
}
string ,
value:
{
Description: [Placeholder] Description for value property ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
communicationType:
{
Description: Communication type. ,
Enum:
{
web: No description available. ,
phone: No description available. ,
}
,
Required: False ,
}
enum ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Email address of the sender. This property is required if called by a service principal. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the communication. ,
Required: True ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: True ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CommunicationsNoSubscription_Get (removed)
Description :  Returns communication details for a support ticket.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
communicationName:
{
Description: The name of the CommunicationDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
communicationType:
{
Description: Communication type. ,
Enum:
{
web: No description available. ,
phone: No description available. ,
}
,
Required: False ,
}
enum ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Email address of the sender. This property is required if called by a service principal. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the communication. ,
Required: True ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: True ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CommunicationsNoSubscription_Create (removed)
Description :  Adds a new customer communication to an Azure support ticket.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
communicationName:
{
Description: The name of the CommunicationDetails ,
Required: True ,
}
string ,
createCommunicationParameters:
{
Description: Communication object. ,
Required: True ,
}
{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
communicationType:
{
Description: Communication type. ,
Enum:
{
web: No description available. ,
phone: No description available. ,
}
,
Required: False ,
}
enum ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Email address of the sender. This property is required if called by a service principal. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the communication. ,
Required: True ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: True ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
communicationType:
{
Description: Communication type. ,
Enum:
{
web: No description available. ,
phone: No description available. ,
}
,
Required: False ,
}
enum ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Email address of the sender. This property is required if called by a service principal. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the communication. ,
Required: True ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: True ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SupportTickets_CheckNameAvailability (removed)
Description :  Check the availability of a resource name. This API should be used to check the uniqueness of the name for support ticket creation for the selected subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
checkNameAvailabilityInput:
{
Description: The request body ,
Required: True ,
}
{
name:
{
Description: The resource name to validate. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource. ,
Enum:
{
Microsoft.Support/supportTickets: No description available. ,
Microsoft.Support/communications: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates whether the name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the name is not available. ,
Required: False ,
}
string ,
message:
{
Description: The detailed error message describing why the name is not available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileWorkspaces_Get (removed)
Description :  Gets details for a specific file workspace in an Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when file workspace is going to expire. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileWorkspaces_Create (removed)
Description :  Creates a new file workspace for the specified subscription.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when file workspace is going to expire. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Files_List (removed)
Description :  Lists all the Files information under a workspace for an Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: [Placeholder] Description for nextLink property ,
Required: False ,
}
string ,
value:
{
Description: [Placeholder] Description for value property ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
chunkSize:
{
Description: Size of each chunk. The size of each chunk should be provided in bytes and must not exceed 2.5 megabytes (MB). ,
Format: int32 ,
Required: False ,
}
integer ,
fileSize:
{
Description: Size of the file to be uploaded. The file size must not exceed 5 MB and should be provided in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfChunks:
{
Description: Number of chunks to be uploaded. The maximum number of allowed chunks is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Files_Get (removed)
Description :  Returns details of a specific file in a work space.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
fileName:
{
Description: The name of the FileDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
chunkSize:
{
Description: Size of each chunk. The size of each chunk should be provided in bytes and must not exceed 2.5 megabytes (MB). ,
Format: int32 ,
Required: False ,
}
integer ,
fileSize:
{
Description: Size of the file to be uploaded. The file size must not exceed 5 MB and should be provided in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfChunks:
{
Description: Number of chunks to be uploaded. The maximum number of allowed chunks is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Files_Create (removed)
Description :  Creates a new file under a workspace for the specified subscription.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
fileName:
{
Description: The name of the FileDetails ,
Required: True ,
}
string ,
createFileParameters:
{
Description: Create file object ,
Required: True ,
}
{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
chunkSize:
{
Description: Size of each chunk. The size of each chunk should be provided in bytes and must not exceed 2.5 megabytes (MB). ,
Format: int32 ,
Required: False ,
}
integer ,
fileSize:
{
Description: Size of the file to be uploaded. The file size must not exceed 5 MB and should be provided in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfChunks:
{
Description: Number of chunks to be uploaded. The maximum number of allowed chunks is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the resource ,
Required: False ,
}
{
createdOn:
{
Description: Time in UTC (ISO 8601 format) when file workspace was created. ,
Format: date-time ,
Required: False ,
}
string ,
chunkSize:
{
Description: Size of each chunk. The size of each chunk should be provided in bytes and must not exceed 2.5 megabytes (MB). ,
Format: int32 ,
Required: False ,
}
integer ,
fileSize:
{
Description: Size of the file to be uploaded. The file size must not exceed 5 MB and should be provided in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfChunks:
{
Description: Number of chunks to be uploaded. The maximum number of allowed chunks is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Files_Upload (removed)
Description :  This API allows you to upload content to a file
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}/upload
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
fileWorkspaceName:
{
Description: The name of the FileWorkspaceDetails ,
Required: True ,
}
string ,
fileName:
{
Description: The name of the FileDetails ,
Required: True ,
}
string ,
uploadFile:
{
Description: UploadFile object ,
Required: True ,
}
{
content:
{
Description: File Content in base64 encoded format ,
Required: False ,
}
string ,
chunkIndex:
{
Description: Index of the uploaded chunk (Index starts at 0) ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SupportTickets_List (removed)
Description :  Lists all the support tickets for an Azure subscription. You can also filter the support tickets by _Status_, _CreatedDate_, _ServiceId_, and _ProblemClassificationId_ 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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$top:
{
Description: The number of values to return in the collection. Default is 25 and max is 100. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply on the operation. We support 'odata v4.0' filter semantics. [Learn more](https://docs.microsoft.com/odata/concepts/queryoptions-overview). _Status_, _ServiceId_, and _ProblemClassificationId_ filters can only be used with Equals ('eq') operator. For _CreatedDate_ filter, the supported operators are Greater Than ('gt') and Greater Than or Equals ('ge'). When using both filters, combine them using the logical 'AND'. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: [Placeholder] Description for nextLink property ,
Required: False ,
}
string ,
value:
{
Description: [Placeholder] Description for value property ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
supportTicketId:
{
Description: System generated support ticket Id that is unique. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the question or issue. ,
Required: True ,
}
string ,
problemClassificationId:
{
Description: Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. ,
Required: True ,
}
string ,
problemClassificationDisplayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
severity:
{
Description: A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: True ,
}
enum ,
enrollmentId:
{
Description: Enrollment Id associated with the support ticket. ,
Required: False ,
}
string ,
require24X7Response:
{
Description: Indicates if this requires a 24x7 response from Azure. ,
Required: False ,
}
boolean ,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: True ,
}
enum ,
problemScopingQuestions:
{
Description: Problem scoping questions associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanId:
{
Description: Support plan id associated with the support ticket. ,
Required: False ,
}
string ,
contactDetails:
{
Description: Contact information of the user requesting to create a support ticket. ,
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: True ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: True ,
}
string ,
additionalEmailAddresses:
{
Description: Additional email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: True ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: True ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: True ,
}
string ,
}
,
serviceLevelAgreement:
{
Description: Service Level Agreement information for this support ticket. ,
Required: False ,
}
{
startTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement starts. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
slaMinutes:
{
Description: Service Level Agreement in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportEngineer:
{
Description: Information about the support engineer working on this support ticket. ,
Required: False ,
}
{
emailAddress:
{
Description: Email address of the Azure Support engineer assigned to the support ticket. ,
Required: False ,
}
string ,
}
,
supportPlanType:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanDisplayName:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
title:
{
Description: Title of the support ticket. ,
Required: True ,
}
string ,
problemStartTime:
{
Description: Time in UTC (ISO 8601 format) when the problem started. ,
Format: date-time ,
Required: False ,
}
string ,
serviceId:
{
Description: This is the resource Id of the Azure service resource associated with the support ticket. ,
Required: True ,
}
string ,
serviceDisplayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
status:
{
Description: Status of the support ticket. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
fileWorkspaceName:
{
Description: File workspace name. ,
Required: False ,
}
string ,
isTemporaryTicket:
{
Description: This property indicates if support ticket is a temporary ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
technicalTicketDetails:
{
Description: Additional ticket details associated with a technical support ticket request. ,
Required: False ,
}
{
resourceId:
{
Description: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. ,
Required: False ,
}
string ,
}
,
quotaTicketDetails:
{
Description: Additional ticket details associated with a quota support ticket request. ,
Required: False ,
}
{
quotaChangeRequestSubType:
{
Description: Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. ,
Required: False ,
}
string ,
quotaChangeRequestVersion:
{
Description: Quota change request version. ,
Required: False ,
}
string ,
quotaChangeRequests:
{
Description: This property is required for providing the region and new quota limits. ,
Required: False ,
}
[
{
region:
{
Description: Region for which the quota increase request is being made. ,
Required: False ,
}
string ,
payload:
{
Description: Payload of the quota increase request. ,
Required: False ,
}
string ,
}
,
]
,
}
,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SupportTickets_Get (removed)
Description :  Get ticket details for 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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
supportTicketId:
{
Description: System generated support ticket Id that is unique. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the question or issue. ,
Required: True ,
}
string ,
problemClassificationId:
{
Description: Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. ,
Required: True ,
}
string ,
problemClassificationDisplayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
severity:
{
Description: A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: True ,
}
enum ,
enrollmentId:
{
Description: Enrollment Id associated with the support ticket. ,
Required: False ,
}
string ,
require24X7Response:
{
Description: Indicates if this requires a 24x7 response from Azure. ,
Required: False ,
}
boolean ,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: True ,
}
enum ,
problemScopingQuestions:
{
Description: Problem scoping questions associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanId:
{
Description: Support plan id associated with the support ticket. ,
Required: False ,
}
string ,
contactDetails:
{
Description: Contact information of the user requesting to create a support ticket. ,
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: True ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: True ,
}
string ,
additionalEmailAddresses:
{
Description: Additional email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: True ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: True ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: True ,
}
string ,
}
,
serviceLevelAgreement:
{
Description: Service Level Agreement information for this support ticket. ,
Required: False ,
}
{
startTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement starts. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
slaMinutes:
{
Description: Service Level Agreement in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportEngineer:
{
Description: Information about the support engineer working on this support ticket. ,
Required: False ,
}
{
emailAddress:
{
Description: Email address of the Azure Support engineer assigned to the support ticket. ,
Required: False ,
}
string ,
}
,
supportPlanType:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanDisplayName:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
title:
{
Description: Title of the support ticket. ,
Required: True ,
}
string ,
problemStartTime:
{
Description: Time in UTC (ISO 8601 format) when the problem started. ,
Format: date-time ,
Required: False ,
}
string ,
serviceId:
{
Description: This is the resource Id of the Azure service resource associated with the support ticket. ,
Required: True ,
}
string ,
serviceDisplayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
status:
{
Description: Status of the support ticket. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
fileWorkspaceName:
{
Description: File workspace name. ,
Required: False ,
}
string ,
isTemporaryTicket:
{
Description: This property indicates if support ticket is a temporary ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
technicalTicketDetails:
{
Description: Additional ticket details associated with a technical support ticket request. ,
Required: False ,
}
{
resourceId:
{
Description: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. ,
Required: False ,
}
string ,
}
,
quotaTicketDetails:
{
Description: Additional ticket details associated with a quota support ticket request. ,
Required: False ,
}
{
quotaChangeRequestSubType:
{
Description: Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. ,
Required: False ,
}
string ,
quotaChangeRequestVersion:
{
Description: Quota change request version. ,
Required: False ,
}
string ,
quotaChangeRequests:
{
Description: This property is required for providing the region and new quota limits. ,
Required: False ,
}
[
{
region:
{
Description: Region for which the quota increase request is being made. ,
Required: False ,
}
string ,
payload:
{
Description: Payload of the quota increase request. ,
Required: False ,
}
string ,
}
,
]
,
}
,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SupportTickets_Create (removed)
Description :  Creates a new support ticket for Subscription and Service limits (Quota), Technical, Billing, and Subscription Management issues for the specified subscription. Learn the [prerequisites](https://aka.ms/supportAPI) required to create a support ticket.

Always call the Services and ProblemClassifications API to get the most recent set of services and problem categories required for support ticket creation.

Adding attachments is not currently supported via the API. To add a file to an existing support ticket, visit the [Manage support ticket](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/managesupportrequest) page in the Azure portal, select the support ticket, and use the file upload control to add a new file.

Providing consent to share diagnostic information with Azure support is currently not supported via the API. The Azure support engineer working on your ticket will reach out to you for consent if your issue requires gathering diagnostic information from your Azure resources.

**Creating a support ticket for on-behalf-of**: Include _x-ms-authorization-auxiliary_ header to provide an auxiliary token as per [documentation](https://docs.microsoft.com/azure/azure-resource-manager/management/authenticate-multi-tenant). The primary token will be from the tenant for whom a support ticket is being raised against the subscription, i.e. Cloud solution provider (CSP) customer tenant. The auxiliary token will be from the Cloud solution provider (CSP) partner tenant.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
createSupportTicketParameters:
{
Description: Support ticket request payload. ,
Required: True ,
}
{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
supportTicketId:
{
Description: System generated support ticket Id that is unique. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the question or issue. ,
Required: True ,
}
string ,
problemClassificationId:
{
Description: Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. ,
Required: True ,
}
string ,
problemClassificationDisplayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
severity:
{
Description: A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: True ,
}
enum ,
enrollmentId:
{
Description: Enrollment Id associated with the support ticket. ,
Required: False ,
}
string ,
require24X7Response:
{
Description: Indicates if this requires a 24x7 response from Azure. ,
Required: False ,
}
boolean ,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: True ,
}
enum ,
problemScopingQuestions:
{
Description: Problem scoping questions associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanId:
{
Description: Support plan id associated with the support ticket. ,
Required: False ,
}
string ,
contactDetails:
{
Description: Contact information of the user requesting to create a support ticket. ,
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: True ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: True ,
}
string ,
additionalEmailAddresses:
{
Description: Additional email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: True ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: True ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: True ,
}
string ,
}
,
serviceLevelAgreement:
{
Description: Service Level Agreement information for this support ticket. ,
Required: False ,
}
{
startTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement starts. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
slaMinutes:
{
Description: Service Level Agreement in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportEngineer:
{
Description: Information about the support engineer working on this support ticket. ,
Required: False ,
}
{
emailAddress:
{
Description: Email address of the Azure Support engineer assigned to the support ticket. ,
Required: False ,
}
string ,
}
,
supportPlanType:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanDisplayName:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
title:
{
Description: Title of the support ticket. ,
Required: True ,
}
string ,
problemStartTime:
{
Description: Time in UTC (ISO 8601 format) when the problem started. ,
Format: date-time ,
Required: False ,
}
string ,
serviceId:
{
Description: This is the resource Id of the Azure service resource associated with the support ticket. ,
Required: True ,
}
string ,
serviceDisplayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
status:
{
Description: Status of the support ticket. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
fileWorkspaceName:
{
Description: File workspace name. ,
Required: False ,
}
string ,
isTemporaryTicket:
{
Description: This property indicates if support ticket is a temporary ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
technicalTicketDetails:
{
Description: Additional ticket details associated with a technical support ticket request. ,
Required: False ,
}
{
resourceId:
{
Description: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. ,
Required: False ,
}
string ,
}
,
quotaTicketDetails:
{
Description: Additional ticket details associated with a quota support ticket request. ,
Required: False ,
}
{
quotaChangeRequestSubType:
{
Description: Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. ,
Required: False ,
}
string ,
quotaChangeRequestVersion:
{
Description: Quota change request version. ,
Required: False ,
}
string ,
quotaChangeRequests:
{
Description: This property is required for providing the region and new quota limits. ,
Required: False ,
}
[
{
region:
{
Description: Region for which the quota increase request is being made. ,
Required: False ,
}
string ,
payload:
{
Description: Payload of the quota increase request. ,
Required: False ,
}
string ,
}
,
]
,
}
,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
supportTicketId:
{
Description: System generated support ticket Id that is unique. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the question or issue. ,
Required: True ,
}
string ,
problemClassificationId:
{
Description: Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. ,
Required: True ,
}
string ,
problemClassificationDisplayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
severity:
{
Description: A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: True ,
}
enum ,
enrollmentId:
{
Description: Enrollment Id associated with the support ticket. ,
Required: False ,
}
string ,
require24X7Response:
{
Description: Indicates if this requires a 24x7 response from Azure. ,
Required: False ,
}
boolean ,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: True ,
}
enum ,
problemScopingQuestions:
{
Description: Problem scoping questions associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanId:
{
Description: Support plan id associated with the support ticket. ,
Required: False ,
}
string ,
contactDetails:
{
Description: Contact information of the user requesting to create a support ticket. ,
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: True ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: True ,
}
string ,
additionalEmailAddresses:
{
Description: Additional email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: True ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: True ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: True ,
}
string ,
}
,
serviceLevelAgreement:
{
Description: Service Level Agreement information for this support ticket. ,
Required: False ,
}
{
startTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement starts. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
slaMinutes:
{
Description: Service Level Agreement in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportEngineer:
{
Description: Information about the support engineer working on this support ticket. ,
Required: False ,
}
{
emailAddress:
{
Description: Email address of the Azure Support engineer assigned to the support ticket. ,
Required: False ,
}
string ,
}
,
supportPlanType:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanDisplayName:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
title:
{
Description: Title of the support ticket. ,
Required: True ,
}
string ,
problemStartTime:
{
Description: Time in UTC (ISO 8601 format) when the problem started. ,
Format: date-time ,
Required: False ,
}
string ,
serviceId:
{
Description: This is the resource Id of the Azure service resource associated with the support ticket. ,
Required: True ,
}
string ,
serviceDisplayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
status:
{
Description: Status of the support ticket. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
fileWorkspaceName:
{
Description: File workspace name. ,
Required: False ,
}
string ,
isTemporaryTicket:
{
Description: This property indicates if support ticket is a temporary ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
technicalTicketDetails:
{
Description: Additional ticket details associated with a technical support ticket request. ,
Required: False ,
}
{
resourceId:
{
Description: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. ,
Required: False ,
}
string ,
}
,
quotaTicketDetails:
{
Description: Additional ticket details associated with a quota support ticket request. ,
Required: False ,
}
{
quotaChangeRequestSubType:
{
Description: Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. ,
Required: False ,
}
string ,
quotaChangeRequestVersion:
{
Description: Quota change request version. ,
Required: False ,
}
string ,
quotaChangeRequests:
{
Description: This property is required for providing the region and new quota limits. ,
Required: False ,
}
[
{
region:
{
Description: Region for which the quota increase request is being made. ,
Required: False ,
}
string ,
payload:
{
Description: Payload of the quota increase request. ,
Required: False ,
}
string ,
}
,
]
,
}
,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SupportTickets_Update (removed)
Description :  This API allows you to update the severity level, ticket status, advanced diagnostic consent and 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.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
updateSupportTicket:
{
Description: UpdateSupportTicket object. ,
Required: True ,
}
{
severity:
{
Description: Severity level. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status to be updated on the ticket. ,
Enum:
{
open: No description available. ,
closed: No description available. ,
}
,
Required: False ,
}
enum ,
contactDetails:
{
Description: Contact details to be updated on the support ticket. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: False ,
}
string ,
additionalEmailAddresses:
{
Description: Email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: False ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: False ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response/). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: False ,
}
string ,
}
,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
supportTicketId:
{
Description: System generated support ticket Id that is unique. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the question or issue. ,
Required: True ,
}
string ,
problemClassificationId:
{
Description: Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. ,
Required: True ,
}
string ,
problemClassificationDisplayName:
{
Description: Localized name of problem classification. ,
Required: False ,
}
string ,
severity:
{
Description: A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. ,
Enum:
{
minimal: No description available. ,
moderate: No description available. ,
critical: No description available. ,
highestcriticalimpact: No description available. ,
}
,
Required: True ,
}
enum ,
enrollmentId:
{
Description: Enrollment Id associated with the support ticket. ,
Required: False ,
}
string ,
require24X7Response:
{
Description: Indicates if this requires a 24x7 response from Azure. ,
Required: False ,
}
boolean ,
advancedDiagnosticConsent:
{
Description: Advanced diagnostic consent to be updated on the support ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: True ,
}
enum ,
problemScopingQuestions:
{
Description: Problem scoping questions associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanId:
{
Description: Support plan id associated with the support ticket. ,
Required: False ,
}
string ,
contactDetails:
{
Description: Contact information of the user requesting to create a support ticket. ,
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
preferredContactMethod:
{
Description: Preferred contact method. ,
Enum:
{
email: No description available. ,
phone: No description available. ,
}
,
Required: True ,
}
enum ,
primaryEmailAddress:
{
Description: Primary email address. ,
Required: True ,
}
string ,
additionalEmailAddresses:
{
Description: Additional email addresses listed will be copied on any correspondence about the support ticket. ,
Required: False ,
}
[
string ,
]
,
phoneNumber:
{
Description: Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. ,
Required: False ,
}
string ,
preferredTimeZone:
{
Description: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). ,
Required: True ,
}
string ,
country:
{
Description: Country of the user. This is the ISO 3166-1 alpha-3 code. ,
Required: True ,
}
string ,
preferredSupportLanguage:
{
Description: Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German. ,
Required: True ,
}
string ,
}
,
serviceLevelAgreement:
{
Description: Service Level Agreement information for this support ticket. ,
Required: False ,
}
{
startTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement starts. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time in UTC (ISO 8601 format) when the service level agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
slaMinutes:
{
Description: Service Level Agreement in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportEngineer:
{
Description: Information about the support engineer working on this support ticket. ,
Required: False ,
}
{
emailAddress:
{
Description: Email address of the Azure Support engineer assigned to the support ticket. ,
Required: False ,
}
string ,
}
,
supportPlanType:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
supportPlanDisplayName:
{
Description: Support plan type associated with the support ticket. ,
Required: False ,
}
string ,
title:
{
Description: Title of the support ticket. ,
Required: True ,
}
string ,
problemStartTime:
{
Description: Time in UTC (ISO 8601 format) when the problem started. ,
Format: date-time ,
Required: False ,
}
string ,
serviceId:
{
Description: This is the resource Id of the Azure service resource associated with the support ticket. ,
Required: True ,
}
string ,
serviceDisplayName:
{
Description: Localized name of the Azure service. ,
Required: False ,
}
string ,
status:
{
Description: Status of the support ticket. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Time in UTC (ISO 8601 format) when the support ticket was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
fileWorkspaceName:
{
Description: File workspace name. ,
Required: False ,
}
string ,
isTemporaryTicket:
{
Description: This property indicates if support ticket is a temporary ticket. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
technicalTicketDetails:
{
Description: Additional ticket details associated with a technical support ticket request. ,
Required: False ,
}
{
resourceId:
{
Description: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. ,
Required: False ,
}
string ,
}
,
quotaTicketDetails:
{
Description: Additional ticket details associated with a quota support ticket request. ,
Required: False ,
}
{
quotaChangeRequestSubType:
{
Description: Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. ,
Required: False ,
}
string ,
quotaChangeRequestVersion:
{
Description: Quota change request version. ,
Required: False ,
}
string ,
quotaChangeRequests:
{
Description: This property is required for providing the region and new quota limits. ,
Required: False ,
}
[
{
region:
{
Description: Region for which the quota increase request is being made. ,
Required: False ,
}
string ,
payload:
{
Description: Payload of the quota increase request. ,
Required: False ,
}
string ,
}
,
]
,
}
,
secondaryConsent:
{
Description: This property indicates secondary consents for the support ticket ,
Required: False ,
}
[
{
userConsent:
{
Description: User consent value provided ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ChatTranscripts_List (removed)
Description :  Lists all chat transcripts for a support ticket under subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/chatTranscripts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: [Placeholder] Description for nextLink property ,
Required: False ,
}
string ,
value:
{
Description: [Placeholder] Description for value property ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the resource. ,
Required: False ,
}
{
messages:
{
Description: List of chat transcript communication resources. ,
Required: False ,
}
[
{
contentType:
{
Description: Content type. ,
Required: False ,
}
string ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Name of the sender. ,
Required: False ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: Time in UTC (ISO 8601 format) when the chat began. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ChatTranscripts_Get (removed)
Description :  Returns chatTranscript details for a support ticket under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/chatTranscripts/{chatTranscriptName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
chatTranscriptName:
{
Description: The name of the ChatTranscriptDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: False ,
}
{
messages:
{
Description: List of chat transcript communication resources. ,
Required: False ,
}
[
{
contentType:
{
Description: Content type. ,
Required: False ,
}
string ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Name of the sender. ,
Required: False ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: False ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: Time in UTC (ISO 8601 format) when the chat began. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Communications_CheckNameAvailability (removed)
Description :  Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication to the support ticket.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
checkNameAvailabilityInput:
{
Description: Input to check. ,
Required: True ,
}
{
name:
{
Description: The resource name to validate. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource. ,
Enum:
{
Microsoft.Support/supportTickets: No description available. ,
Microsoft.Support/communications: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates whether the name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the name is not available. ,
Required: False ,
}
string ,
message:
{
Description: The detailed error message describing why the name is not available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Communications_List (removed)
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 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
$top:
{
Description: The number of values to return in the collection. Default is 10 and max is 10. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: [Placeholder] Description for nextLink property ,
Required: False ,
}
string ,
value:
{
Description: [Placeholder] Description for value property ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
communicationType:
{
Description: Communication type. ,
Enum:
{
web: No description available. ,
phone: No description available. ,
}
,
Required: False ,
}
enum ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Email address of the sender. This property is required if called by a service principal. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the communication. ,
Required: True ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: True ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Communications_Get (removed)
Description :  Returns communication details for a support ticket.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
communicationName:
{
Description: The name of the CommunicationDetails ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
communicationType:
{
Description: Communication type. ,
Enum:
{
web: No description available. ,
phone: No description available. ,
}
,
Required: False ,
}
enum ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Email address of the sender. This property is required if called by a service principal. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the communication. ,
Required: True ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: True ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Communications_Create (removed)
Description :  Adds a new customer communication to an Azure support ticket.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
supportTicketName:
{
Description: The name of the SupportTicketDetails ,
Required: True ,
}
string ,
communicationName:
{
Description: The name of the CommunicationDetails ,
Required: True ,
}
string ,
createCommunicationParameters:
{
Description: Communication object. ,
Required: True ,
}
{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
communicationType:
{
Description: Communication type. ,
Enum:
{
web: No description available. ,
phone: No description available. ,
}
,
Required: False ,
}
enum ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Email address of the sender. This property is required if called by a service principal. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the communication. ,
Required: True ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: True ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the resource. ,
Required: True ,
}
{
communicationType:
{
Description: Communication type. ,
Enum:
{
web: No description available. ,
phone: No description available. ,
}
,
Required: False ,
}
enum ,
communicationDirection:
{
Description: Direction of communication. ,
Enum:
{
inbound: No description available. ,
outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sender:
{
Description: Email address of the sender. This property is required if called by a service principal. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the communication. ,
Required: True ,
}
string ,
body:
{
Description: Body of the communication. ,
Required: True ,
}
string ,
createdDate:
{
Description: Time in UTC (ISO 8601 format) when the communication was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}