Data Collection Endpoints - Create

Servicio:: Monitor

Versión de la API:: 2024-03-11

Crea o actualiza un punto final de recogida de datos.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
dataCollectionEndpointName	path	True	string	Nombre del punto de conexión de recopilación de datos. El nombre distingue mayúsculas de minúsculas.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de API que se usará para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
location	True	string	Ubicación geográfica donde reside el recurso.
identity		Identity	Identidad de servicio administrada del recurso.
kind		KnownDataCollectionEndpointResourceKind	Tipo del recurso.
properties.configurationAccess		ConfigurationAccess	Punto de conexión utilizado por los clientes para acceder a su configuración.
properties.description		string	Descripción del punto de conexión de recopilación de datos.
properties.immutableId		string	Identificador inmutable de este recurso de punto de conexión de recopilación de datos. Esta propiedad es READ-ONLY.
properties.logsIngestion		LogsIngestion	Punto de conexión que usan los clientes para ingerir registros.
properties.metricsIngestion		MetricsIngestion	Punto de conexión que usan los clientes para ingerir métricas.
properties.networkAcls		NetworkAcls	Reglas de control de acceso de red para los puntos de conexión.
sku		Sku	SKU del recurso.
tags		object	Etiquetas de recursos.

Respuestas

Nombre	Tipo	Description
200 OK	DataCollectionEndpointResource	El endpoint de recogida de datos se actualizó con éxito
201 Created	DataCollectionEndpointResource	El endpoint de recopilación de datos se creó con éxito
Other Status Codes	ErrorResponseCommonV2	Error

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Create a data collection endpoint

Update a data collection endpoint

Create a data collection endpoint

Solicitud de ejemplo

HTTP

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

{
  "location": "eastus",
  "properties": {
    "networkAcls": {
      "publicNetworkAccess": "Enabled"
    }
  }
}

Respuesta de muestra

status code:: 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"
}

status code:: 201

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

Update a data collection endpoint

Solicitud de ejemplo

HTTP

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

{
  "location": "eastus",
  "tags": {
    "tag1": "A",
    "tag2": "B",
    "tag3": "C"
  },
  "properties": {}
}

Respuesta de muestra

status code:: 200

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myDataCollectionEndpoint",
  "name": "myDataCollectionEndpoint",
  "type": "Microsoft.Insights/dataCollectionEndpoints",
  "location": "eastus",
  "tags": {
    "tag1": "A",
    "tag2": "B",
    "tag3": "C"
  },
  "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:51:04.551992Z"
  },
  "etag": "0000ae31-0000-0100-0000-65fd441c0000"
}

status code:: 201

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myDataCollectionEndpoint",
  "name": "myDataCollectionEndpoint",
  "type": "Microsoft.Insights/dataCollectionEndpoints",
  "location": "eastus",
  "tags": {
    "tag1": "A",
    "tag2": "B",
    "tag3": "C"
  },
  "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:51:04.551992Z"
  },
  "etag": "0000ae31-0000-0100-0000-65fd441c0000"
}

Definiciones

Nombre	Description
ConfigurationAccess	Punto de conexión utilizado por los clientes para acceder a su configuración.
createdByType	Tipo de identidad que creó el recurso.
DataCollectionEndpointResource	Definición de recurso de alto nivel con seguimiento ARM.
DataCollectionEndpointResource.Sku	SKU del recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponseCommonV2	Respuesta de error
FailoverConfiguration	Metadatos del recurso. Esta propiedad solo puede actualizarse mediante el Plano de Control de Análisis de Registros para el Endpoint de Recogida de Datos con Destino de Análisis de Logs.
Identity	Identidad de servicio administrada del recurso.
KnownDataCollectionEndpointProvisioningState	Estado de aprovisionamiento de recursos. Esta propiedad es READ-ONLY.
KnownDataCollectionEndpointResourceKind	Tipo del recurso.
KnownLocationSpecProvisioningStatus	El estado de provisión de recursos en esta ubicación.
KnownPublicNetworkAccessOptions	Configuración que se va a establecer si se permite el acceso a la red desde la red pública de Internet a los puntos de conexión.
LocationSpec
LogsIngestion	Punto de conexión que usan los clientes para ingerir registros.
ManagedServiceIdentityType	Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).
Metadata	Metadatos del recurso. Esta propiedad solo puede actualizarse mediante el Plano de Control de Análisis de Registros para el Endpoint de Recogida de Datos con Destino de Análisis de Logs.
MetricsIngestion	Punto de conexión que usan los clientes para ingerir métricas.
NetworkAcls	Reglas de control de acceso de red para los puntos de conexión.
PrivateLinkScopedResource
Sku	Definición del modelo de recursos que representa la SKU
SkuTier	El proveedor de recursos necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.
SystemData	Metadatos relativos a la creación y última modificación del recurso.
UserAssignedIdentity	Propiedades de identidad asignadas por el usuario

ConfigurationAccess

Objeto

Punto de conexión utilizado por los clientes para acceder a su configuración.

Nombre	Tipo	Description
endpoint	string	Punto de conexión. Esta propiedad es READ-ONLY.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DataCollectionEndpointResource

Objeto

Definición de recurso de alto nivel con seguimiento ARM.

Nombre	Tipo	Description
etag	string	Etiqueta de entidad de recurso (ETag).
id	string	Identificación totalmente cualificada del recurso.
identity	Identity	Identidad de servicio administrada del recurso.
kind	KnownDataCollectionEndpointResourceKind	Tipo del recurso.
location	string	Ubicación geográfica donde reside el recurso.
name	string	Nombre del recurso.
properties.configurationAccess	ConfigurationAccess	Punto de conexión utilizado por los clientes para acceder a su configuración.
properties.description	string	Descripción del punto de conexión de recopilación de datos.
properties.failoverConfiguration	FailoverConfiguration	Metadatos del recurso. Esta propiedad solo puede actualizarse mediante el Plano de Control de Análisis de Registros para el Endpoint de Recogida de Datos con Destino de Análisis de Logs.
properties.immutableId	string	Identificador inmutable de este recurso de punto de conexión de recopilación de datos. Esta propiedad es READ-ONLY.
properties.logsIngestion	LogsIngestion	Punto de conexión que usan los clientes para ingerir registros.
properties.metadata	Metadata	Metadatos del recurso. Esta propiedad solo puede actualizarse mediante el Plano de Control de Análisis de Registros para el Endpoint de Recogida de Datos con Destino de Análisis de Logs.
properties.metricsIngestion	MetricsIngestion	Punto de conexión que usan los clientes para ingerir métricas.
properties.networkAcls	NetworkAcls	Reglas de control de acceso de red para los puntos de conexión.
properties.privateLinkScopedResources	PrivateLinkScopedResource[]	Lista de recursos de alcance de enlace privado Azure Monitor a los que está asociado este recurso de endpoint de recopilación de datos. Esta propiedad es READ-ONLY.
properties.provisioningState	KnownDataCollectionEndpointProvisioningState	Estado de aprovisionamiento de recursos. Esta propiedad es READ-ONLY.
sku	Sku	SKU del recurso.
systemData	SystemData	Metadatos relativos a la creación y última modificación del recurso.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso.

DataCollectionEndpointResource.Sku

Objeto

SKU del recurso.

Nombre	Tipo	Description
capacity	integer (int32)	Si la SKU admite el escalado horizontal o horizontal, se debe incluir el entero de capacidad. Si no es posible escalar horizontalmente o reducir horizontalmente el recurso, se puede omitir.
family	string	Si el servicio tiene diferentes generaciones de hardware, para la misma SKU, se puede capturar aquí.
name	string	Nombre de la SKU. Por ejemplo, P3. Normalmente es un código de letra y número
size	string	Tamaño de la SKU. Cuando el campo de nombre es la combinación de nivel y otro valor, este sería el código independiente.
tier	SkuTier	El proveedor de recursos necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponseCommonV2

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

FailoverConfiguration

Objeto

Metadatos del recurso. Esta propiedad solo puede actualizarse mediante el Plano de Control de Análisis de Registros para el Endpoint de Recogida de Datos con Destino de Análisis de Logs.

Nombre	Tipo	Description
activeLocation	string	Ubicación activa donde ocurrirá el flujo de datos.
locations	LocationSpec[]	Ubicaciones configuradas para conmutación por error.

Identity

Objeto

Identidad de servicio administrada del recurso.

Nombre	Tipo	Description
principalId	string (uuid)	Identificador de entidad de servicio de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
tenantId	string (uuid)	Identificador de inquilino de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
type	ManagedServiceIdentityType	Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).
userAssignedIdentities	<string, UserAssignedIdentity>	identidades de User-Assigned Conjunto de identidades asignadas por el usuario asociadas al recurso. Las claves de diccionario userAssignedIdentities serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Los valores del diccionario pueden ser objetos vacíos ({}) en las solicitudes.

KnownDataCollectionEndpointProvisioningState

Enumeración

Estado de aprovisionamiento de recursos. Esta propiedad es READ-ONLY.

Valor	Description
Creating
Updating
Deleting
Succeeded
Canceled
Failed

KnownDataCollectionEndpointResourceKind

Enumeración

Tipo del recurso.

Valor	Description
Linux
Windows

KnownLocationSpecProvisioningStatus

Enumeración

El estado de provisión de recursos en esta ubicación.

Valor	Description
Creating
Updating
Deleting
Succeeded
Canceled
Failed

KnownPublicNetworkAccessOptions

Enumeración

Configuración que se va a establecer si se permite el acceso a la red desde la red pública de Internet a los puntos de conexión.

Valor	Description
Enabled
Disabled
SecuredByPerimeter

LocationSpec

Objeto

Nombre	Tipo	Description
location	string	Nombre de la ubicación.
provisioningStatus	KnownLocationSpecProvisioningStatus	El estado de provisión de recursos en esta ubicación.

LogsIngestion

Objeto

Punto de conexión que usan los clientes para ingerir registros.

Nombre	Tipo	Description
endpoint	string	Punto de conexión. Esta propiedad es READ-ONLY.

ManagedServiceIdentityType

Enumeración

Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).

Valor	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Metadata

Objeto

Metadatos del recurso. Esta propiedad solo puede actualizarse mediante el Plano de Control de Análisis de Registros para el Endpoint de Recogida de Datos con Destino de Análisis de Logs.

Nombre	Tipo	Description
provisionedBy	string	Azure ofrece gestionar este recurso en nombre del cliente.
provisionedByImmutableId	string	Inmutable ID de Azure ofreciendo gestionar este recurso en nombre del cliente.
provisionedByResourceId	string	Resource Id de Azure Offering gestionando este recurso en nombre del cliente.

MetricsIngestion

Objeto

Punto de conexión que usan los clientes para ingerir métricas.

Nombre	Tipo	Description
endpoint	string	Punto de conexión. Esta propiedad es READ-ONLY.

NetworkAcls

Objeto

Reglas de control de acceso de red para los puntos de conexión.

Nombre	Tipo	Description
publicNetworkAccess	KnownPublicNetworkAccessOptions	Configuración que se va a establecer si se permite el acceso a la red desde la red pública de Internet a los puntos de conexión.

PrivateLinkScopedResource

Objeto

Nombre	Tipo	Description
resourceId	string	El resourceId del Azure Monitor Private Link Scope Scope Resource a través del cual este DCE está asociado con un Azure Monitor Private Link Scope.
scopeId	string	El inmutableId del recurso de alcance de enlace privado Azure Monitor al que se encuentra la asociación.

Sku

Objeto

Definición del modelo de recursos que representa la SKU

Nombre	Tipo	Description
capacity	integer (int32)	Si la SKU admite el escalado horizontal o horizontal, se debe incluir el entero de capacidad. Si no es posible escalar horizontalmente o reducir horizontalmente el recurso, se puede omitir.
family	string	Si el servicio tiene diferentes generaciones de hardware, para la misma SKU, se puede capturar aquí.
name	string	Nombre de la SKU. Por ejemplo, P3. Normalmente es un código de letra y número
size	string	Tamaño de la SKU. Cuando el campo de nombre es la combinación de nivel y otro valor, este sería el código independiente.
tier	SkuTier	El proveedor de recursos necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.

SkuTier

Enumeración

El proveedor de recursos necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.

Valor	Description
Free
Basic
Standard
Premium

SystemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

UserAssignedIdentity

Objeto

Propiedades de identidad asignadas por el usuario

Nombre	Tipo	Description
clientId	string (uuid)	Identificador de cliente de la identidad asignada.
principalId	string (uuid)	Identificador de entidad de seguridad de la identidad asignada.

Compartir a través de

Data Collection Endpoints - Create

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Create a data collection endpoint

Solicitud de ejemplo

Respuesta de muestra

Update a data collection endpoint

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ConfigurationAccess

createdByType

DataCollectionEndpointResource

DataCollectionEndpointResource.Sku

ErrorAdditionalInfo

ErrorDetail

ErrorResponseCommonV2

FailoverConfiguration

Identity

KnownDataCollectionEndpointProvisioningState

KnownDataCollectionEndpointResourceKind

KnownLocationSpecProvisioningStatus

KnownPublicNetworkAccessOptions

LocationSpec

LogsIngestion

ManagedServiceIdentityType

Metadata

MetricsIngestion

NetworkAcls

PrivateLinkScopedResource

Sku

SkuTier

SystemData

UserAssignedIdentity