Service Classifications - classify Services

Service:: Support

API Version:: 2023-06-01-preview

Classify the list of right Azure services.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Support/classifyServices?api-version=2023-06-01-preview

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	Azure subscription Id.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
additionalContext	string	Additional information in the form of a string.
issueSummary	string	Natural language description of the customer’s issue.
resourceId	string (arm-id)	ARM resource Id of the resource that is having the issue.

Responses

Name	Type	Description
200 OK	ServiceClassificationOutput	Successfully classified list of Azure services.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Classify list of Azure services for a subscription

Sample request

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Support/classifyServices?api-version=2023-06-01-preview

{
  "issueSummary": "Can not connect to Windows VM",
  "resourceId": "/subscriptions/76cb77fa-8b17-4eab-9493-b65dace99813/resourceGroups/rgname/providers/Microsoft.Compute/virtualMachines/vmname"
}

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.support import MicrosoftSupport

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-support
# USAGE
    python classify_services_for_subscription.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="00000000-0000-0000-0000-000000000000",
    )

    response = client.service_classifications.classify_services(
        service_classification_request={
            "issueSummary": "Can not connect to Windows VM",
            "resourceId": "/subscriptions/76cb77fa-8b17-4eab-9493-b65dace99813/resourceGroups/rgname/providers/Microsoft.Compute/virtualMachines/vmname",
        },
    )
    print(response)


# x-ms-original-file: specification/support/resource-manager/Microsoft.Support/preview/2023-06-01-preview/examples/ClassifyServicesForSubscription.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

package armsupport_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/support/resource-manager/Microsoft.Support/preview/2023-06-01-preview/examples/ClassifyServicesForSubscription.json
func ExampleServiceClassificationsClient_ClassifyServices() {
	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.NewServiceClassificationsClient().ClassifyServices(ctx, armsupport.ServiceClassificationRequest{
		IssueSummary: to.Ptr("Can not connect to Windows VM"),
		ResourceID:   to.Ptr("/subscriptions/76cb77fa-8b17-4eab-9493-b65dace99813/resourceGroups/rgname/providers/Microsoft.Compute/virtualMachines/vmname"),
	}, 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.ServiceClassificationOutput = armsupport.ServiceClassificationOutput{
	// }
}

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

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

/**
 * This sample demonstrates how to Classify the list of right Azure services.
 *
 * @summary Classify the list of right Azure services.
 * x-ms-original-file: specification/support/resource-manager/Microsoft.Support/preview/2023-06-01-preview/examples/ClassifyServicesForSubscription.json
 */
async function classifyListOfAzureServicesForASubscription() {
  const subscriptionId =
    process.env["SUPPORT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const serviceClassificationRequest = {
    issueSummary: "Can not connect to Windows VM",
    resourceId:
      "/subscriptions/76cb77fa-8b17-4eab-9493-b65dace99813/resourceGroups/rgname/providers/Microsoft.Compute/virtualMachines/vmname",
  };
  const credential = new DefaultAzureCredential();
  const client = new MicrosoftSupport(credential, subscriptionId);
  const result = await client.serviceClassifications.classifyServices(serviceClassificationRequest);
  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

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

// Generated from example definition: specification/support/resource-manager/Microsoft.Support/preview/2023-06-01-preview/examples/ClassifyServicesForSubscription.json
// this example is just showing the usage of "ServiceClassifications_classifyServices" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
ServiceClassificationContent content = new ServiceClassificationContent()
{
    IssueSummary = "Can not connect to Windows VM",
    ResourceId = new ResourceIdentifier("/subscriptions/76cb77fa-8b17-4eab-9493-b65dace99813/resourceGroups/rgname/providers/Microsoft.Compute/virtualMachines/vmname"),
};
ServiceClassificationOutput result = await subscriptionResource.ClassifyServicesServiceClassificationAsync(content);

Console.WriteLine($"Succeeded: {result}");

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

Sample response

Status code:: 200

{
  "serviceClassificationResults": [
    {
      "serviceId": "/providers/Microsoft.Support/services/5c41904f-1bcf-76e4-7a54-5fc07468f3cc",
      "displayName": "Azure Update Manager",
      "resourceTypes": [
        "Microsoft.HybridCompute/machines",
        "Microsoft.Maintenance/maintenanceConfigurations",
        "Microsoft.Maintenance/configurationAssignments",
        "MICROSOFT.AUTOMATION/AUTOMATIONACCOUNTS",
        "MICROSOFT.COMPUTE/VIRTUALMACHINES"
      ]
    },
    {
      "serviceId": "/providers/Microsoft.Support/services/40ef020e-8ae7-8d57-b538-9153c47cee69",
      "displayName": "SQL Server in VM - Linux",
      "resourceTypes": [
        "MICROSOFT.CLASSICCOMPUTE/VIRTUALMACHINES",
        "MICROSOFT.COMPUTE/VIRTUALMACHINES"
      ]
    }
  ]
}

Definitions

Name	Description
ClassificationService	Service Classification result object.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ServiceClassificationAnswer	Service Classification result object.
ServiceClassificationOutput	Output of the service classification API.
ServiceClassificationRequest	Input to problem classification Classification API.

ClassificationService

Object

Service Classification result object.

Name	Type	Description
displayName	string	Localized name of the azure service.
resourceTypes	string[]	List of applicable ARM resource types for this service.
serviceId	string (arm-id)	Azure resource Id of the service.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ServiceClassificationAnswer

Object

Service Classification result object.

Name	Type	Description
childService	ClassificationService	Child service.
displayName	string	Localized name of the azure service.
resourceTypes	string[]	List of applicable ARM resource types for this service.
serviceId	string (arm-id)	Azure resource Id of the service.

ServiceClassificationOutput

Object

Output of the service classification API.

Name	Type	Description
serviceClassificationResults	ServiceClassificationAnswer[]	Set of problem classification objects classified.

ServiceClassificationRequest

Object

Input to problem classification Classification API.

Name	Type	Description
additionalContext	string	Additional information in the form of a string.
issueSummary	string	Natural language description of the customer’s issue.
resourceId	string (arm-id)	ARM resource Id of the resource that is having the issue.

Share via

Service Classifications - classify Services

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Classify list of Azure services for a subscription

Sample request

Sample response

Definitions

ClassificationService

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServiceClassificationAnswer

ServiceClassificationOutput

ServiceClassificationRequest