Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The supportTickets resource type can be deployed with operations that target:
- Tenant - See tenant deployment commands* Subscription - See subscription deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Support/supportTickets resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Support/supportTickets@2022-09-01-preview' = {
name: 'string'
properties: {
advancedDiagnosticConsent: 'string'
contactDetails: {
additionalEmailAddresses: [
'string'
]
country: 'string'
firstName: 'string'
lastName: 'string'
phoneNumber: 'string'
preferredContactMethod: 'string'
preferredSupportLanguage: 'string'
preferredTimeZone: 'string'
primaryEmailAddress: 'string'
}
description: 'string'
fileWorkspaceName: 'string'
problemClassificationId: 'string'
problemScopingQuestions: 'string'
problemStartTime: 'string'
quotaTicketDetails: {
quotaChangeRequests: [
{
payload: 'string'
region: 'string'
}
]
quotaChangeRequestSubType: 'string'
quotaChangeRequestVersion: 'string'
}
require24X7Response: bool
secondaryConsent: [
{
type: 'string'
userConsent: 'string'
}
]
serviceId: 'string'
serviceLevelAgreement: {}
severity: 'string'
supportEngineer: {}
supportPlanId: 'string'
supportTicketId: 'string'
technicalTicketDetails: {
resourceId: 'string'
}
title: 'string'
}
}
Property Values
Microsoft.Support/supportTickets
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| properties | Properties of the resource. | SupportTicketDetailsProperties |
ContactProfile
| Name | Description | Value |
|---|---|---|
| additionalEmailAddresses | Additional email addresses listed will be copied on any correspondence about the support ticket. | string[] |
| country | Country/region of the user. This is the ISO 3166-1 alpha-3 code. | string (required) |
| firstName | First name. | string (required) |
| lastName | Last name. | string (required) |
| phoneNumber | Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. | string |
| preferredContactMethod | Preferred contact method. | 'email' 'phone' (required) |
| preferredSupportLanguage | 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. 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. | string (required) |
| preferredTimeZone | Time zone of the user. This is the name of the time zone from Microsoft Time Zone Index Values. | string (required) |
| primaryEmailAddress | Primary email address. | string (required) |
QuotaChangeRequest
| Name | Description | Value |
|---|---|---|
| payload | Payload of the quota increase request. | string |
| region | Region for which the quota increase request is being made. | string |
QuotaTicketDetails
| Name | Description | Value |
|---|---|---|
| quotaChangeRequests | This property is required for providing the region and new quota limits. | QuotaChangeRequest[] |
| quotaChangeRequestSubType | Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. | string |
| quotaChangeRequestVersion | Quota change request version. | string |
SecondaryConsent
| Name | Description | Value |
|---|---|---|
| type | The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. | string |
| userConsent | User consent value provided | 'No' 'Yes' |
ServiceLevelAgreement
| Name | Description | Value |
|---|
SupportEngineer
| Name | Description | Value |
|---|
SupportTicketDetailsProperties
| Name | Description | Value |
|---|---|---|
| advancedDiagnosticConsent | Advanced diagnostic consent to be updated on the support ticket. | 'No' 'Yes' |
| contactDetails | Contact information of the user requesting to create a support ticket. | ContactProfile (required) |
| description | Detailed description of the question or issue. | string (required) |
| fileWorkspaceName | File workspace name. | string |
| problemClassificationId | 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. | string (required) |
| problemScopingQuestions | Problem scoping questions associated with the support ticket. | string |
| problemStartTime | Time in UTC (ISO 8601 format) when the problem started. | string |
| quotaTicketDetails | Additional ticket details associated with a quota support ticket request. | QuotaTicketDetails |
| require24X7Response | Indicates if this requires a 24x7 response from Azure. | bool |
| secondaryConsent | This property indicates secondary consents for the support ticket | SecondaryConsent[] |
| serviceId | This is the resource Id of the Azure service resource associated with the support ticket. | string (required) |
| serviceLevelAgreement | Service Level Agreement information for this support ticket. | ServiceLevelAgreement |
| severity | 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. | 'critical' 'highestcriticalimpact' 'minimal' 'moderate' (required) |
| supportEngineer | Information about the support engineer working on this support ticket. | SupportEngineer |
| supportPlanId | Support plan id associated with the support ticket. | string |
| supportTicketId | System generated support ticket Id that is unique. | string |
| technicalTicketDetails | Additional ticket details associated with a technical support ticket request. | TechnicalTicketDetails |
| title | Title of the support ticket. | string (required) |
TechnicalTicketDetails
| Name | Description | Value |
|---|---|---|
| resourceId | 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. | string |
ARM template resource definition
The supportTickets resource type can be deployed with operations that target:
- Tenant - See tenant deployment commands* Subscription - See subscription deployment commands For a list of changed properties in each API version, see change log.
Usage Examples
Resource format
To create a Microsoft.Support/supportTickets resource, add the following JSON to your template.
{
"type": "Microsoft.Support/supportTickets",
"apiVersion": "2022-09-01-preview",
"name": "string",
"properties": {
"advancedDiagnosticConsent": "string",
"contactDetails": {
"additionalEmailAddresses": [ "string" ],
"country": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"preferredContactMethod": "string",
"preferredSupportLanguage": "string",
"preferredTimeZone": "string",
"primaryEmailAddress": "string"
},
"description": "string",
"fileWorkspaceName": "string",
"problemClassificationId": "string",
"problemScopingQuestions": "string",
"problemStartTime": "string",
"quotaTicketDetails": {
"quotaChangeRequests": [
{
"payload": "string",
"region": "string"
}
],
"quotaChangeRequestSubType": "string",
"quotaChangeRequestVersion": "string"
},
"require24X7Response": "bool",
"secondaryConsent": [
{
"type": "string",
"userConsent": "string"
}
],
"serviceId": "string",
"serviceLevelAgreement": {
},
"severity": "string",
"supportEngineer": {
},
"supportPlanId": "string",
"supportTicketId": "string",
"technicalTicketDetails": {
"resourceId": "string"
},
"title": "string"
}
}
Property Values
Microsoft.Support/supportTickets
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2022-09-01-preview' |
| name | The resource name | string (required) |
| properties | Properties of the resource. | SupportTicketDetailsProperties |
| type | The resource type | 'Microsoft.Support/supportTickets' |
ContactProfile
| Name | Description | Value |
|---|---|---|
| additionalEmailAddresses | Additional email addresses listed will be copied on any correspondence about the support ticket. | string[] |
| country | Country/region of the user. This is the ISO 3166-1 alpha-3 code. | string (required) |
| firstName | First name. | string (required) |
| lastName | Last name. | string (required) |
| phoneNumber | Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. | string |
| preferredContactMethod | Preferred contact method. | 'email' 'phone' (required) |
| preferredSupportLanguage | 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. 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. | string (required) |
| preferredTimeZone | Time zone of the user. This is the name of the time zone from Microsoft Time Zone Index Values. | string (required) |
| primaryEmailAddress | Primary email address. | string (required) |
QuotaChangeRequest
| Name | Description | Value |
|---|---|---|
| payload | Payload of the quota increase request. | string |
| region | Region for which the quota increase request is being made. | string |
QuotaTicketDetails
| Name | Description | Value |
|---|---|---|
| quotaChangeRequests | This property is required for providing the region and new quota limits. | QuotaChangeRequest[] |
| quotaChangeRequestSubType | Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. | string |
| quotaChangeRequestVersion | Quota change request version. | string |
SecondaryConsent
| Name | Description | Value |
|---|---|---|
| type | The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. | string |
| userConsent | User consent value provided | 'No' 'Yes' |
ServiceLevelAgreement
| Name | Description | Value |
|---|
SupportEngineer
| Name | Description | Value |
|---|
SupportTicketDetailsProperties
| Name | Description | Value |
|---|---|---|
| advancedDiagnosticConsent | Advanced diagnostic consent to be updated on the support ticket. | 'No' 'Yes' |
| contactDetails | Contact information of the user requesting to create a support ticket. | ContactProfile (required) |
| description | Detailed description of the question or issue. | string (required) |
| fileWorkspaceName | File workspace name. | string |
| problemClassificationId | 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. | string (required) |
| problemScopingQuestions | Problem scoping questions associated with the support ticket. | string |
| problemStartTime | Time in UTC (ISO 8601 format) when the problem started. | string |
| quotaTicketDetails | Additional ticket details associated with a quota support ticket request. | QuotaTicketDetails |
| require24X7Response | Indicates if this requires a 24x7 response from Azure. | bool |
| secondaryConsent | This property indicates secondary consents for the support ticket | SecondaryConsent[] |
| serviceId | This is the resource Id of the Azure service resource associated with the support ticket. | string (required) |
| serviceLevelAgreement | Service Level Agreement information for this support ticket. | ServiceLevelAgreement |
| severity | 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. | 'critical' 'highestcriticalimpact' 'minimal' 'moderate' (required) |
| supportEngineer | Information about the support engineer working on this support ticket. | SupportEngineer |
| supportPlanId | Support plan id associated with the support ticket. | string |
| supportTicketId | System generated support ticket Id that is unique. | string |
| technicalTicketDetails | Additional ticket details associated with a technical support ticket request. | TechnicalTicketDetails |
| title | Title of the support ticket. | string (required) |
TechnicalTicketDetails
| Name | Description | Value |
|---|---|---|
| resourceId | 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. | string |
Terraform (AzAPI provider) resource definition
The supportTickets resource type can be deployed with operations that target:
- Tenant* Subscription For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Support/supportTickets resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Support/supportTickets@2022-09-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
advancedDiagnosticConsent = "string"
contactDetails = {
additionalEmailAddresses = [
"string"
]
country = "string"
firstName = "string"
lastName = "string"
phoneNumber = "string"
preferredContactMethod = "string"
preferredSupportLanguage = "string"
preferredTimeZone = "string"
primaryEmailAddress = "string"
}
description = "string"
fileWorkspaceName = "string"
problemClassificationId = "string"
problemScopingQuestions = "string"
problemStartTime = "string"
quotaTicketDetails = {
quotaChangeRequests = [
{
payload = "string"
region = "string"
}
]
quotaChangeRequestSubType = "string"
quotaChangeRequestVersion = "string"
}
require24X7Response = bool
secondaryConsent = [
{
type = "string"
userConsent = "string"
}
]
serviceId = "string"
serviceLevelAgreement = {
}
severity = "string"
supportEngineer = {
}
supportPlanId = "string"
supportTicketId = "string"
technicalTicketDetails = {
resourceId = "string"
}
title = "string"
}
}
}
Property Values
Microsoft.Support/supportTickets
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| properties | Properties of the resource. | SupportTicketDetailsProperties |
| type | The resource type | "Microsoft.Support/supportTickets@2022-09-01-preview" |
ContactProfile
| Name | Description | Value |
|---|---|---|
| additionalEmailAddresses | Additional email addresses listed will be copied on any correspondence about the support ticket. | string[] |
| country | Country/region of the user. This is the ISO 3166-1 alpha-3 code. | string (required) |
| firstName | First name. | string (required) |
| lastName | Last name. | string (required) |
| phoneNumber | Phone number. This is required if preferred contact method is phone. It is also required when submitting 'critical' or 'highestcriticalimpact' severity cases. | string |
| preferredContactMethod | Preferred contact method. | 'email' 'phone' (required) |
| preferredSupportLanguage | 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. 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. | string (required) |
| preferredTimeZone | Time zone of the user. This is the name of the time zone from Microsoft Time Zone Index Values. | string (required) |
| primaryEmailAddress | Primary email address. | string (required) |
QuotaChangeRequest
| Name | Description | Value |
|---|---|---|
| payload | Payload of the quota increase request. | string |
| region | Region for which the quota increase request is being made. | string |
QuotaTicketDetails
| Name | Description | Value |
|---|---|---|
| quotaChangeRequests | This property is required for providing the region and new quota limits. | QuotaChangeRequest[] |
| quotaChangeRequestSubType | Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. | string |
| quotaChangeRequestVersion | Quota change request version. | string |
SecondaryConsent
| Name | Description | Value |
|---|---|---|
| type | The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response. | string |
| userConsent | User consent value provided | 'No' 'Yes' |
ServiceLevelAgreement
| Name | Description | Value |
|---|
SupportEngineer
| Name | Description | Value |
|---|
SupportTicketDetailsProperties
| Name | Description | Value |
|---|---|---|
| advancedDiagnosticConsent | Advanced diagnostic consent to be updated on the support ticket. | 'No' 'Yes' |
| contactDetails | Contact information of the user requesting to create a support ticket. | ContactProfile (required) |
| description | Detailed description of the question or issue. | string (required) |
| fileWorkspaceName | File workspace name. | string |
| problemClassificationId | 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. | string (required) |
| problemScopingQuestions | Problem scoping questions associated with the support ticket. | string |
| problemStartTime | Time in UTC (ISO 8601 format) when the problem started. | string |
| quotaTicketDetails | Additional ticket details associated with a quota support ticket request. | QuotaTicketDetails |
| require24X7Response | Indicates if this requires a 24x7 response from Azure. | bool |
| secondaryConsent | This property indicates secondary consents for the support ticket | SecondaryConsent[] |
| serviceId | This is the resource Id of the Azure service resource associated with the support ticket. | string (required) |
| serviceLevelAgreement | Service Level Agreement information for this support ticket. | ServiceLevelAgreement |
| severity | 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. | 'critical' 'highestcriticalimpact' 'minimal' 'moderate' (required) |
| supportEngineer | Information about the support engineer working on this support ticket. | SupportEngineer |
| supportPlanId | Support plan id associated with the support ticket. | string |
| supportTicketId | System generated support ticket Id that is unique. | string |
| technicalTicketDetails | Additional ticket details associated with a technical support ticket request. | TechnicalTicketDetails |
| title | Title of the support ticket. | string (required) |
TechnicalTicketDetails
| Name | Description | Value |
|---|---|---|
| resourceId | 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. | string |