Monitors - List
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 |
---|---|---|---|---|
subscription
|
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 |
Success |
|
Other Status Codes |
Default error response. |
Examples
Monitors_List
Sample request
Sample response
{
"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 |
---|---|
Company |
Company information of the user to be passed to partners. |
created |
The type of identity that created the resource. |
Elastic |
Details of the user's elastic deployment associated with the monitor resource. |
Elastic |
Details of the user's elastic account. |
Elastic |
Monitor resource. |
Elastic |
Response of a list operation. |
Elastic |
Elastic Resource Properties. |
Error |
ErrorResponseBody |
Identity |
Identity properties. |
Liftr |
|
Managed |
Managed Identity types. |
Monitoring |
Flag specifying if the resource monitoring is enabled or disabled. |
Monitor |
Properties specific to the monitor resource. |
Provisioning |
ProvisioningState |
Resource |
RP default error response. |
Resource |
Microsoft.Elastic SKU. |
system |
Metadata pertaining to creation and last modification of the resource. |
User |
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 |
Identity properties of the monitor resource. |
|
location |
string |
The location of the monitor resource |
name |
string |
Name of the monitor resource. |
properties |
Properties of the monitor resource. |
|
sku |
SKU of the monitor resource. |
|
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 |
Results of a list operation. |
ElasticProperties
Elastic Resource Properties.
Name | Type | Description |
---|---|---|
elasticCloudDeployment |
Details of the elastic cloud deployment. |
|
elasticCloudUser |
Details of the user's elastic account. |
ErrorResponseBody
ErrorResponseBody
Name | Type | Description |
---|---|---|
code |
string |
Error code. |
details |
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 |
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 |
Elastic cloud properties. |
|
liftrResourceCategory | ||
liftrResourcePreference |
integer |
The priority of the resource. |
monitoringStatus |
Flag specifying if the resource monitoring is enabled or disabled. |
|
provisioningState |
ProvisioningState |
|
userInfo |
User information. |
ProvisioningState
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 |
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 |
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 |
The type of identity that last modified the resource. |
UserInfo
User Information to be passed to partners.
Name | Type | Description |
---|---|---|
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 |