swagger: '2.0'
info:
version: 2020-08-01-preview
title: Microsoft Azure AccessControlClient AccessConnector SupportTickets API
schemes:
- https
tags:
- name: SupportTickets
paths:
/subscriptions/{subscriptionId}/providers/Microsoft.Support/checkNameAvailability:
post:
tags:
- SupportTickets
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.
operationId: microsoftAzureSupportticketsChecknameavailability
x-ms-examples:
Checks whether name is available for SupportTicket resource:
$ref: ./examples/CheckNameAvailabilityWithSubscription.json
parameters:
- name: checkNameAvailabilityInput
in: body
description: Input to check.
required: true
schema:
$ref: '#/definitions/CheckNameAvailabilityInput'
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: OK. The request has succeeded.
schema:
$ref: '#/definitions/CheckNameAvailabilityOutput'
default:
description: Error response describing why the operation failed.
schema:
$ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Support Checknameavailability
/providers/Microsoft.Support/checkNameAvailability:
post:
tags:
- SupportTickets
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.
operationId: microsoftAzureSupportticketsnosubscriptionChecknameavailability
x-ms-examples:
Checks whether name is available for SupportTicket resource:
$ref: ./examples/CheckNameAvailability.json
parameters:
- name: checkNameAvailabilityInput
in: body
description: Input to check.
required: true
schema:
$ref: '#/definitions/CheckNameAvailabilityInput'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: OK. The request has succeeded.
schema:
$ref: '#/definitions/CheckNameAvailabilityOutput'
default:
description: Error response describing why the operation failed.
schema:
$ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
summary: Microsoft Azure Post Providers Microsoft Support Checknameavailability
/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets:
get:
tags:
- SupportTickets
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.
operationId: microsoftAzureSupportticketsList
parameters:
- name: $top
in: query
description: The number of values to return in the collection. Default is 25 and max is 100.
required: false
type: integer
format: int32
- name: $filter
in: query
required: false
type: string
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'.
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: Successfully retrieved support tickets.
schema:
$ref: '#/definitions/SupportTicketsListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
List support tickets for a subscription:
$ref: ./examples/ListSupportTicketsBySubscription.json
List support tickets in open state for a subscription:
$ref: ./examples/ListSupportTicketsInOpenStateBySubscription.json
List support tickets created on or after a certain date and in open state for a subscription:
$ref: ./examples/ListSupportTicketsCreatedOnOrAfterAndInOpenStateBySubscription.json
List support tickets in updating state for a subscription:
$ref: ./examples/ListSupportTicketsInUpdatingStateBySubscription.json
List support tickets created on or after a certain date and in updating state for a subscription:
$ref: ./examples/ListSupportTicketsCreatedOnOrAfterAndInUpdatingStateBySubscription.json
List support tickets with a certain service id for a subscription:
$ref: ./examples/ListSupportTicketsServiceIdEqualsForSubscription.json
List support tickets with a certain problem classification id for a subscription:
$ref: ./examples/ListSupportTicketsProblemClassificationIdEqualsForSubscription.json
summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Support Supporttickets
/providers/Microsoft.Support/supportTickets:
get:
tags:
- SupportTickets
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.
operationId: microsoftAzureSupportticketsnosubscriptionList
parameters:
- name: $top
in: query
description: The number of values to return in the collection. Default is 25 and max is 100.
required: false
type: integer
format: int32
- name: $filter
in: query
required: false
type: string
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'.
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: Successfully retrieved support tickets.
schema:
$ref: '#/definitions/SupportTicketsListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
List support tickets for a subscription:
$ref: ./examples/ListSupportTickets.json
List support tickets in open state for a subscription:
$ref: ./examples/ListSupportTicketsInOpenState.json
List support tickets created on or after a certain date and in open state for a subscription:
$ref: ./examples/ListSupportTicketsCreatedOnOrAfterAndInOpenState.json
List support tickets in updating state for a subscription:
$ref: ./examples/ListSupportTicketsInUpdatingState.json
List support tickets created on or after a certain date and in updating state for a subscription:
$ref: ./examples/ListSupportTicketsCreatedOnOrAfterAndInUpdatingState.json
List support tickets with a certain service id for a subscription:
$ref: ./examples/ListSupportTicketsServiceIdEquals.json
List support tickets with a certain problem classification id for a subscription:
$ref: ./examples/ListSupportTicketsProblemClassificationIdEquals.json
summary: Microsoft Azure Get Providers Microsoft Support Supporttickets
/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}:
get:
tags:
- SupportTickets
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.
operationId: microsoftAzureSupportticketsGet
parameters:
- name: supportTicketName
in: path
description: Support ticket name.
required: true
type: string
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: Successfully retrieved support ticket.
schema:
$ref: '#/definitions/SupportTicketDetails'
default:
description: Error response describing why the operation failed.
schema:
$ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Get details of a subscription ticket:
$ref: ./examples/GetSubscriptionSupportTicketDetails.json
summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Support Supporttickets Supportticketname
patch:
tags:
- SupportTickets
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.'
operationId: microsoftAzureSupportticketsUpdate
parameters:
- name: supportTicketName
in: path
description: Support ticket name.
required: true
type: string
- name: updateSupportTicket
in: body
description: UpdateSupportTicket object.
required: true
schema:
$ref: '#/definitions/UpdateSupportTicket'
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: Successfully updated support ticket.
schema:
$ref: '#/definitions/SupportTicketDetails'
default:
description: Error response describing why the operation failed.
schema:
$ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Update severity of a support ticket:
$ref: ./examples/UpdateSeverityOfSupportTicketForSubscription.json
Update contact details of a support ticket:
$ref: ./examples/UpdateContactDetailsOfSupportTicketForSubscription.json
Update status of a support ticket:
$ref: ./examples/UpdateStatusOfSupportTicketForSubscription.json
Update advanced diagnostic consent of a support ticket:
$ref: ./examples/UpdateAdvancedDiagnosticConsentOfSupportTicketForSubscription.json
summary: Microsoft Azure Patch Subscriptions Subscriptionid Providers Microsoft Support Supporttickets Supportticketname
put:
tags:
- SupportTickets
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.'
operationId: microsoftAzureSupportticketsCreate
parameters:
- name: supportTicketName
in: path
description: Support ticket name.
required: true
type: string
- name: createSupportTicketParameters
in: body
description: Support ticket request payload.
required: true
schema:
$ref: '#/definitions/SupportTicketDetails'
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: OK - SupportTicket created successfully.
schema:
$ref: '#/definitions/SupportTicketDetails'
'202':
description: Accepted, SupportTicket will be created asynchronously.
default:
description: Error response describing why the operation failed.
schema:
$ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-examples:
Create a ticket for Billing related issues:
$ref: ./examples/CreateBillingSupportTicketForSubscription.json
Create a ticket for Subscription Management related issues:
$ref: ./examples/CreateSubMgmtSupportTicketForSubscription.json
Create a ticket for Technical issue related to a specific resource:
$ref: ./examples/CreateTechnicalSupportTicketForSubscription.json
Create a ticket to request Quota increase for Compute VM Cores:
$ref: ./examples/CreateCoresQuotaTicketForSubscription.json
Create a ticket to request Quota increase for Low-priority cores for a Batch account:
$ref: ./examples/CreateBatchQuotaTicketForSpecificBatchAccountForLowPriorityCores.json
Create a ticket to request Quota increase for specific VM family cores for a Batch account:
$ref: ./examples/CreateBatchQuotaTicketForSpecificBatchAccountForDedicatedCores.json
Create a ticket to request Quota increase for Pools for a Batch account:
$ref: ./examples/CreateBatchQuotaTicketForSpecificBatchAccountForPools.json
Create a ticket to request Quota increase for Active Jobs and Job Schedules for a Batch account:
$ref: ./examples/CreateBatchQuotaTicketForSpecificBatchAccountForActiveJobs.json
Create a ticket to request Quota increase for Batch accounts for a subscription:
$ref: ./examples/CreateBatchQuotaTicketForSubscription.json
Create a ticket to request Quota increase for DTUs for SQL Database:
$ref: ./examples/CreateSqlDatabaseQuotaTicketForDTUs.json
Create a ticket to request Quota increase for Servers for SQL Database:
$ref: ./examples/CreateSqlDatabaseQuotaTicketForServers.json
Create a ticket to request Quota increase for DTUs for Azure Synapse Analytics:
$ref: ./examples/CreateSqlDatawarehouseQuotaTicketForDTUs.json
Create a ticket to request Quota increase for Servers for Azure Synapse Analytics:
$ref: ./examples/CreateSqlDatawarehouseQuotaTicketForServers.json
Create a ticket to request Quota increase for specific VM family cores for Machine Learning service:
$ref: ./examples/CreateMachineLearningQuotaTicketForDedicatedCores.json
Create a ticket to request Quota increase for Low-priority cores for Machine Learning service:
$ref: ./examples/CreateMachineLearningQuotaTicketForLowPriorityCores.json
Create a ticket to request Quota increase for Azure SQL managed instance:
$ref: ./examples/CreateSqlManagedInstanceQuotaTicket.json
? Create a ticket to request Quota increase for services that do not require additional details in the quotaTicketDetails object
: $ref: ./examples/CreateGenericQuotaTicket.json
summary: Microsoft Azure Put Subscriptions Subscriptionid Providers Microsoft Support Supporttickets Supportticketname
/providers/Microsoft.Support/supportTickets/{supportTicketName}:
get:
tags:
- SupportTickets
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.
operationId: microsoftAzureSupportticketsnosubscriptionGet
parameters:
- name: supportTicketName
in: path
description: Support ticket name.
required: true
type: string
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: Successfully retrieved support ticket.
schema:
$ref: '#/definitions/SupportTicketDetails'
default:
description: Error response describing why the operation failed.
schema:
$ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Get details of a ticket:
$ref: ./examples/GetSupportTicketDetails.json
summary: Microsoft Azure Get Providers Microsoft Support Supporttickets Supportticketname
patch:
tags:
- SupportTickets
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.'
operationId: microsoftAzureSupportticketsnosubscriptionUpdate
parameters:
- name: supportTicketName
in: path
description: Support ticket name.
required: true
type: string
- name: updateSupportTicket
in: body
description: UpdateSupportTicket object.
required: true
schema:
$ref: '#/definitions/UpdateSupportTicket'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: Successfully updated support ticket.
schema:
$ref: '#/definitions/SupportTicketDetails'
default:
description: Error response describing why the operation failed.
schema:
$ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Update severity of a support ticket:
$ref: ./examples/UpdateSeverityOfSupportTicket.json
Update contact details of a support ticket:
$ref: ./examples/UpdateContactDetailsOfSupportTicket.json
Update status of a support ticket:
$ref: ./examples/UpdateStatusOfSupportTicket.json
Update advanced diagnostic consent of a support ticket:
$ref: ./examples/UpdateAdvancedDiagnosticConsentOfSupportTicket.json
summary: Microsoft Azure Patch Providers Microsoft Support Supporttickets Supportticketname
put:
tags:
- SupportTickets
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.
operationId: microsoftAzureSupportticketsnosubscriptionCreate
parameters:
- name: supportTicketName
in: path
description: Support ticket name.
required: true
type: string
- name: createSupportTicketParameters
in: body
description: Support ticket request payload.
required: true
schema:
$ref: '#/definitions/SupportTicketDetails'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: OK - SupportTicket created successfully.
schema:
$ref: '#/definitions/SupportTicketDetails'
'202':
description: Accepted, SupportTicket will be created asynchronously.
headers:
Location:
type: string
default:
description: Error response describing why the operation failed.
schema:
$ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-examples:
Create a ticket for Billing related issues:
$ref: ./examples/CreateBillingSupportTicket.json
Create a ticket for Subscription Management related issues:
$ref: ./examples/CreateSubMgmtSupportTicket.json
Create a ticket for Technical issue related to a specific resource:
$ref: ./examples/CreateTechnicalSupportTicket.json
summary: Microsoft Azure Put Providers Microsoft Support Supporttickets Supportticketname
definitions:
QuotaChangeRequest:
description: This property is required for providing the region and new quota limits.
type: object
properties:
region:
description: Region for which the quota increase request is being made.
type: string
payload:
description: Payload of the quota increase request.
type: string
TechnicalTicketDetails:
description: Additional information for technical support ticket.
type: object
properties:
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.'
type: string
UpdateSupportTicket:
description: Updates severity, ticket status, and contact details in the support ticket.
type: object
properties:
severity:
description: Severity level.
enum:
- minimal
- moderate
- critical
- highestcriticalimpact
type: string
x-ms-enum:
name: SeverityLevel
modelAsString: true
status:
description: Status to be updated on the ticket.
enum:
- open
- closed
type: string
x-ms-enum:
name: Status
modelAsString: true
contactDetails:
$ref: '#/definitions/UpdateContactProfile'
description: Contact details to be updated on the support ticket.
advancedDiagnosticConsent:
description: Advanced diagnostic consent to be updated on the support ticket.
enum:
- 'Yes'
- 'No'
type: string
x-ms-enum:
name: Consent
modelAsString: true
secondaryConsent:
description: This property indicates secondary consents for the support ticket
type: array
items:
$ref: '#/definitions/SecondaryConsent'
x-ms-identifiers: []
ServiceLevelAgreement:
description: Service Level Agreement details for a support ticket.
type: object
properties:
startTime:
format: date-time
description: Time in UTC (ISO 8601 format) when the service level agreement starts.
type: string
readOnly: true
expirationTime:
format: date-time
description: Time in UTC (ISO 8601 format) when the service level agreement expires.
type: string
readOnly: true
slaMinutes:
description: Service Level Agreement in minutes.
type: integer
format: int32
readOnly: true
SupportTicketDetailsProperties:
description: Describes the properties of a support ticket.
required:
- serviceId
- title
- description
- problemClassificationId
- severity
- contactDetails
type: object
properties:
supportTicketId:
description: System generated support ticket Id that is unique.
type: string
description:
description: Detailed description of the question or issue.
type: 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.
type: string
problemClassificationDisplayName:
type: string
description: Localized name of problem classification.
readOnly: true
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
- moderate
- critical
- highestcriticalimpact
type: string
x-ms-enum:
name: SeverityLevel
modelAsString: true
enrollmentId:
description: Enrollment Id associated with the support ticket.
type: string
readOnly: true
require24X7Response:
description: Indicates if this requires a 24x7 response from Azure.
type: boolean
advancedDiagnosticConsent:
description: Advanced diagnostic consent to be updated on the support ticket.
enum:
- 'Yes'
- 'No'
type: string
x-ms-enum:
name: Consent
modelAsString: true
problemScopingQuestions:
description: Problem scoping questions associated with the support ticket.
type: string
supportPlanId:
description: Support plan id associated with the support ticket.
type: string
contactDetails:
$ref: '#/definitions/ContactProfile'
description: Contact information of the user requesting to create a support ticket.
serviceLevelAgreement:
$ref: '#/definitions/ServiceLevelAgreement'
description: Service Level Agreement information for this support ticket.
supportEngineer:
$ref: '#/definitions/SupportEngineer'
description: Information about the support engineer working on this support ticket.
supportPlanType:
description: Support plan type associated with the support ticket.
type: string
readOnly: true
supportPlanDisplayName:
description: Support plan type associated with the support ticket.
type: string
readOnly: true
title:
description: Title of the support ticket.
type: string
problemStartTime:
format: date-time
description: Time in UTC (ISO 8601 format) when the problem started.
type: string
serviceId:
description: This is the resource Id of the Azure service resource associated with the support ticket.
type: string
serviceDisplayName:
type: string
description: Localized name of the Azure service.
readOnly: true
status:
description: Status of the support ticket.
type: string
readOnly: true
createdDate:
format: date-time
description: Time in UTC (ISO 8601 format) when the support ticket was created.
type: string
readOnly: true
modifiedDate:
format: date-time
description: Time in UTC (ISO 8601 format) when the support ticket was last modified.
type: string
readOnly: true
fileWorkspaceName:
description: File workspace name.
type: string
isTemporaryTicket:
description: This property indicates if support ticket is a temporary ticket.
enum:
- 'Yes'
- 'No'
type: string
x-ms-enum:
name: IsTemporaryTicket
modelAsString: true
readOnly: true
technicalTicketDetails:
$ref: '#/definitions/TechnicalTicketDetails'
description: Additional ticket details associated with a technical support ticket request.
quotaTicketDetails:
$ref: '#/definitions/QuotaTicketDetails'
description: Additional ticket details associated with a quota support ticket request.
secondaryConsent:
description: This property indicates secondary consents for the support ticket
type: array
items:
$ref: '#/definitions/SecondaryConsent'
x-ms-identifiers: []
ContactProfile:
description: Contact information associated with the support ticket.
required:
- firstName
- lastName
- preferredContactMethod
- primaryEmailAddress
- preferredTimeZone
- country
- preferredSupportLanguage
type: object
properties:
firstName:
description: First name.
type: string
lastName:
description: Last name.
type: string
preferredContactMethod:
description: Preferred contact method.
enum:
- email
- phone
type: string
x-ms-enum:
name: PreferredContactMethod
modelAsString: true
primaryEmailAddress:
description: Primary email address.
type: string
additionalEmailAddresses:
description: Additional email addresses listed will be copied on any correspondence about the support ticket.
type: array
items:
type: string
phoneNumber:
description: Phone number. This is required if preferred contact method is phone.
type: 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).
type: string
country:
description: Country of the user. This is the ISO 3166-1 alpha-3 code.
type: 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.
type: string
CheckNameAvailabilityInput:
description: Input of CheckNameAvailability API.
type: object
required:
- name
- type
properties:
name:
description: The resource name to validate.
type: string
type:
type: string
enum:
- Microsoft.Support/supportTickets
- Microsoft.Support/communications
x-ms-enum:
name: Type
modelAsString: false
description: The type of resource.
SupportTicketsListResult:
description: Object that represents a collection of SupportTicket resources.
type: object
properties:
value:
description: List of SupportTicket resources.
type: array
items:
$ref: '#/definitions/SupportTicketDetails'
nextLink:
description: The URI to fetch the next page of SupportTicket resources.
type: string
QuotaTicketDetails:
description: 'Additional set of information required for quota increase support ticket for certain quota types, e.g.: Virtual machine cores. Get complete details about Quota payload support request along with examples at [Support quota request](https://aka.ms/supportrpquotarequestpayload).'
type: object
properties:
quotaChangeRequestSubType:
description: Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase.
type: string
quotaChangeRequestVersion:
description: Quota change request version.
type: string
quotaChangeRequests:
description: This property is required for providing the region and new quota limits.
type: array
items:
$ref: '#/definitions/QuotaChangeRequest'
x-ms-identifiers:
- region
SupportEngineer:
description: Support engineer information.
type: object
properties:
emailAddress:
description: Email address of the Azure Support engineer assigned to the support ticket.
type: string
readOnly: true
SupportTicketDetails:
x-ms-azure-resource: true
description: Object that represents SupportTicketDetails resource.
type: object
properties:
id:
description: Id of the resource.
type: string
readOnly: true
name:
description: Name of the resource.
type: string
readOnly: true
type:
description: Type of the resource 'Microsoft.Support/supportTickets'.
type: string
readOnly: true
properties:
x-ms-client-flatten: true
$ref: '#/definitions/SupportTicketDetailsProperties'
description: Properties of the resource.
CheckNameAvailabilityOutput:
description: Output of check name availability API.
type: object
properties:
nameAvailable:
description: Indicates whether the name is available.
readOnly: true
type: boolean
reason:
description: The reason why the name is not available.
readOnly: true
type: string
message:
description: The detailed error message describing why the name is not available.
readOnly: true
type: string
SecondaryConsent:
description: This property indicates secondary consent for the support ticket.
type: object
properties:
userConsent:
description: User consent value provided
enum:
- 'Yes'
- 'No'
type: string
x-ms-enum:
name: UserConsent
modelAsString: true
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.
type: string
UpdateContactProfile:
description: Contact information associated with the support ticket.
type: object
properties:
firstName:
description: First name.
type: string
lastName:
description: Last name.
type: string
preferredContactMethod:
description: Preferred contact method.
enum:
- email
- phone
type: string
x-ms-enum:
name: PreferredContactMethod
modelAsString: true
primaryEmailAddress:
description: Primary email address.
type: string
additionalEmailAddresses:
description: Email addresses listed will be copied on any correspondence about the support ticket.
type: array
items:
type: string
phoneNumber:
description: Phone number. This is required if preferred contact method is phone.
type: 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).
type: string
country:
description: Country of the user. This is the ISO 3166-1 alpha-3 code.
type: 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.
type: string
parameters:
ApiVersionParameter:
name: api-version
in: query
required: true
type: string
description: API version.
SubscriptionIdParameter:
name: subscriptionId
in: path
required: true
type: string
description: Azure subscription Id.
x-ms-parameterized-host:
hostTemplate: '{endpoint}'
useSchemePrefix: false
parameters:
- $ref: '#/parameters/Endpoint'