Support Tickets - Get

Serviço:

Support

Versão da API:

2024-04-01

Obtenha detalhes do tíquete para uma assinatura do Azure. Os dados do tíquete de suporte estão disponíveis por 18 meses após a criação do tíquete. Se um tíquete tiver sido criado há mais de 18 meses, uma solicitação de dados poderá causar um erro.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}?api-version=2024-04-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
supportTicketName	path	True	string	Nome do tíquete de suporte.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	SupportTicketDetails	Tíquete de suporte recuperado com êxito.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get details of a subscription ticket

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/132d901f-189d-4381-9214-fe68e27e05a1/providers/Microsoft.Support/supportTickets/testticket?api-version=2024-04-01

Java

/**
 * Samples for SupportTickets Get.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/support/resource-manager/Microsoft.Support/stable/2024-04-01/examples/
     * GetSubscriptionSupportTicketDetails.json
     */
    /**
     * Sample code: Get details of a subscription ticket.
     * 
     * @param manager Entry point to SupportManager.
     */
    public static void getDetailsOfASubscriptionTicket(com.azure.resourcemanager.support.SupportManager manager) {
        manager.supportTickets().getWithResponse("testticket", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.support import MicrosoftSupport

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-support
# USAGE
    python get_subscription_support_ticket_details.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MicrosoftSupport(
        credential=DefaultAzureCredential(),
        subscription_id="132d901f-189d-4381-9214-fe68e27e05a1",
    )

    response = client.support_tickets.get(
        support_ticket_name="testticket",
    )
    print(response)


# x-ms-original-file: specification/support/resource-manager/Microsoft.Support/stable/2024-04-01/examples/GetSubscriptionSupportTicketDetails.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armsupport_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/support/armsupport"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/106483d9f698ac3b6c0d481ab0c5fab14152e21f/specification/support/resource-manager/Microsoft.Support/stable/2024-04-01/examples/GetSubscriptionSupportTicketDetails.json
func ExampleTicketsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsupport.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewTicketsClient().Get(ctx, "testticket", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.TicketDetails = armsupport.TicketDetails{
	// 	Name: to.Ptr("testticket"),
	// 	Type: to.Ptr("Microsoft.Support/supportTickets"),
	// 	ID: to.Ptr("/subscriptions/132d901f-189d-4381-9214-fe68e27e05a1/providers/Microsoft.Support/supportTickets/testticket"),
	// 	Properties: &armsupport.TicketDetailsProperties{
	// 		Description: to.Ptr("This is a test - please ignore"),
	// 		AdvancedDiagnosticConsent: to.Ptr(armsupport.ConsentNo),
	// 		ContactDetails: &armsupport.ContactProfile{
	// 			Country: to.Ptr("USA"),
	// 			FirstName: to.Ptr("abc"),
	// 			LastName: to.Ptr("xyz"),
	// 			PreferredContactMethod: to.Ptr(armsupport.PreferredContactMethodEmail),
	// 			PreferredSupportLanguage: to.Ptr("en-US"),
	// 			PreferredTimeZone: to.Ptr("Pacific Standard Time"),
	// 			PrimaryEmailAddress: to.Ptr("abc@contoso.com"),
	// 		},
	// 		CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-20T21:36:18.000Z"); return t}()),
	// 		FileWorkspaceName: to.Ptr("6f16735c-1530836f-e9970f1a-2e49-47b7-96cd-9746b83aa066"),
	// 		ModifiedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-20T21:36:23.000Z"); return t}()),
	// 		ProblemClassificationDisplayName: to.Ptr("Add or Edit VAT, TAX ID, or PO Number"),
	// 		ProblemClassificationID: to.Ptr("/providers/Microsoft.Support/services/subscription_management_service_guid/problemClassifications/problemClassification_guid"),
	// 		Require24X7Response: to.Ptr(false),
	// 		ServiceDisplayName: to.Ptr("Subscription management"),
	// 		ServiceID: to.Ptr("/providers/Microsoft.Support/services/subscription_management_service_guid"),
	// 		ServiceLevelAgreement: &armsupport.ServiceLevelAgreement{
	// 			ExpirationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-21T17:36:18.000Z"); return t}()),
	// 			SLAMinutes: to.Ptr[int32](240),
	// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-20T21:36:18.000Z"); return t}()),
	// 		},
	// 		Severity: to.Ptr(armsupport.SeverityLevelMinimal),
	// 		Status: to.Ptr("Open"),
	// 		SupportEngineer: &armsupport.Engineer{
	// 			EmailAddress: to.Ptr("xyz@contoso.com"),
	// 		},
	// 		SupportPlanDisplayName: to.Ptr("Premier"),
	// 		SupportPlanID: to.Ptr("U291cmNlOlNDTSxDbGFyaWZ5SW5zdGFsbGF0aW9uU2l0ZUlkOjcsTGluZUl0ZW1JZDo5ODY1NzIyOSxDb250cmFjdElkOjk4NjU5MTk0LFN1YnNjcmlwdGlvbklkOjc2Y2I3N2ZhLThiMTctNGVhYi05NDkzLWI2NWRhY2U5OTgxMyw="),
	// 		SupportPlanType: to.Ptr("Premier"),
	// 		SupportTicketID: to.Ptr("118032014183770"),
	// 		Title: to.Ptr("Test - please ignore"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { MicrosoftSupport } = require("@azure/arm-support");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to 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.
 *
 * @summary 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.
 * x-ms-original-file: specification/support/resource-manager/Microsoft.Support/stable/2024-04-01/examples/GetSubscriptionSupportTicketDetails.json
 */
async function getDetailsOfASubscriptionTicket() {
  const subscriptionId =
    process.env["SUPPORT_SUBSCRIPTION_ID"] || "132d901f-189d-4381-9214-fe68e27e05a1";
  const supportTicketName = "testticket";
  const credential = new DefaultAzureCredential();
  const client = new MicrosoftSupport(credential, subscriptionId);
  const result = await client.supportTickets.get(supportTicketName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Support.Models;
using Azure.ResourceManager.Support;

// Generated from example definition: specification/support/resource-manager/Microsoft.Support/stable/2024-04-01/examples/GetSubscriptionSupportTicketDetails.json
// this example is just showing the usage of "SupportTickets_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionSupportTicketResource created on azure
// for more information of creating SubscriptionSupportTicketResource, please refer to the document of SubscriptionSupportTicketResource
string subscriptionId = "132d901f-189d-4381-9214-fe68e27e05a1";
string supportTicketName = "testticket";
ResourceIdentifier subscriptionSupportTicketResourceId = SubscriptionSupportTicketResource.CreateResourceIdentifier(subscriptionId, supportTicketName);
SubscriptionSupportTicketResource subscriptionSupportTicket = client.GetSubscriptionSupportTicketResource(subscriptionSupportTicketResourceId);

// invoke the operation
SubscriptionSupportTicketResource result = await subscriptionSupportTicket.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SupportTicketData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:

200

{
  "id": "/subscriptions/132d901f-189d-4381-9214-fe68e27e05a1/providers/Microsoft.Support/supportTickets/testticket",
  "name": "testticket",
  "type": "Microsoft.Support/supportTickets",
  "properties": {
    "supportTicketId": "118032014183770",
    "description": "This is a test - please ignore",
    "problemClassificationId": "/providers/Microsoft.Support/services/subscription_management_service_guid/problemClassifications/problemClassification_guid",
    "problemClassificationDisplayName": "Add or Edit VAT, TAX ID, or PO Number",
    "severity": "minimal",
    "require24X7Response": false,
    "advancedDiagnosticConsent": "No",
    "supportPlanId": "U291cmNlOlNDTSxDbGFyaWZ5SW5zdGFsbGF0aW9uU2l0ZUlkOjcsTGluZUl0ZW1JZDo5ODY1NzIyOSxDb250cmFjdElkOjk4NjU5MTk0LFN1YnNjcmlwdGlvbklkOjc2Y2I3N2ZhLThiMTctNGVhYi05NDkzLWI2NWRhY2U5OTgxMyw=",
    "fileWorkspaceName": "6f16735c-1530836f-e9970f1a-2e49-47b7-96cd-9746b83aa066",
    "contactDetails": {
      "firstName": "abc",
      "lastName": "xyz",
      "preferredContactMethod": "email",
      "primaryEmailAddress": "abc@contoso.com",
      "preferredTimeZone": "Pacific Standard Time",
      "country": "USA",
      "preferredSupportLanguage": "en-US"
    },
    "serviceLevelAgreement": {
      "startTime": "2020-03-20T21:36:18Z",
      "expirationTime": "2020-03-21T17:36:18Z",
      "slaMinutes": 240
    },
    "supportEngineer": {
      "emailAddress": "xyz@contoso.com"
    },
    "supportPlanType": "Premier",
    "supportPlanDisplayName": "Premier",
    "title": "Test - please ignore",
    "serviceId": "/providers/Microsoft.Support/services/subscription_management_service_guid",
    "serviceDisplayName": "Subscription management",
    "status": "Open",
    "createdDate": "2020-03-20T21:36:18Z",
    "modifiedDate": "2020-03-20T21:36:23Z"
  }
}

Definições

Nome	Description
Consent	Consentimento avançado de diagnóstico a ser atualizado no tíquete de suporte.
ContactProfile	Informações de contato associadas ao tíquete de suporte.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
IsTemporaryTicket	Essa propriedade indica se o tíquete de suporte é um tíquete temporário.
PreferredContactMethod	Método de contato preferencial.
QuotaChangeRequest	Essa propriedade é necessária para fornecer a região e novos limites de cota.
QuotaTicketDetails	Conjunto adicional de informações necessárias para o tíquete de suporte de aumento de cota para determinados tipos de cota, por exemplo: núcleos de máquina virtual. Obtenha detalhes completos sobre a solicitação de suporte de carga de cota juntamente com exemplos na solicitação de cota de suporte .
SecondaryConsent	Essa propriedade indica o consentimento secundário para o tíquete de suporte.
ServiceLevelAgreement	Detalhes do Contrato de Nível de Serviço para um tíquete de suporte.
SeverityLevel	Um valor que indica a urgência do caso, que, por sua vez, determina o tempo de resposta de acordo com o contrato de nível de serviço do plano de suporte técnico que você tem com o Azure. Observação: "Impacto crítico mais alto", também conhecido como o nível "Emergência – Impacto severo" no portal do Azure, é reservado apenas para nossos clientes Premium.
SupportEngineer	Informações de engenheiro de suporte.
SupportTicketDetails	Objeto que representa o recurso SupportTicketDetails.
TechnicalTicketDetails	Informações adicionais para tíquete de suporte técnico.
UserConsent	Valor de consentimento do usuário fornecido

Consent

Enumeração

Consentimento avançado de diagnóstico a ser atualizado no tíquete de suporte.

Valor	Description
No
Yes

ContactProfile

Objeto

Informações de contato associadas ao tíquete de suporte.

Nome	Tipo	Description
additionalEmailAddresses	string[]	Endereços de email adicionais listados serão copiados em qualquer correspondência sobre o tíquete de suporte.
country	string	País do usuário. Este é o código ISO 3166-1 alfa-3.
firstName	string	Nome próprio.
lastName	string	Apelido.
phoneNumber	string	Número de telefone. Isso será necessário se o método de contato preferencial for o telefone. Também é necessário ao enviar casos de severidade 'críticos' ou 'highestcriticalimpact'.
preferredContactMethod	PreferredContactMethod	Método de contato preferencial.
preferredSupportLanguage	string	Idioma preferencial de suporte do Azure. Os idiomas de suporte variam de acordo com a gravidade escolhida para o tíquete de suporte. Saiba mais em de severidade e capacidade de resposta do Azure. Use o código de país de idioma padrão. Valores válidos são 'en-us' para inglês, 'zh-hans' para chinês, 'es-es' para espanhol, 'fr-fr' para francês, 'ja-jp' para japonês, 'ko-kr' para coreano, 'ru-ru' para russo, 'pt-br' para português, 'it-it' para italiano, 'zh-tw' para chinês e 'de-de' para alemão.
preferredTimeZone	string	Fuso horário do usuário. Esse é o nome do fuso horário dos Valores de Índice de Fuso Horário da Microsoft.
primaryEmailAddress	string	Endereço de email primário.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

IsTemporaryTicket

Enumeração

Essa propriedade indica se o tíquete de suporte é um tíquete temporário.

Valor	Description
No
Yes

PreferredContactMethod

Enumeração

Método de contato preferencial.

Valor	Description
email
phone

QuotaChangeRequest

Objeto

Essa propriedade é necessária para fornecer a região e novos limites de cota.

Nome	Tipo	Description
payload	string	Conteúdo da solicitação de aumento de cota.
region	string	Região para a qual a solicitação de aumento de cota está sendo feita.

QuotaTicketDetails

Objeto

Conjunto adicional de informações necessárias para o tíquete de suporte de aumento de cota para determinados tipos de cota, por exemplo: núcleos de máquina virtual. Obtenha detalhes completos sobre a solicitação de suporte de carga de cota juntamente com exemplos na solicitação de cota de suporte .

Nome	Tipo	Description
quotaChangeRequestSubType	string	Necessário para determinados tipos de cota quando há um subtipo, como o Lote, para o qual você está solicitando um aumento de cota.
quotaChangeRequestVersion	string	Versão da solicitação de alteração de cota.
quotaChangeRequests	QuotaChangeRequest[]	Essa propriedade é necessária para fornecer a região e novos limites de cota.

SecondaryConsent

Objeto

Essa propriedade indica o consentimento secundário para o tíquete de suporte.

Nome	Tipo	Description
type	string	O nome do serviço para o qual o consentimento secundário está sendo fornecido. O valor precisa ser recuperado da resposta à API de Classificação de Problemas.
userConsent	UserConsent	Valor de consentimento do usuário fornecido

ServiceLevelAgreement

Objeto

Detalhes do Contrato de Nível de Serviço para um tíquete de suporte.

Nome	Tipo	Description
expirationTime	string (date-time)	Hora em UTC (formato ISO 8601) quando o contrato de nível de serviço expirar.
slaMinutes	integer (int32)	Contrato de Nível de Serviço em minutos.
startTime	string (date-time)	Hora em UTC (formato ISO 8601) quando o contrato de nível de serviço é iniciado.

SeverityLevel

Enumeração

Um valor que indica a urgência do caso, que, por sua vez, determina o tempo de resposta de acordo com o contrato de nível de serviço do plano de suporte técnico que você tem com o Azure. Observação: "Impacto crítico mais alto", também conhecido como o nível "Emergência – Impacto severo" no portal do Azure, é reservado apenas para nossos clientes Premium.

Valor	Description
critical
highestcriticalimpact
minimal
moderate

SupportEngineer

Objeto

Informações de engenheiro de suporte.

Nome	Tipo	Description
emailAddress	string	Endereço de email do engenheiro de suporte do Azure atribuído ao tíquete de suporte.

SupportTicketDetails

Objeto

Objeto que representa o recurso SupportTicketDetails.

Nome	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.advancedDiagnosticConsent	Consent	Consentimento avançado de diagnóstico a ser atualizado no tíquete de suporte.
properties.contactDetails	ContactProfile	Entre em contato com informações do usuário que solicita a criação de um tíquete de suporte.
properties.createdDate	string (date-time)	Hora em UTC (formato ISO 8601) quando o tíquete de suporte foi criado.
properties.description	string	Descrição detalhada da pergunta ou problema.
properties.enrollmentId	string	ID de registro associada ao tíquete de suporte.
properties.fileWorkspaceName	string	Nome do workspace do arquivo.
properties.isTemporaryTicket	IsTemporaryTicket	Essa propriedade indica se o tíquete de suporte é um tíquete temporário.
properties.modifiedDate	string (date-time)	Hora em UTC (formato ISO 8601) quando o tíquete de suporte foi modificado pela última vez.
properties.problemClassificationDisplayName	string	Nome localizado da classificação de problemas.
properties.problemClassificationId	string	Cada serviço do Azure tem seu próprio conjunto de categorias de problemas, também conhecido como classificação de problemas. Esse parâmetro é a ID exclusiva para o tipo de problema que você está enfrentando.
properties.problemScopingQuestions	string	Problemas de escopo de perguntas associadas ao tíquete de suporte.
properties.problemStartTime	string (date-time)	Hora em UTC (formato ISO 8601) quando o problema foi iniciado.
properties.quotaTicketDetails	QuotaTicketDetails	Detalhes adicionais do tíquete associados a uma solicitação de tíquete de suporte de cota.
properties.require24X7Response	boolean	Indica se isso requer uma resposta 24x7 do Azure.
properties.secondaryConsent	SecondaryConsent[]	Essa propriedade indica consentimentos secundários para o tíquete de suporte
properties.serviceDisplayName	string	Nome localizado do serviço do Azure.
properties.serviceId	string	Essa é a ID de recurso do recurso de serviço do Azure associado ao tíquete de suporte.
properties.serviceLevelAgreement	ServiceLevelAgreement	Informações do Contrato de Nível de Serviço para esse tíquete de suporte.
properties.severity	SeverityLevel	Um valor que indica a urgência do caso, que, por sua vez, determina o tempo de resposta de acordo com o contrato de nível de serviço do plano de suporte técnico que você tem com o Azure. Observação: "Impacto crítico mais alto", também conhecido como o nível "Emergência – Impacto severo" no portal do Azure, é reservado apenas para nossos clientes Premium.
properties.status	string	Status do tíquete de suporte.
properties.supportEngineer	SupportEngineer	Informações sobre o engenheiro de suporte trabalhando neste tíquete de suporte.
properties.supportPlanDisplayName	string	Tipo de plano de suporte associado ao tíquete de suporte.
properties.supportPlanId	string	ID do plano de suporte associada ao tíquete de suporte.
properties.supportPlanType	string	Tipo de plano de suporte associado ao tíquete de suporte.
properties.supportTicketId	string	ID de tíquete de suporte gerada pelo sistema que é exclusiva.
properties.technicalTicketDetails	TechnicalTicketDetails	Detalhes adicionais do tíquete associados a uma solicitação de tíquete de suporte técnico.
properties.title	string	Título do tíquete de suporte.
type	string	Tipo do recurso 'Microsoft.Support/supportTickets'.

TechnicalTicketDetails

Objeto

Informações adicionais para tíquete de suporte técnico.

Nome	Tipo	Description
resourceId	string	Essa é a ID de recurso do recurso de serviço do Azure (por exemplo: um recurso de máquina virtual ou um recurso HDInsight) para o qual o tíquete de suporte é criado.

UserConsent

Enumeração

Valor de consentimento do usuário fornecido

Valor	Description
No
Yes