Discovery Solution NLP - Discover Solutions By Subscription

參考

服務:: Help

API 版本:: 2024-03-01-preview

使用自然語言問題摘要和訂用帳戶搜尋相關的 Azure 診斷、解決方案和疑難解答員。

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

URI 參數

名稱	位於	必要	類型	Description
subscriptionId	path	True	string	Azure 訂用帳戶標識碼。
api-version	query	True	string	用戶端 API 版本。

要求本文

名稱	必要	類型	Description
issueSummary	True	string	問題的自然語言描述。
additionalContext		string	字串格式的其他資訊。
resourceId		string	發生問題的資源的 ARM 資源識別碼。僅適用於探索解決方案 NLP 訂用帳戶範圍。
serviceId		string	發生問題的服務的 ARM 服務標識碼。如需服務識別碼的詳細資訊，請參閱 https://learn.microsoft.com/rest/api/support/services/list?tabs=HTTP。

回應

名稱	類型	Description
200 OK	DiscoveryNlpResponse	成功擷取的解決方案元數據清單。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Discovery Solutions using issue summary and service id.

範例要求

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"
}

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

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

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

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

範例回覆

狀態碼:: 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"
            ]
          }
        ]
      }
    }
  ]
}

定義

名稱	Description
ClassificationService	服務分類結果物件。
createdByType	建立資源的身分識別類型。
DiscoveryNlpRequest	探索 NLP 要求。
DiscoveryNlpResponse	已成功擷取解決方案元數據的清單。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
SolutionMetadataProperties	元數據屬性
SolutionNlpMetadataResource	Nlp 元數據資源
SolutionType	方案類型。
systemData	與建立和上次修改資源相關的元數據。

ClassificationService

Object

服務分類結果物件。

名稱	類型	Description
displayName	string	Azure 服務的當地語系化名稱。
resourceTypes	string[]	此服務適用的 ARM 資源類型清單。
serviceId	string (arm-id)	服務的 Azure 資源識別碼。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
Application
Key
ManagedIdentity
User

DiscoveryNlpRequest

Object

探索 NLP 要求。

名稱	類型	Description
additionalContext	string	字串格式的其他資訊。
issueSummary	string	問題的自然語言描述。
resourceId	string	發生問題的資源的 ARM 資源識別碼。僅適用於探索解決方案 NLP 訂用帳戶範圍。
serviceId	string	發生問題的服務的 ARM 服務標識碼。如需服務識別碼的詳細資訊，請參閱 https://learn.microsoft.com/rest/api/support/services/list?tabs=HTTP。

DiscoveryNlpResponse

Object

已成功擷取解決方案元數據的清單。

名稱	類型	Description
value	SolutionNlpMetadataResource[]	方案元數據的清單。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

SolutionMetadataProperties

Object

元數據屬性

名稱	類型	Description
description	string	解決方案的詳細描述。
requiredInputs	string[]	叫用此特定解決方案的必要參數。
solutionId	string	解決方案標識碼。
solutionType	SolutionType	方案類型。

SolutionNlpMetadataResource

Object

Nlp 元數據資源

名稱	類型	Description
id	string (arm-id)	資源的完整資源標識碼。例如 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	資源的名稱
properties.problemClassificationId	string	可用來建立支援票證的 ProblemClassification （https://learn.microsoft.com/en-us/rest/api/support/problem-classifications?view=rest-support-2020-04-01）識別碼。
properties.problemDescription	string	問題分類的描述。
properties.problemTitle	string	問題分類的標題。
properties.relatedServices	ClassificationService[]	最可能與要求相關的服務集合。如果 response 中包含 relatedServices，則在用戶端第二次在 relatedServices 物件中指定其中一個服務標識符之前，可能無法探索解決方案。
properties.serviceId	string	可用來建立支援票證的服務標識碼（https://learn.microsoft.com/en-us/rest/api/support/services?view=rest-support-2020-04-01）。
properties.solutions	SolutionMetadataProperties[]	方案元數據的清單。
systemData	systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
type	string	資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

SolutionType

列舉型別

方案類型。

值	Description
Diagnostics	診斷資源類型。
SelfHelp	SelfHelp 資源類型。
Solutions	解決方案資源類型。
Troubleshooters	疑難解答員資源類型。

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

共用方式為

Discovery Solution NLP - Discover Solutions By Subscription

URI 參數

要求本文

回應

安全性

azure_auth

範圍

範例

Discovery Solutions using issue summary and service id.

範例要求

範例回覆

定義

ClassificationService

createdByType

DiscoveryNlpRequest

DiscoveryNlpResponse

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SolutionMetadataProperties

SolutionNlpMetadataResource

SolutionType

systemData