Resource Health Metadata - List By Resource Group

Служба:: App Service

Версия API:: 2025-05-01

Описание для параметра Список всех метаданных ResourceHealthMetadata для всех сайтов в группе ресурсов в подписке.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не зависит от регистра.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	ResourceHealthMetadataCollection	Операция Azure успешно завершена.
Other Status Codes	DefaultErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

List ResourceHealthMetadata for a resource group

Образец запроса

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

Пример ответа

Код состояния:: 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
      }
    }
  ]
}

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
DefaultErrorResponse	Ответ об ошибке службы приложений.
DefaultErrorResponseError	Модель ошибок.
DefaultErrorResponseErrorDetailsItem	Подробные ошибки.
ResourceHealthMetadata	Используется для получения настроек ResourceHealthCheck.
ResourceHealthMetadataCollection	Сбор метаданных о работоспособности ресурсов.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Объект

Ответ об ошибке службы приложений.

Имя	Тип	Описание
error	DefaultErrorResponseError	Модель ошибок.

DefaultErrorResponseError

Объект

Модель ошибок.

Имя	Тип	Описание
code	string	Стандартизированная строка для программной идентификации ошибки.
details	DefaultErrorResponseErrorDetailsItem[]	Подробные ошибки.
innererror	string	Дополнительная информация об ошибке отладки.
message	string	Подробное описание ошибки и информация об отладке.
target	string	Подробное описание ошибки и информация об отладке.

DefaultErrorResponseErrorDetailsItem

Объект

Подробные ошибки.

Имя	Тип	Описание
code	string	Стандартизированная строка для программной идентификации ошибки.
message	string	Подробное описание ошибки и информация об отладке.
target	string	Подробное описание ошибки и информация об отладке.