Monitors - List

Reference

Service:: Elastic

API Version:: 2020-07-01

List all monitors under the specified subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/monitors?api-version=2020-07-01

URI Parameters

Name	In	Required	Type	Description
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	ElasticMonitorResourceListResponse	Success
Other Status Codes	ResourceProviderDefaultErrorResponse	Default error response.

Examples

Monitors_List

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Elastic/monitors?api-version=2020-07-01

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/Monitors_List.json
func ExampleMonitorsClient_List() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armelastic.NewMonitorsClient("<subscription-id>", cred, nil)
	pager := client.List(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("ElasticMonitorResource.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/monitors/myMonitor",
      "name": "myMonitor",
      "type": "Microsoft.Elastic/monitors",
      "properties": {
        "provisioningState": "Succeeded",
        "monitoringStatus": "Enabled",
        "elasticProperties": {
          "elasticCloudUser": {
            "emailAddress": "alice@microsoft.com",
            "id": "myid123",
            "elasticCloudSsoDefaultUrl": "https://examplessourl.com"
          },
          "elasticCloudDeployment": {
            "name": "deploymentname",
            "deploymentId": "deployment_id",
            "azureSubscriptionId": "00000000-0000-0000-0000-000000000000",
            "elasticsearchRegion": "azure-westus2",
            "elasticsearchServiceUrl": "https://elasticsearchendpoint.com",
            "kibanaServiceUrl": "https://kibanaserviceurl.com",
            "kibanaSsoUrl": "https://kibanssourl.com"
          }
        },
        "liftrResourceCategory": "MonitorLogs",
        "liftrResourcePreference": 0
      },
      "tags": {
        "Environment": "Dev"
      },
      "location": "West US 2"
    }
  ]
}

Definitions

Name	Description
CompanyInfo	Company information of the user to be passed to partners.
createdByType	The type of identity that created the resource.
ElasticCloudDeployment	Details of the user's elastic deployment associated with the monitor resource.
ElasticCloudUser	Details of the user's elastic account.
ElasticMonitorResource	Monitor resource.
ElasticMonitorResourceListResponse	Response of a list operation.
ElasticProperties	Elastic Resource Properties.
ErrorResponseBody	ErrorResponseBody
IdentityProperties	Identity properties.
LiftrResourceCategories
ManagedIdentityTypes	Managed Identity types.
MonitoringStatus	Flag specifying if the resource monitoring is enabled or disabled.
MonitorProperties	Properties specific to the monitor resource.
ProvisioningState	ProvisioningState
ResourceProviderDefaultErrorResponse	RP default error response.
ResourceSku	Microsoft.Elastic SKU.
systemData	Metadata pertaining to creation and last modification of the resource.
UserInfo	User Information to be passed to partners.

CompanyInfo

Company information of the user to be passed to partners.

Name	Type	Description
business	string	Business of the company
country	string	Country of the company location.
domain	string	Domain of the company
employeesNumber	string	Number of employees in the company
state	string	State of the company location.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ElasticCloudDeployment

Details of the user's elastic deployment associated with the monitor resource.

Name	Type	Description
azureSubscriptionId	string	Associated Azure subscription Id for the elastic deployment.
deploymentId	string	Elastic deployment Id
elasticsearchRegion	string	Region where Deployment at Elastic side took place.
elasticsearchServiceUrl	string	Elasticsearch ingestion endpoint of the Elastic deployment.
kibanaServiceUrl	string	Kibana endpoint of the Elastic deployment.
kibanaSsoUrl	string	Kibana dashboard sso URL of the Elastic deployment.
name	string	Elastic deployment name

ElasticCloudUser

Details of the user's elastic account.

Name	Type	Description
elasticCloudSsoDefaultUrl	string	Elastic cloud default dashboard sso URL of the Elastic user account.
emailAddress	string	Email of the Elastic User Account.
id	string	User Id of the elastic account of the User.

ElasticMonitorResource

Monitor resource.

Name	Type	Description
id	string	ARM id of the monitor resource.
identity	IdentityProperties	Identity properties of the monitor resource.
location	string	The location of the monitor resource
name	string	Name of the monitor resource.
properties	MonitorProperties	Properties of the monitor resource.
sku	ResourceSku	SKU of the monitor resource.
systemData	systemData	The system metadata relating to this resource
tags	object	The tags of the monitor resource.
type	string	The type of the monitor resource.

ElasticMonitorResourceListResponse

Response of a list operation.

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

ElasticProperties

Elastic Resource Properties.

Name	Type	Description
elasticCloudDeployment	ElasticCloudDeployment	Details of the elastic cloud deployment.
elasticCloudUser	ElasticCloudUser	Details of the user's elastic account.

ErrorResponseBody

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

IdentityProperties

Identity properties.

Name	Type	Description
principalId	string	The identity ID.
tenantId	string	The tenant ID of resource.
type	ManagedIdentityTypes	Managed identity type.

LiftrResourceCategories

Name	Type	Description
MonitorLogs	string
Unknown	string

ManagedIdentityTypes

Managed Identity types.

Name	Type	Description
SystemAssigned	string

MonitoringStatus

Flag specifying if the resource monitoring is enabled or disabled.

Name	Type	Description
Disabled	string
Enabled	string

MonitorProperties

Properties specific to the monitor resource.

Name	Type	Description
elasticProperties	ElasticProperties	Elastic cloud properties.
liftrResourceCategory	LiftrResourceCategories
liftrResourcePreference	integer	The priority of the resource.
monitoringStatus	MonitoringStatus	Flag specifying if the resource monitoring is enabled or disabled.
provisioningState	ProvisioningState	ProvisioningState Provisioning state of the monitor resource.
userInfo	UserInfo	User information.

ProvisioningState

Name	Type	Description
Accepted	string
Canceled	string
Creating	string
Deleted	string
Deleting	string
Failed	string
NotSpecified	string
Succeeded	string
Updating	string

ResourceProviderDefaultErrorResponse

RP default error response.

Name	Type	Description
error	ErrorResponseBody	ErrorResponseBody Response body of Error

ResourceSku

Microsoft.Elastic SKU.

Name	Type	Description
name	string	Name of the SKU.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserInfo

User Information to be passed to partners.

Name	Type	Description
companyInfo	CompanyInfo	Company information of the user to be passed to partners.
companyName	string	Company name of the user
emailAddress	string	Email of the user used by Elastic for contacting them if needed
firstName	string	First name of the user
lastName	string	Last name of the user