Resource Health Metadata - Get By Site Slot

Service:

App Service

API Version:

2023-12-01

Description for Gets the category of ResourceHealthMetadata to use for the given site

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resourceHealthMetadata/default?api-version=2023-12-01

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Name of web app
resourceGroupName	path	True	string	Name of the resource group to which the resource belongs. Regex pattern: ^[-\w\._\(\)]+[^\.]$
slot	path	True	string	Name of web app slot. If not specified then will default to production slot.
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API Version

Responses

Name	Type	Description
200 OK	ResourceHealthMetadata	OK
Other Status Codes	DefaultErrorResponse	App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get ResourceHealthMetadata

Sample Request

HTTP

GET https://management.azure.com/subscriptions/4adb32ad-8327-4cbb-b775-b84b4465bb38/resourceGroups/Default-Web-NorthCentralUS/providers/Microsoft.Web/sites/newsiteinnewASE-NCUS/slots/Production/resourceHealthMetadata/default?api-version=2023-12-01

Sample Response

Status code:

200

{
  "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"
}

Definitions

Name	Description
DefaultErrorResponse	App Service error response.
Details
Error	Error model.
ResourceHealthMetadata	Used for getting ResourceHealthCheck settings.

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Error

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

ResourceHealthMetadata

Used for getting ResourceHealthCheck settings.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.category	string	The category that the resource matches in the RHC Policy File
properties.signalAvailability	boolean	Is there a health signal for the resource
type	string	Resource type.