Discovery Solution - List

Szolgáltatás:

Help

API-verzió:

2024-03-01-preview

A problemClassification API) ÉS resourceUri vagy resourceType használatával elérhető Azure Diagnostics, Solutions és Hibaelhárítók listája.
A Felderítési megoldások a Súgó API kezdeti belépési pontja, amely azonosítja a releváns Azure-diagnosztikákat és megoldásokat.

Kötelező bemenet: problemClassificationId (Használja a problemClassification API)
Nem kötelező bemenet: resourceUri VAGY erőforrástípus

megjegyzés: Discovery-megoldások válaszából származó "requiredInputs" értéket a Diagnostics and Solutions API bemeneteként az "additionalParameters"-en keresztül kell továbbítani.

GET https://management.azure.com/providers/Microsoft.Help/discoverySolutions?api-version=2024-03-01-preview

Opcionális paraméterekkel:

GET https://management.azure.com/providers/Microsoft.Help/discoverySolutions?api-version=2024-03-01-preview&$filter={$filter}&$skiptoken={$skiptoken}

URI-paraméterek

Name	In	Kötelező	Típus	Description
api-version	query	True	string	Ügyfél API-verziója.
$filter	query		string	A "ProblemClassificationId" egy kötelező szűrő a megoldásazonosítók lekéréséhez. Támogatja az opcionális ResourceType és SolutionType szűrőket is. A $filter csak "and", "or" és "eq" operátorokat támogat. Példa: $filter=ProblemClassificationId eq '1ddda5b4-cf6c-4d4f-91ad-bc38ab0e811e'
$skiptoken	query		string	A Skiptoken csak akkor használatos, ha egy korábbi művelet részleges eredményt adott vissza.

Válaszok

Name	Típus	Description
200 OK	DiscoveryResponse	A megoldás metaadatainak sikeres lekérése.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

List DiscoverySolutions at resource scope

Mintakérelem

HTTP

GET https://management.azure.com/providers/Microsoft.Help/discoverySolutions?api-version=2024-03-01-preview&$filter=ProblemClassificationId eq 'SampleProblemClassificationId1'

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.selfhelp import SelfHelpMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-selfhelp
# USAGE
    python list_discovery_solutions_at_tenant_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.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/help/resource-manager/Microsoft.Help/preview/2024-03-01-preview/examples/ListDiscoverySolutionsAtTenantScope.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/ListDiscoverySolutionsAtTenantScope.json
func ExampleDiscoverySolutionClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewDiscoverySolutionClient().NewListPager(&armselfhelp.DiscoverySolutionClientListOptions{Filter: to.Ptr("ProblemClassificationId eq 'SampleProblemClassificationId1'"),
		Skiptoken: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DiscoveryResponse = armselfhelp.DiscoveryResponse{
		// 	Value: []*armselfhelp.SolutionMetadataResource{
		// 		{
		// 			Name: to.Ptr("SampleProblemClassificationId1"),
		// 			Type: to.Ptr("Microsoft.Help/discoverySolutions"),
		// 			ID: to.Ptr("/providers/microsoft.help/discoverySolutions/SampleProblemClassificationId1"),
		// 			Properties: &armselfhelp.Solutions{
		// 				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),
		// 					}},
		// 				},
		// 		}},
		// 	}
	}
}

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 Lists the relevant Azure Diagnostics, Solutions and Troubleshooters using [problemClassification API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP)) AND  resourceUri or resourceType.<br/> Discovery Solutions is the initial entry point within Help API, which identifies relevant Azure diagnostics and solutions. <br/><br/> Required Input :  problemClassificationId (Use the [problemClassification API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP)) <br/>Optional input: resourceUri OR resource Type <br/><br/> <b>Note: </b>  ‘requiredInputs’ from Discovery solutions response must be passed via ‘additionalParameters’ as an input to Diagnostics and Solutions API.
 *
 * @summary Lists the relevant Azure Diagnostics, Solutions and Troubleshooters using [problemClassification API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP)) AND  resourceUri or resourceType.<br/> Discovery Solutions is the initial entry point within Help API, which identifies relevant Azure diagnostics and solutions. <br/><br/> Required Input :  problemClassificationId (Use the [problemClassification API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP)) <br/>Optional input: resourceUri OR resource Type <br/><br/> <b>Note: </b>  ‘requiredInputs’ from Discovery solutions response must be passed via ‘additionalParameters’ as an input to Diagnostics and Solutions API.
 * x-ms-original-file: specification/help/resource-manager/Microsoft.Help/preview/2024-03-01-preview/examples/ListDiscoverySolutionsAtTenantScope.json
 */
async function listDiscoverySolutionsAtResourceScope() {
  const filter = "ProblemClassificationId eq 'SampleProblemClassificationId1'";
  const options = { filter };
  const credential = new DefaultAzureCredential();
  const client = new HelpRP(credential);
  const resArray = new Array();
  for await (let item of client.discoverySolution.list(options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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/ListDiscoverySolutionsAtTenantScope.json
// this example is just showing the usage of "DiscoverySolution_List" 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);

TenantResource tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// invoke the operation and iterate over the result
string filter = "ProblemClassificationId eq 'SampleProblemClassificationId1'";
await foreach (SelfHelpSolutionMetadata item in tenantResource.DiscoverSolutionsAsync(filter: filter))
{
    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

Mintaválasz

Állapotkód:

200

{
  "value": [
    {
      "id": "/providers/microsoft.help/discoverySolutions/SampleProblemClassificationId1",
      "name": "SampleProblemClassificationId1",
      "type": "Microsoft.Help/discoverySolutions",
      "properties": {
        "solutions": [
          {
            "solutionId": "SampleSolutionId1",
            "solutionType": "Diagnostics",
            "description": "This is an azure solution to troubleshoot subscription issues.",
            "requiredInputs": [
              "SubscriptionId"
            ]
          }
        ]
      }
    }
  ]
}

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
DiscoveryResponse	Felderítési válasz.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
SolutionMetadataProperties	Metaadatok tulajdonságai
SolutionMetadataResource	Metaadat-erőforrás
SolutionType	Megoldás típusa.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

DiscoveryResponse

Objektum

Felderítési válasz.

Name	Típus	Description
nextLink	string	A megoldás metaadatainak következő oldalára mutató hivatkozás.
value	SolutionMetadataResource[]	A metaadatok listája.

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

SolutionMetadataProperties

Objektum

Metaadatok tulajdonságai

Name	Típus	Description
description	string	A megoldás részletes leírása.
requiredInputs	string[]	Az adott megoldás meghívásához szükséges paraméterek.
solutionId	string	Megoldásazonosító.
solutionType	SolutionType	Megoldás típusa.

SolutionMetadataResource

Objektum

Metaadat-erőforrás

Name	Típus	Description
id	string (arm-id)	Az erőforrás teljes erőforrás-azonosítója. Például: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Az erőforrás neve
properties.solutions	SolutionMetadataProperties[]	Metaadatok listája.
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

SolutionType

Enumerálás

Megoldás típusa.

Érték	Description
Diagnostics	Diagnosztikai erőforrás típusa.
SelfHelp	Önkiszolgáló erőforrástípus.
Solutions	Megoldások erőforrástípusa.
Troubleshooters	Hibaelhárítók erőforrástípusa.

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.