Resource Health Metadata - List By Resource Group

Служба:

App Service

Версия API:

2024-11-01

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Имя группы ресурсов, к которой принадлежит ресурс.
subscriptionId	path	True	string	Идентификатор вашей подписки Azure. Это строка с форматом GUID (например, 0000000000-0000-0000-0000-00000000000000000000000000000).
api-version	query	True	string	Версия API

Ответы

Имя	Тип	Описание
200 OK	ResourceHealthMetadataCollection	ХОРОШО
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

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

HTTP

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

Java

/**
 * Samples for ResourceHealthMetadata ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/
     * ListResourceHealthMetadataByResourceGroup.json
     */
    /**
     * Sample code: List ResourceHealthMetadata for a resource group.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        listResourceHealthMetadataForAResourceGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python list_resource_health_metadata_by_resource_group.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 = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="4adb32ad-8327-4cbb-b775-b84b4465bb38",
    )

    response = client.resource_health_metadata.list_by_resource_group(
        resource_group_name="Default-Web-NorthCentralUS",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ListResourceHealthMetadataByResourceGroup.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 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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/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("<subscription-id>", 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.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

JavaScript

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Description for List all ResourceHealthMetadata for all sites in the resource group in the subscription.
 *
 * @summary Description for List all ResourceHealthMetadata for all sites in the resource group in the subscription.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ListResourceHealthMetadataByResourceGroup.json
 */
async function listResourceHealthMetadataForAResourceGroup() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "4adb32ad-8327-4cbb-b775-b84b4465bb38";
  const resourceGroupName =
    process.env["APPSERVICE_RESOURCE_GROUP"] || "Default-Web-NorthCentralUS";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.resourceHealthMetadataOperations.listByResourceGroup(
    resourceGroupName,
  )) {
    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.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ListResourceHealthMetadataByResourceGroup.json
// this example is just showing the usage of "ResourceHealthMetadata_ListByResourceGroup" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "4adb32ad-8327-4cbb-b775-b84b4465bb38";
string resourceGroupName = "Default-Web-NorthCentralUS";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// invoke the operation and iterate over the result
await foreach (ResourceHealthMetadataData item in resourceGroupResource.GetAllResourceHealthMetadataDataAsync())
{
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {item.Id}");
}

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

Определения

Имя	Описание
DefaultErrorResponse	Ответ об ошибке службы приложений.
Details
Error	Модель ошибок.
ResourceHealthMetadata	Используется для получения параметров ResourceHealthCheck.
ResourceHealthMetadataCollection	Коллекция метаданных работоспособности ресурсов.

DefaultErrorResponse

Object

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

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

Details

Object

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

Error

Object

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

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

ResourceHealthMetadata

Object

Используется для получения параметров ResourceHealthCheck.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
kind	string	Тип ресурса.
name	string	Имя ресурса.
properties.category	string	Категория, которая соответствует ресурсу в файле политики RHC
properties.signalAvailability	boolean	Существует ли сигнал работоспособности для ресурса
type	string	Тип ресурса.

ResourceHealthMetadataCollection

Object

Коллекция метаданных работоспособности ресурсов.

Имя	Тип	Описание
nextLink	string	Ссылка на следующую страницу ресурсов.
value	ResourceHealthMetadata[]	Коллекция ресурсов.