Discovery Solution NLP - Discover Solutions By Subscription

Service:

Help

API Version:

2024-03-01-preview

Search for relevant Azure Diagnostics, Solutions and Troubleshooters using a natural language issue summary and subscription.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Help/discoverSolutions?api-version=2024-03-01-preview

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The Azure subscription ID.
api-version	query	True	string	Client Api Version.

Request Body

Name	Required	Type	Description
issueSummary	True	string	Natural language description of the issue.
additionalContext		string	Additional information in the form of a string.
resourceId		string	ARM resource Id of the resource that is having the issue. Only applicable for Discovery Solution NLP Subscription Scope.
serviceId		string	ARM service Id of the service that is having the issue. For more information on service Id see https://learn.microsoft.com/rest/api/support/services/list?tabs=HTTP.

Responses

Name	Type	Description
200 OK	DiscoveryNlpResponse	Successful fetched list of solution metadata.
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

Discovery Solutions using issue summary and service id.

Sample request

HTTP

POST https://management.azure.com/subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/providers/Microsoft.Help/discoverSolutions?api-version=2024-03-01-preview

{
  "issueSummary": "how to retrieve certs from deleted keyvault.",
  "resourceId": "subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read",
  "serviceId": "0d0fcd2e-c4fd-4349-8497-200edb39s3ca"
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.selfhelp import SelfHelpMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-selfhelp
# USAGE
    python discover_solutions_at_subscription_scope.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 = SelfHelpMgmtClient(
        credential=DefaultAzureCredential(),
    )

    response = client.discovery_solution_nlp.discover_solutions_by_subscription(
        subscription_id="0d0fcd2e-c4fd-4349-8497-200edb3923c6",
    )
    print(response)


# x-ms-original-file: specification/help/resource-manager/Microsoft.Help/preview/2024-03-01-preview/examples/DiscoverSolutionsAtSubscriptionScope.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 armselfhelp_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/selfhelp/armselfhelp/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c3cc9abe085093ba880ee3eeb792edb4fa789553/specification/help/resource-manager/Microsoft.Help/preview/2024-03-01-preview/examples/DiscoverSolutionsAtSubscriptionScope.json
func ExampleDiscoverySolutionNLPClient_DiscoverSolutionsBySubscription() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armselfhelp.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDiscoverySolutionNLPClient().DiscoverSolutionsBySubscription(ctx, "0d0fcd2e-c4fd-4349-8497-200edb3923c6", &armselfhelp.DiscoverySolutionNLPClientDiscoverSolutionsBySubscriptionOptions{DiscoverSolutionRequest: &armselfhelp.DiscoveryNlpRequest{
		IssueSummary: to.Ptr("how to retrieve certs from deleted keyvault."),
		ResourceID:   to.Ptr("subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read"),
		ServiceID:    to.Ptr("0d0fcd2e-c4fd-4349-8497-200edb39s3ca"),
	},
	})
	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.DiscoveryNlpResponse = armselfhelp.DiscoveryNlpResponse{
	// 	Value: []*armselfhelp.SolutionNlpMetadataResource{
	// 		{
	// 			Name: to.Ptr("SampleProblemClassificationId1"),
	// 			Type: to.Ptr("Microsoft.Help/discoverySolutions"),
	// 			ID: to.Ptr("/subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/providers/Microsoft.Help/discoverSolutions/SampleProblemClassificationId1"),
	// 			Properties: &armselfhelp.NlpSolutions{
	// 				ProblemClassificationID: to.Ptr("SampleProblemClassificationId1"),
	// 				ProblemDescription: to.Ptr("SampleDescription1"),
	// 				ProblemTitle: to.Ptr("SampleTitle1"),
	// 				RelatedServices: []*armselfhelp.ClassificationService{
	// 					{
	// 						DisplayName: to.Ptr("SQL Server in VM - Linux"),
	// 						ResourceTypes: []*string{
	// 							to.Ptr("MICROSOFT.CLASSICCOMPUTE/VIRTUALMACHINES"),
	// 							to.Ptr("MICROSOFT.COMPUTE/VIRTUALMACHINES")},
	// 							ServiceID: to.Ptr("/providers/Microsoft.Support/services/40ef020e-8ae7-8d57-b538-9153c47cee69"),
	// 					}},
	// 					ServiceID: to.Ptr("SampleServiceId1"),
	// 					Solutions: []*armselfhelp.SolutionMetadataProperties{
	// 						{
	// 							Description: to.Ptr("This is an azure solution to troubleshoot subscription issues."),
	// 							RequiredInputs: []*string{
	// 								to.Ptr("SubscriptionId")},
	// 								SolutionID: to.Ptr("SampleSolutionId1"),
	// 								SolutionType: to.Ptr(armselfhelp.SolutionTypeDiagnostics),
	// 							},
	// 							{
	// 								Description: to.Ptr("This is an azure solution to troubleshoot keyvault resource."),
	// 								RequiredInputs: []*string{
	// 									to.Ptr("SubscriptionId")},
	// 									SolutionID: to.Ptr("SampleSolutionId2"),
	// 									SolutionType: to.Ptr(armselfhelp.SolutionTypeSolutions),
	// 							}},
	// 						},
	// 				}},
	// 			}
}

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 { HelpRP } = require("@azure/arm-selfhelp");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Search for relevant Azure Diagnostics, Solutions and Troubleshooters using a natural language issue summary and subscription.
 *
 * @summary Search for relevant Azure Diagnostics, Solutions and Troubleshooters using a natural language issue summary and subscription.
 * x-ms-original-file: specification/help/resource-manager/Microsoft.Help/preview/2024-03-01-preview/examples/DiscoverSolutionsAtSubscriptionScope.json
 */
async function discoverySolutionsUsingIssueSummaryAndServiceId() {
  const subscriptionId = "0d0fcd2e-c4fd-4349-8497-200edb3923c6";
  const discoverSolutionRequest = {
    issueSummary: "how to retrieve certs from deleted keyvault.",
    resourceId:
      "subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read",
    serviceId: "0d0fcd2e-c4fd-4349-8497-200edb39s3ca",
  };
  const options = { discoverSolutionRequest };
  const credential = new DefaultAzureCredential();
  const client = new HelpRP(credential);
  const result = await client.discoverySolutionNLP.discoverSolutionsBySubscription(
    subscriptionId,
    options,
  );
  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.Resources;
using Azure.ResourceManager.SelfHelp.Models;
using Azure.ResourceManager.SelfHelp;

// Generated from example definition: specification/help/resource-manager/Microsoft.Help/preview/2024-03-01-preview/examples/DiscoverSolutionsAtSubscriptionScope.json
// this example is just showing the usage of "DiscoverySolutionNLP_DiscoverSolutionsBySubscription" 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 = "0d0fcd2e-c4fd-4349-8497-200edb3923c6";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
DiscoveryNlpContent content = new DiscoveryNlpContent("how to retrieve certs from deleted keyvault.")
{
    ResourceId = "subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read",
    ServiceId = "0d0fcd2e-c4fd-4349-8497-200edb39s3ca",
};
await foreach (SolutionNlpMetadata item in subscriptionResource.DiscoverSolutionsNlpAsync(content: content))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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

{
  "value": [
    {
      "id": "/subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/providers/Microsoft.Help/discoverSolutions/SampleProblemClassificationId1",
      "name": "SampleProblemClassificationId1",
      "type": "Microsoft.Help/discoverySolutions",
      "properties": {
        "problemTitle": "SampleTitle1",
        "problemDescription": "SampleDescription1",
        "serviceId": "SampleServiceId1",
        "problemClassificationId": "SampleProblemClassificationId1",
        "solutions": [
          {
            "solutionId": "SampleSolutionId1",
            "solutionType": "Diagnostics",
            "description": "This is an azure solution to troubleshoot subscription issues.",
            "requiredInputs": [
              "SubscriptionId"
            ]
          },
          {
            "solutionId": "SampleSolutionId2",
            "solutionType": "Solutions",
            "description": "This is an azure solution to troubleshoot keyvault resource.",
            "requiredInputs": [
              "SubscriptionId"
            ]
          }
        ],
        "relatedServices": [
          {
            "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.
createdByType	The type of identity that created the resource.
DiscoveryNlpRequest	Discover NLP request.
DiscoveryNlpResponse	Successfully fetched list of solution metadata.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
SolutionMetadataProperties	Metadata Properties
SolutionNlpMetadataResource	Nlp Metadata resource
SolutionType	Solution Type.
systemData	Metadata pertaining to creation and last modification of the resource.

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.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DiscoveryNlpRequest

Object

Discover NLP request.

Name	Type	Description
additionalContext	string	Additional information in the form of a string.
issueSummary	string	Natural language description of the issue.
resourceId	string	ARM resource Id of the resource that is having the issue. Only applicable for Discovery Solution NLP Subscription Scope.
serviceId	string	ARM service Id of the service that is having the issue. For more information on service Id see https://learn.microsoft.com/rest/api/support/services/list?tabs=HTTP.

DiscoveryNlpResponse

Object

Successfully fetched list of solution metadata.

Name	Type	Description
value	SolutionNlpMetadataResource[]	The list of solution metadata.

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.

SolutionMetadataProperties

Object

Metadata Properties

Name	Type	Description
description	string	A detailed description of solution.
requiredInputs	string[]	Required parameters for invoking this particular solution.
solutionId	string	Solution Id.
solutionType	SolutionType	Solution Type.

SolutionNlpMetadataResource

Object

Nlp Metadata resource

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.problemClassificationId	string	Id of the ProblemClassification (https://learn.microsoft.com/en-us/rest/api/support/problem-classifications?view=rest-support-2020-04-01) that may be used to create a support ticket.
properties.problemDescription	string	Description of the problem classification.
properties.problemTitle	string	Title of the problem classification.
properties.relatedServices	ClassificationService[]	The set of services that are most likely related to the request. If relatedServices is included in the response then solutions may not be discovered until the client calls a second time specifying one of the service Ids in the relatedServices object.
properties.serviceId	string	Id of the service (https://learn.microsoft.com/en-us/rest/api/support/services?view=rest-support-2020-04-01) that may be used to create a support ticket.
properties.solutions	SolutionMetadataProperties[]	The list of solution metadata.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

SolutionType

Enumeration

Solution Type.

Value	Description
Diagnostics	Diagnostics resource type.
Solutions	Solutions resource type.
Troubleshooters	Troubleshooters resource type.
SelfHelp	SelfHelp resource type.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.