Resource Health Metadata - List By Resource Group

Dienst:: App Service

API-Version:: 2025-05-01

Beschreibung für List all ResourceHealthMetadata for all sites in der Ressourcengruppe im Abonnement.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/resourceHealthMetadata?api-version=2025-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	ResourceHealthMetadataCollection	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	DefaultErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow.

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

List ResourceHealthMetadata for a resource group

Beispielanforderung

GET https://management.azure.com/subscriptions/4adb32ad-8327-4cbb-b775-b84b4465bb38/resourceGroups/Default-Web-NorthCentralUS/providers/Microsoft.Web/resourceHealthMetadata?api-version=2025-05-01


/**
 * Samples for ResourceHealthMetadata ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-05-01/ListResourceHealthMetadataByResourceGroup.json
     */
    /**
     * Sample code: List ResourceHealthMetadata for a resource group.
     * 
     * @param manager Entry point to AppServiceManager.
     */
    public static void
        listResourceHealthMetadataForAResourceGroup(com.azure.resourcemanager.appservice.AppServiceManager manager) {
        manager.serviceClient().getResourceHealthMetadatas().listByResourceGroup("Default-Web-NorthCentralUS",
            com.azure.core.util.Context.NONE);
    }
}

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

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v6"
)

// Generated from example definition: 2025-05-01/ListResourceHealthMetadataByResourceGroup.json
func ExampleResourceHealthMetadataClient_NewListByResourceGroupPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("4adb32ad-8327-4cbb-b775-b84b4465bb38", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewResourceHealthMetadataClient().NewListByResourceGroupPager("Default-Web-NorthCentralUS", 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 = armappservice.ResourceHealthMetadataClientListByResourceGroupResponse{
		// 	ResourceHealthMetadataCollection: armappservice.ResourceHealthMetadataCollection{
		// 		Value: []*armappservice.ResourceHealthMetadata{
		// 			{
		// 				Name: to.Ptr("default"),
		// 				Type: to.Ptr("Microsoft.Web/sites/resourceHealthMetadata"),
		// 				ID: to.Ptr("/subscriptions/4adb32ad-8327-4cbb-b775-b84b4465bb38/resourceGroups/Default-Web-NorthCentralUS/providers/Microsoft.Web/sites/newsiteinnewASE-NCUS/resourceHealthMetadata/default"),
		// 				Properties: &armappservice.ResourceHealthMetadataProperties{
		// 					Category: to.Ptr("Shared"),
		// 					SignalAvailability: to.Ptr(true),
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

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": [
    {
      "name": "default",
      "type": "Microsoft.Web/sites/resourceHealthMetadata",
      "id": "/subscriptions/4adb32ad-8327-4cbb-b775-b84b4465bb38/resourceGroups/Default-Web-NorthCentralUS/providers/Microsoft.Web/sites/newsiteinnewASE-NCUS/resourceHealthMetadata/default",
      "properties": {
        "category": "Shared",
        "signalAvailability": true
      }
    }
  ]
}

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DefaultErrorResponse	Fehlerantwort des App-Diensts.
DefaultErrorResponseError	Fehlermodell.
DefaultErrorResponseErrorDetailsItem	Detaillierte Fehler.
ResourceHealthMetadata	Wird zum Abrufen von ResourceHealthCheck-Einstellungen verwendet.
ResourceHealthMetadataCollection	Sammlung von Metadaten zur Ressourcenintegrität.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Objekt

Fehlerantwort des App-Diensts.

Name	Typ	Beschreibung
error	DefaultErrorResponseError	Fehlermodell.

DefaultErrorResponseError

Objekt

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge zur programmgesteuerten Identifizierung des Fehlers.
details	DefaultErrorResponseErrorDetailsItem[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen von Fehlern.
message	string	Detaillierte Fehlerbeschreibung und Informationen zum Debuggen.
target	string	Detaillierte Fehlerbeschreibung und Informationen zum Debuggen.

DefaultErrorResponseErrorDetailsItem

Objekt

Detaillierte Fehler.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge zur programmgesteuerten Identifizierung des Fehlers.
message	string	Detaillierte Fehlerbeschreibung und Informationen zum Debuggen.
target	string	Detaillierte Fehlerbeschreibung und Informationen zum Debuggen.