Monitored Resources - List

Service:

Elastic

API Version:

2020-07-01

List the resources currently being monitored by the Elastic monitor resource.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listMonitoredResources?api-version=2020-07-01

URI Parameters

Name	In	Required	Type	Description
monitorName	path	True	string	Monitor resource name
resourceGroupName	path	True	string	The name of the resource group to which the Elastic resource belongs.
subscriptionId	path	True	string	The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)
api-version	query	True	string	The API version to be used with the HTTP request.

Responses

Name	Type	Description
200 OK	MonitoredResourceListResponse	Success
Other Status Codes	ResourceProviderDefaultErrorResponse	Default error response.

Examples

MonitoredResources_List

Sample request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/listMonitoredResources?api-version=2020-07-01

Go

package armelastic_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/elastic/armelastic"
)

// x-ms-original-file: specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/MonitoredResources_List.json
func ExampleMonitoredResourcesClient_List() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armelastic.NewMonitoredResourcesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<monitor-name>",
		nil)
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("MonitoredResource.ID: %s\n", *v.ID)
		}
	}
}

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

Sample response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault",
      "sendingLogs": "True",
      "reasonForLogsStatus": "CapturedByRules"
    }
  ]
}

Definitions

Name	Description
ErrorResponseBody	ErrorResponseBody
MonitoredResource	The properties of a resource currently being monitored by the Elastic monitor resource.
MonitoredResourceListResponse	Response of a list operation.
ResourceProviderDefaultErrorResponse	RP default error response.
SendingLogs	SendingLogs

ErrorResponseBody

Object

ErrorResponseBody

Name	Type	Description
code	string	Error code.
details	ErrorResponseBody[]	Error details.
message	string	Error message.
target	string	Error target.

MonitoredResource

Object

The properties of a resource currently being monitored by the Elastic monitor resource.

Name	Type	Description
id	string	The ARM id of the resource.
reasonForLogsStatus	string	Reason for why the resource is sending logs (or why it is not sending).
sendingLogs	SendingLogs	SendingLogs Flag indicating the status of the resource for sending logs operation to Elastic.

MonitoredResourceListResponse

Object

Response of a list operation.

Name	Type	Description
nextLink	string	Link to the next set of results, if any.
value	MonitoredResource[]	Results of a list operation.

ResourceProviderDefaultErrorResponse

Object

RP default error response.

Name	Type	Description
error	ErrorResponseBody	ErrorResponseBody Response body of Error

SendingLogs

Enumeration

SendingLogs

Value	Description
True
False