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

Data Collection Endpoints - Get

服务:: Monitor

API 版本:: 2023-03-11

返回指定的数据收集终结点。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionEndpoints/{dataCollectionEndpointName}?api-version=2023-03-11

URI 参数

名称	在	必需	类型	说明
dataCollectionEndpointName	path	True	string	数据收集终结点的名称。名称不区分大小写。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

响应

名称	类型	说明
200 OK	DataCollectionEndpointResource	请求成功完成
Other Status Codes	ErrorResponseCommonV2	错误

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Get data collection endpoint

GET https://management.azure.com/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myDataCollectionEndpoint?api-version=2023-03-11

from azure.identity import DefaultAzureCredential

from azure.mgmt.monitor import MonitorManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-monitor
# USAGE
    python data_collection_endpoints_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MonitorManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="703362b3-f278-4e4b-9179-c76eaf41ffc2",
    )

    response = client.data_collection_endpoints.get(
        resource_group_name="myResourceGroup",
        data_collection_endpoint_name="myDataCollectionEndpoint",
    )
    print(response)


# x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2023-03-11/examples/DataCollectionEndpointsGet.json
if __name__ == "__main__":
    main()

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

示例响应

状态代码:: 200

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myDataCollectionEndpoint",
  "name": "myDataCollectionEndpoint",
  "type": "Microsoft.Insights/dataCollectionEndpoints",
  "location": "eastus",
  "properties": {
    "immutableId": "dce-cd85a330eb664aa3bc7883cc394b0000",
    "configurationAccess": {
      "endpoint": "https://mydatacollectionendpoint-71ib.eastus-1.handler.control.monitor.azure.com"
    },
    "logsIngestion": {
      "endpoint": "https://mydatacollectionendpoint-71ib.eastus-1.ingest.monitor.azure.com"
    },
    "metricsIngestion": {
      "endpoint": "https://mydatacollectionendpoint-71ib.eastus-1.metrics.ingest.monitor.azure.com"
    },
    "networkAcls": {
      "publicNetworkAccess": "Enabled"
    },
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2024-03-22T08:40:59.2431682Z",
    "lastModifiedBy": "user1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-03-22T08:40:59.2431682Z"
  },
  "etag": "0000ae31-0000-0100-0000-65fd441c0000"
}

定义

名称	说明
ConfigurationAccess	客户端用来访问其配置的终结点。
createdByType	创建资源的标识的类型。
DataCollectionEndpointResource	ARM 跟踪的顶级资源的定义。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponseCommonV2	错误响应
FailoverConfiguration	此终结点上的故障转移配置。此属性为 READ-ONLY。
Identity	资源的托管服务标识。
KnownDataCollectionEndpointProvisioningState	资源预配状态。此属性为 READ-ONLY。
KnownDataCollectionEndpointResourceKind	资源的种类。
KnownLocationSpecProvisioningStatus	此位置中的资源预配状态。
KnownPublicNetworkAccessOptions	用于设置是否允许从公共 Internet 访问终结点的网络访问的配置。
LocationSpec
LogsIngestion	客户端用于引入日志的终结点。
ManagedServiceIdentityType	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。
Metadata	资源的元数据。此属性为 READ-ONLY。
MetricsIngestion	客户端用于引入指标的终结点。
NetworkAcls	终结点的网络访问控制规则。
PrivateLinkScopedResource
SystemData	与创建和上次修改资源相关的元数据。
UserAssignedIdentity	用户分配的标识属性

ConfigurationAccess

Object

客户端用来访问其配置的终结点。

名称	类型	说明
endpoint	string	终结点。此属性为 READ-ONLY。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

DataCollectionEndpointResource

Object

ARM 跟踪的顶级资源的定义。

名称	类型	说明
etag	string	资源实体标记（ETag）。
id	string	资源的完全限定 ID。
identity	Identity	资源的托管服务标识。
kind	KnownDataCollectionEndpointResourceKind	资源的种类。
location	string	资源所在的地理位置。
name	string	资源的名称。
properties.configurationAccess	ConfigurationAccess	客户端用来访问其配置的终结点。
properties.description	string	数据收集终结点的说明。
properties.failoverConfiguration	FailoverConfiguration	此终结点上的故障转移配置。此属性为 READ-ONLY。
properties.immutableId	string	此数据收集终结点资源的不可变 ID。此属性为 READ-ONLY。
properties.logsIngestion	LogsIngestion	客户端用于引入日志的终结点。
properties.metadata	Metadata	资源的元数据。此属性为 READ-ONLY。
properties.metricsIngestion	MetricsIngestion	客户端用于引入指标的终结点。
properties.networkAcls	NetworkAcls	终结点的网络访问控制规则。
properties.privateLinkScopedResources	PrivateLinkScopedResource[]	与此数据收集终结点资源关联的 Azure Monitor 专用链接范围资源列表。此属性为 READ-ONLY。
properties.provisioningState	KnownDataCollectionEndpointProvisioningState	资源预配状态。此属性为 READ-ONLY。
systemData	SystemData	与创建和上次修改资源相关的元数据。
tags	object	资源标记。
type	string	资源的类型。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponseCommonV2

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

FailoverConfiguration

Object

此终结点上的故障转移配置。此属性为 READ-ONLY。

名称	类型	说明
activeLocation	string	将发生数据流的活动位置。
locations	LocationSpec[]	为故障转移配置的位置。

Identity

Object

资源的托管服务标识。

名称	类型	说明
principalId	string (uuid)	系统分配标识的服务主体 ID。此属性仅针对系统分配的标识提供。
tenantId	string (uuid)	系统分配标识的租户 ID。此属性仅针对系统分配的标识提供。
type	ManagedServiceIdentityType	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned 标识与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID，格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。字典值可以是请求中的空对象（{}）。

KnownDataCollectionEndpointProvisioningState

枚举

资源预配状态。此属性为 READ-ONLY。

值	说明
Creating
Updating
Deleting
Succeeded
Canceled
Failed

KnownDataCollectionEndpointResourceKind

枚举

资源的种类。

值	说明
Linux
Windows

KnownLocationSpecProvisioningStatus

枚举

此位置中的资源预配状态。

值	说明
Creating
Updating
Deleting
Succeeded
Canceled
Failed

KnownPublicNetworkAccessOptions

枚举

用于设置是否允许从公共 Internet 访问终结点的网络访问的配置。

值	说明
Enabled
Disabled
SecuredByPerimeter

LocationSpec

Object

名称	类型	说明
location	string	位置的名称。
provisioningStatus	KnownLocationSpecProvisioningStatus	此位置中的资源预配状态。

LogsIngestion

Object

客户端用于引入日志的终结点。

名称	类型	说明
endpoint	string	终结点。此属性为 READ-ONLY。

ManagedServiceIdentityType

枚举

托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。

值	说明
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Metadata

Object

资源的元数据。此属性为 READ-ONLY。

名称	类型	说明
provisionedBy	string	Azure 产品/服务代表客户管理此资源。
provisionedByImmutableId	string	Azure 产品/服务的不可变 ID，代表客户管理此资源。
provisionedByResourceId	string	Azure 产品/服务的资源 ID，代表客户管理此资源。

MetricsIngestion

Object

客户端用于引入指标的终结点。

名称	类型	说明
endpoint	string	终结点。此属性为 READ-ONLY。

NetworkAcls

Object

终结点的网络访问控制规则。

名称	类型	说明
publicNetworkAccess	KnownPublicNetworkAccessOptions	用于设置是否允许从公共 Internet 访问终结点的网络访问的配置。

PrivateLinkScopedResource

Object

名称	类型	说明
resourceId	string	Azure Monitor 专用链接范围范围的资源的 resourceId，此 DCE 与此 DCE 关联到 Azure Monitor 专用链接范围。
scopeId	string	关联到的 Azure Monitor 专用链接范围资源的不可变Id。

SystemData

Object

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

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

UserAssignedIdentity

Object

用户分配的标识属性

名称	类型	说明
clientId	string (uuid)	分配的标识的客户端 ID。
principalId	string (uuid)	已分配标识的主体 ID。

通过

Data Collection Endpoints - Get

URI 参数

响应

安全性

azure_auth

作用域

示例

Get data collection endpoint

示例请求

示例响应

定义

ConfigurationAccess

createdByType

DataCollectionEndpointResource

ErrorAdditionalInfo

ErrorDetail

ErrorResponseCommonV2

FailoverConfiguration

Identity

KnownDataCollectionEndpointProvisioningState

KnownDataCollectionEndpointResourceKind

KnownLocationSpecProvisioningStatus

KnownPublicNetworkAccessOptions

LocationSpec

LogsIngestion

ManagedServiceIdentityType

Metadata

MetricsIngestion

NetworkAcls

PrivateLinkScopedResource

SystemData

UserAssignedIdentity