你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Monitors - List

列出指定订阅下的所有监视器。

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

URI 参数

名称 必需 类型 说明
subscriptionId
path True

string

Azure 订阅 ID。 这是 GUID 格式的字符串, (例如 00000000-0000-0000-0000-00000000000000)

api-version
query True

string

要与 HTTP 请求一起使用的 API 版本。

响应

名称 类型 说明
200 OK

ElasticMonitorResourceListResponse

成功

Other Status Codes

ResourceProviderDefaultErrorResponse

默认错误响应。

示例

Monitors_List

示例请求

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

示例响应

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

定义

名称 说明
CompanyInfo

要传递给合作伙伴的用户的公司信息。

createdByType

创建资源的标识类型。

ElasticCloudDeployment

与监视器资源关联的用户弹性部署的详细信息。

ElasticCloudUser

用户弹性帐户的详细信息。

ElasticMonitorResource

监视资源。

ElasticMonitorResourceListResponse

列表操作的响应。

ElasticProperties

弹性资源属性。

ErrorResponseBody

ErrorResponseBody

IdentityProperties

标识属性。

LiftrResourceCategories
ManagedIdentityTypes

托管标识类型。

MonitoringStatus

指定是启用或禁用资源监视的标志。

MonitorProperties

特定于监视器资源的属性。

ProvisioningState

ProvisioningState

ResourceProviderDefaultErrorResponse

RP 默认错误响应。

ResourceSku

Microsoft.Elastic SKU。

systemData

与资源的创建和上次修改相关的元数据。

UserInfo

要传递给合作伙伴的用户信息。

CompanyInfo

要传递给合作伙伴的用户的公司信息。

名称 类型 说明
business

string

公司业务

country

string

公司位置的国家/地区。

domain

string

公司的域

employeesNumber

string

公司员工数

state

string

公司位置的状态。

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

ElasticCloudDeployment

与监视器资源关联的用户弹性部署的详细信息。

名称 类型 说明
azureSubscriptionId

string

弹性部署的关联 Azure 订阅 ID。

deploymentId

string

弹性部署 ID

elasticsearchRegion

string

在 Elastic 端进行部署的区域。

elasticsearchServiceUrl

string

Elastic 部署的 Elasticsearch 引入终结点。

kibanaServiceUrl

string

弹性部署的 Kibana 终结点。

kibanaSsoUrl

string

Kibana 仪表板 Elastic 部署的 sso URL。

name

string

弹性部署名称

ElasticCloudUser

用户弹性帐户的详细信息。

名称 类型 说明
elasticCloudSsoDefaultUrl

string

Elastic cloud 默认仪表板 Elastic 用户帐户的 sso URL。

emailAddress

string

弹性用户帐户的Email。

id

string

用户的弹性帐户的用户 ID。

ElasticMonitorResource

监视资源。

名称 类型 说明
id

string

监视器资源的 ARM ID。

identity

IdentityProperties

监视器资源的标识属性。

location

string

监视器资源的位置

name

string

监视器资源的名称。

properties

MonitorProperties

监视器资源的属性。

sku

ResourceSku

监视器资源的 SKU。

systemData

systemData

与此资源相关的系统元数据

tags

object

监视器资源的标记。

type

string

监视器资源的类型。

ElasticMonitorResourceListResponse

列表操作的响应。

名称 类型 说明
nextLink

string

链接到下一组结果(如果有)。

value

ElasticMonitorResource[]

列表操作的结果。

ElasticProperties

弹性资源属性。

名称 类型 说明
elasticCloudDeployment

ElasticCloudDeployment

弹性云部署的详细信息。

elasticCloudUser

ElasticCloudUser

用户弹性帐户的详细信息。

ErrorResponseBody

ErrorResponseBody

名称 类型 说明
code

string

错误代码。

details

ErrorResponseBody[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

IdentityProperties

标识属性。

名称 类型 说明
principalId

string

标识 ID。

tenantId

string

资源的租户 ID。

type

ManagedIdentityTypes

托管标识类型。

LiftrResourceCategories

名称 类型 说明
MonitorLogs

string

Unknown

string

ManagedIdentityTypes

托管标识类型。

名称 类型 说明
SystemAssigned

string

MonitoringStatus

指定是启用或禁用资源监视的标志。

名称 类型 说明
Disabled

string

Enabled

string

MonitorProperties

特定于监视器资源的属性。

名称 类型 说明
elasticProperties

ElasticProperties

弹性云属性。

liftrResourceCategory

LiftrResourceCategories

liftrResourcePreference

integer

资源的优先级。

monitoringStatus

MonitoringStatus

指定是启用或禁用资源监视的标志。

provisioningState

ProvisioningState

ProvisioningState
监视资源的预配状态。

userInfo

UserInfo

用户信息。

ProvisioningState

ProvisioningState

名称 类型 说明
Accepted

string

Canceled

string

Creating

string

Deleted

string

Deleting

string

Failed

string

NotSpecified

string

Succeeded

string

Updating

string

ResourceProviderDefaultErrorResponse

RP 默认错误响应。

名称 类型 说明
error

ErrorResponseBody

ErrorResponseBody
错误的响应正文

ResourceSku

Microsoft.Elastic SKU。

名称 类型 说明
name

string

SKU 的名称。

systemData

与资源的创建和上次修改相关的元数据。

名称 类型 说明
createdAt

string

资源创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

资源上次修改的时间戳 (UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识类型。

UserInfo

要传递给合作伙伴的用户信息。

名称 类型 说明
companyInfo

CompanyInfo

要传递给合作伙伴的用户的公司信息。

companyName

string

用户的公司名称

emailAddress

string

Elastic 用于联系用户的Email(如果需要)

firstName

string

用户的名字

lastName

string

用户的姓氏