• Home
  • Dynatrace API
  • Configuration
  • Azure credentials
  • GET monitored services

Azure credentials API - GET monitored services

Lists Azure services that are monitored by an Azure configuration.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/azure/credentials/{id}/services
SaaShttps://{your-environment-id}.live.dynatrace.com/azure/credentials/{id}/services
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/azure/credentials/{id}/services

Authentication

To execute this request, you need an access token with `ReadConfig` (Read configuration) scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
idstring

The ID of the required Azure credentials configuration.

pathrequired

Response

Response codes

CodeTypeDescription
200AzureMonitoredServicesDto

Success

Response body objects

The AzureMonitoredServicesDto object

ElementTypeDescription
metadataConfigurationMetadata

Metadata useful for debugging

servicesAzureSupportingService[]

A list of Azure services to be monitored. Available services are listed by /azure/supportedServices operation.

For each service, a list of metrics and dimensions can be specified. A list of supported metrics and dimensions for a given service can be checked in documentation.

List of metrics can be skipped (set to null), resulting in recommended (default) set of metrics and dimensions being chosen for monitoring. For built-in services, adjusting the list of metrics is not supported, therefore it needs to be null.

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescription
configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

clusterVersionstring

Dynatrace version.

The AzureSupportingService object

A service to be monitored.

ElementTypeDescription
namestring

The name of the service. Valid supported service names can be discovered using /azure/supportedServices restAPI

monitoredMetricsAzureMonitoredMetric[]

A list of metrics to be monitored for this service. It must include all the recommended metrics. If the list is null then recommended list of metrics for this service will be monitored.

The AzureMonitoredMetric object

A metric of service to be monitored.

ElementTypeDescription
namestring

The name of the metric of the service.

dimensionsstring[]

A list of metric's dimensions names. It must include all the recommended dimensions.

Response body JSON model

json
{ "metadata": { "configurationVersions": [ 4, 2 ], "currentConfigurationVersions": [ "1.0.4", "1.23" ], "clusterVersion": "1.192.1" }, "services": [ { "name": "string", "monitoredMetrics": [ { "name": "string", "dimensions": [ "string" ] } ] } ] }
Related topics
  • Microsoft Azure Integrations

    Set up Dynatrace deep code monitoring on Azure using OneAgent or OpenTelemetry.