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 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	ResourceHealthMetadataCollection	Azure 作業已順利完成。
Other Status Codes	DefaultErrorResponse	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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=2025-05-01

Java

/**
 * 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

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/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
      }
    }
  ]
}

定義

名稱	Description
createdByType	建立資源的身分識別類型。
DefaultErrorResponse	App Service 錯誤回應。
DefaultErrorResponseError	錯誤模型。
DefaultErrorResponseErrorDetailsItem	詳細的錯誤。
ResourceHealthMetadata	用於取得 ResourceHealthCheck 設定。
ResourceHealthMetadataCollection	資源健康情況中繼資料的集合。
systemData	與建立和上次修改資源相關的元數據。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Object

App Service 錯誤回應。

名稱	類型	Description
error	DefaultErrorResponseError	錯誤模型。

DefaultErrorResponseError

Object

錯誤模型。

名稱	類型	Description
code	string	標準化字串，以程式設計方式識別錯誤。
details	DefaultErrorResponseErrorDetailsItem[]	詳細的錯誤。
innererror	string	偵錯錯誤的詳細資訊。
message	string	詳細的錯誤描述和偵錯資訊。
target	string	詳細的錯誤描述和偵錯資訊。

DefaultErrorResponseErrorDetailsItem

Object

詳細的錯誤。

名稱	類型	Description
code	string	標準化字串，以程式設計方式識別錯誤。
message	string	詳細的錯誤描述和偵錯資訊。
target	string	詳細的錯誤描述和偵錯資訊。

ResourceHealthMetadata

Object

用於取得 ResourceHealthCheck 設定。

名稱	類型	Description
id	string (arm-id)	資源的完整資源標識碼。 例如 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
kind	string	資源種類。
name	string	資源的名稱
properties.category	string	資源在 RHC 原則檔案中相符的類別
properties.signalAvailability	boolean	資源是否有健康情況訊號
systemData	systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 中繼資料。
type	string	資源的類型。 例如「Microsoft.Compute/virtualMachines」或「Microsoft.Storage/storageAccounts」

ResourceHealthMetadataCollection

Object

資源健康情況中繼資料的集合。

名稱	類型	Description
nextLink	string (uri)	專案下一頁的連結
value	ResourceHealthMetadata[]	本頁的 ResourceHealthMetadata 項目

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳 （UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。