Skip to content

serviceactivity-getmetricsfornetworkaccessremotenetworkbranchesbgpconnected.md

Latest commit

 

History

History
127 lines (102 loc) · 5.77 KB

serviceactivity-getmetricsfornetworkaccessremotenetworkbranchesbgpconnected.md

File metadata and controls

127 lines (102 loc) · 5.77 KB
title serviceActivity: getMetricsForNetworkAccessRemoteNetworkBranchesBGPConnected
description Retrieve the number of remote networks with connected BGP. A remote network represents a location such as a branch office where customer premises equipment (CPE) is connected to the nearest deployment of Global Secure Access service through IPsec tunnels.
author Zacharypeng
ms.localizationpriority medium
ms.subservice entra-monitoring-health
doc_type apiPageType
ms.date 10/23/2025

serviceActivity: getMetricsForNetworkAccessRemoteNetworkBranchesBGPConnected

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Retrieve the number of remote networks with connected BGP. A remote network represents a location such as a branch office where customer premises equipment (CPE) is connected to the nearest deployment of Global Secure Access service through IPsec tunnels.

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

[!INCLUDE rbac-entra-health-service-activity-apis]

HTTP request

GET /reports/serviceActivity/getMetricsForNetworkAccessRemoteNetworkBranchesBGPConnected(inclusiveIntervalStartDateTime={inclusiveIntervalStartDateTime},exclusiveIntervalEndDateTime={exclusiveIntervalEndDateTime})

Function parameters

In the request URL, provide the following query parameters with values.

Parameter Type Description
aggregationIntervalInMinutes Int32 Aggregation interval in minutes. The default value is 15, which sets the data to be aggregated into 15-minute sets. Allowed values are 5, 10, 15, and 30. Optional.
exclusiveIntervalEndDateTime DateTimeOffset Set the ending date and time in UTC. Required.
inclusiveIntervalStartDateTime DateTimeOffset Set the starting date and time in UTC. The earliest start time allowed is 30 days in the past. Required.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this function returns a 200 OK response code and a serviceActivityValueMetric collection in the response body.

Examples

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/reports/serviceActivity/getMetricsForNetworkAccessRemoteNetworkBranchesBGPConnected(inclusiveIntervalStartDateTime=2023-01-01T00:00:00Z,exclusiveIntervalEndDateTime=2023-01-01T00:20:00Z,aggregationIntervalInMinutes=10)

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/networkAccess/reports/$metadata#Collection(serviceActivityValueMetric)",
  "value": [
    {
      "intervalStartDateTime": "2023-01-10T00:00:00Z",
      "value": 4
    },
    {
      "intervalStartDateTime": "2023-01-10T00:10:00Z",
      "value": 5
    },
    {
      "intervalStartDateTime": "2023-01-10T00:20:00Z",
      "value": 4
    }
  ]
}