Discovery Solution - List

Referenz

Dienst:: Help

API-Version:: 2024-03-01-preview

Listet die relevanten Azure-Diagnose-, Lösungs- und Problembehandlungen mithilfe problemClassification-API) AND resourceUri oder resourceType auf.
Discovery Solutions ist der erste Einstiegspunkt in der Hilfe-API, der relevante Azure-Diagnose und -Lösungen identifiziert.

Erforderliche Eingabe: problemClassificationId (Verwenden der problemClassification-API)
Optionale Eingabe: resourceUri OR-Ressourcentyp

Hinweis: "requiredInputs" aus der Discovery-Lösungsantwort muss über "additionalParameters" als Eingabe an die Diagnose- und Lösungs-API übergeben werden.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
api-version	query	True	string	Client-API-Version.
$filter	query		string	"ProblemClassificationId" ist ein obligatorischer Filter zum Abrufen von Lösungs-IDs. Außerdem werden optionale 'ResourceType'- und 'SolutionType'-Filter unterstützt. Die $filter unterstützt nur operatoren "and", "or" und "eq". Beispiel: $filter=ProblemClassificationId eq '1ddda5b4-cf6c-4d4f-91ad-bc38ab0e811e'
$skiptoken	query		string	Skiptoken wird nur verwendet, wenn ein vorheriger Vorgang ein Teilergebnis zurückgegeben hat.

Antworten

Name	Typ	Beschreibung
200 OK	DiscoveryResponse	Erfolgreiche abgerufene Liste der Lösungsmetadaten.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

List DiscoverySolutions at resource scope

Beispielanforderung

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

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

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

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

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

Beispiel für eine Antwort

Statuscode:: 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"
            ]
          }
        ]
      }
    }
  ]
}

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DiscoveryResponse	Ermittlungsantwort.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
SolutionMetadataProperties	Metadateneigenschaften
SolutionMetadataResource	Metadatenressource
SolutionType	Lösungstyp.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

DiscoveryResponse

Objekt

Ermittlungsantwort.

Name	Typ	Beschreibung
nextLink	string	Der Link zum Abrufen der nächsten Seite mit Lösungsmetadaten.
value	SolutionMetadataResource[]	Die Liste der Metadaten.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

SolutionMetadataProperties

Objekt

Metadateneigenschaften

Name	Typ	Beschreibung
description	string	Eine detaillierte Beschreibung der Lösung.
requiredInputs	string[]	Erforderliche Parameter zum Aufrufen dieser bestimmten Lösung.
solutionId	string	Lösungs-ID.
solutionType	SolutionType	Lösungstyp.

SolutionMetadataResource

Objekt

Metadatenressource

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.solutions	SolutionMetadataProperties[]	Liste der Metadaten.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

SolutionType

Enumeration

Lösungstyp.

Wert	Beschreibung
Diagnostics	Diagnoseressourcentyp.
SelfHelp	SelfHelp-Ressourcentyp.
Solutions	Lösungsressourcentyp.
Troubleshooters	Problembehandlung für ressourcentyp.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Discovery Solution - List

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

List DiscoverySolutions at resource scope

Beispielanforderung

Beispiel für eine Antwort

Definitionen

createdByType

DiscoveryResponse

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SolutionMetadataProperties

SolutionMetadataResource

SolutionType

systemData