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

Components - List

参考

服务:: Application Insights

API 版本:: 2015-05-01

获取订阅中所有 Application Insights 组件的列表。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/components?api-version=2015-05-01

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

响应

名称	类型	说明
200 OK	ApplicationInsightsComponentListResult	包含 0 个或多个 Application Insights 组件定义的列表。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ComponentsList.json

示例请求

HTTP

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Insights/components?api-version=2015-05-01

示例响应

状态代码:: 200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/components/my-component",
      "name": "my-component",
      "type": "Microsoft.Insights/components",
      "location": "South Central US",
      "tags": "",
      "kind": "web",
      "properties": {
        "ApplicationId": "my-component",
        "AppId": "16526d1a-dfba-4362-a9e9-123456789abc",
        "Application_Type": "web",
        "Flow_Type": "Bluefield",
        "Request_Source": "rest",
        "InstrumentationKey": "dc5931c7-a7ad-4ad0-89d6-123456789abc",
        "CreationDate": "2017-02-14T12:24:05.0041213+00:00",
        "TenantId": "f438d567-7177-4fe1-a5e3-123456789abc",
        "HockeyAppId": "",
        "HockeyAppToken": "",
        "provisioningState": "Succeeded",
        "SamplingPercentage": 75,
        "RetentionInDays": 90,
        "ConnectionString": "InstrumentationKey=dc5931c7-a7ad-4ad0-89d6-123456789abc",
        "DisableIpMasking": false,
        "ImmediatePurgeDataOn30Days": false,
        "IngestionMode": "ApplicationInsights"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/my-other-resource-group/providers/Microsoft.Insights/components/my-other-component",
      "name": "my-other-component",
      "type": "Microsoft.Insights/components",
      "location": "South Central US",
      "tags": "",
      "kind": "web",
      "properties": {
        "ApplicationId": "my-other-component",
        "AppId": "887f4bfd-b5fd-40d7-9fc3-123456789abc",
        "Application_Type": "web",
        "Flow_Type": "Bluefield",
        "Request_Source": "rest",
        "InstrumentationKey": "bc095013-3cf2-45ac-ab47-123456789abc",
        "CreationDate": "2017-01-24T01:05:38.5934061+00:00",
        "TenantId": "f438d567-7177-4fe1-a5e3-123456789abc",
        "HockeyAppId": "",
        "HockeyAppToken": "",
        "provisioningState": "Succeeded",
        "SamplingPercentage": 30,
        "RetentionInDays": 90,
        "ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc",
        "DisableIpMasking": false,
        "ImmediatePurgeDataOn30Days": false,
        "IngestionMode": "ApplicationInsights"
      }
    }
  ],
  "nextLink": null
}

定义

名称	说明
ApplicationInsightsComponent	Application Insights 组件定义。
ApplicationInsightsComponentListResult	描述 Application Insights 资源的列表。
ApplicationType	正在监视的应用程序的类型。
FlowType	Application Insights 系统用于确定此组件创建的流类型。这是在通过 REST API 创建/更新组件时设置为“Bluefield”。
IngestionMode	指示引入的流。
PrivateLinkScopedResource	专用链接范围资源参考。
RequestSource	介绍创建此 Application Insights 组件的工具。使用此 API 的客户应将此设置为默认的“rest”。

ApplicationInsightsComponent

Object

Application Insights 组件定义。

名称	类型	默认值	说明
id	string		Azure 资源 ID
kind	string		此组件引用的应用程序类型，用于自定义 UI。此值是任意多边形字符串，值通常应为以下值之一：Web、ios、其他、存储、java、手机。
location	string		资源位置
name	string		Azure 资源名称
properties.AppId	string		应用程序的 Application Insights 唯一 ID。
properties.ApplicationId	string		应用程序的唯一 ID。此字段镜像“名称”字段，无法更改。
properties.Application_Type	ApplicationType	web	正在监视的应用程序的类型。
properties.ConnectionString	string		Application Insights 组件连接字符串。
properties.CreationDate	string (date-time)		Application Insights 组件的创建日期（采用 ISO 8601 格式）。
properties.DisableIpMasking	boolean		禁用 IP 掩码。
properties.Flow_Type	FlowType	Bluefield	Application Insights 系统用于确定此组件创建的流类型。这是在通过 REST API 创建/更新组件时设置为“Bluefield”。
properties.HockeyAppId	string		将新应用程序添加到 HockeyApp 时创建的唯一应用程序 ID，用于与 HockeyApp 通信。
properties.HockeyAppToken	string		用于对 Application Insights 和 HockeyApp 之间的通信进行身份验证的令牌。
properties.ImmediatePurgeDataOn30Days	boolean		在 30 天后立即清除数据。
properties.IngestionMode	IngestionMode	ApplicationInsights	指示引入的流。
properties.InstrumentationKey	string		Application Insights 检测密钥。应用程序可用于标识发送到 Azure Application Insights 的所有遥测的目标的只读值。在构造每个新的 Application Insights 组件时，将提供此值。
properties.PrivateLinkScopedResources	PrivateLinkScopedResource[]		链接的专用链接范围资源列表。
properties.Request_Source	RequestSource	rest	介绍创建此 Application Insights 组件的工具。使用此 API 的客户应将此设置为默认的“rest”。
properties.RetentionInDays	integer	90	保留期（以天为单位）。
properties.SamplingPercentage	number (double)		正在为 Application Insights 遥测采样的应用程序生成的数据的百分比。
properties.TenantId	string		Azure 租户 ID。
properties.provisioningState	string		此组件的当前状态：是否已在已定义的资源组中预配。用户无法更改此值，但可以从中读取此值。值将包括 Succeeded、Deploying、Canceled 和 Failed。
tags	object		资源标记
type	string		Azure 资源类型

ApplicationInsightsComponentListResult

Object

描述 Application Insights 资源的列表。

名称	类型	说明
nextLink	string	如果结果集中返回的组件过多，则获取下一组 Application Insights 组件定义的 URI。
value	ApplicationInsightsComponent[]	Application Insights 组件定义列表。

ApplicationType

枚举

正在监视的应用程序的类型。

值	说明
other
web

FlowType

枚举

Application Insights 系统用于确定此组件创建的流类型。这是在通过 REST API 创建/更新组件时设置为“Bluefield”。

值	说明
Bluefield

IngestionMode

枚举

指示引入的流。

值	说明
ApplicationInsights
ApplicationInsightsWithDiagnosticSettings
LogAnalytics

PrivateLinkScopedResource

Object

专用链接范围资源参考。

名称	类型	说明
ResourceId	string	专用链接范围资源的完整资源 ID。
ScopeId	string	专用链接范围唯一标识符。

RequestSource

枚举

介绍创建此 Application Insights 组件的工具。使用此 API 的客户应将此设置为默认的“rest”。

值	说明
rest