Azure credentials API - GET credentials

Gets the configuration of the specified Azure credentials.

The request produces an application/json payload.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/azure/credentials/{id}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/azure/credentials/{id}

Authentication

To execute this request, you need the Read configuration (ReadConfig) permission assigned to your API token. To learn how to obtain and use it, see Authentication.

Parameters

Parameter Type Description In Required
id string

The ID of the required Azure credentials configuration.

path required

Response format

The AzureCredentials object

Configuration of Azure app-level credentials.

Element Type Description
metadata ConfigurationMetadata
id string

The Dynatrace entity ID of the Azure credentials configuration.

label string

The unique name of the Azure credentials configuration.

Allowed characters are letters, numbers, and spaces. Also the special characters .+-_ are allowed.

appId string

The Application ID (also referred to as Client ID)

The combination of Application ID and Directory ID must be unique.

directoryId string

The Directory ID (also referred to as Tenant ID)

The combination of Application ID and Directory ID must be unique.

key string

The secret key associated with the Application ID.

For security reasons, GET requests return this field as null.

Submit your key on creation or update of the configuration. If the field is omitted during an update, the old value remains unaffected.

active boolean

The monitoring is enabled (true) or disabled (false).

If not set on creation, the true value is used.

If the field is omitted during an update, the old value remains unaffected.

autoTagging boolean

The automatic capture of Azure tags is on (true) or off (false).

monitorOnlyTaggedEntities boolean

Monitor only resources that have specified Azure tags (true) or all resources (false).

monitorOnlyTagPairs CloudTag[]

A list of Azure tags to be monitored.

You can specify up to 10 tags. A resource tagged with any of the specified tags is monitored.

Only applicable when the monitorOnlyTaggedEntities parameter is set to true.

supportingServices AzureSupportingService[]

A list of Azure supporting services to be monitored. For each service there's a sublist of its metrics and the metrics' dimensions that should be monitored. All of these elements (services, metrics, dimensions) must have corresponding static definitions on the server.

The AzureSupportingService object

A supporting service to be monitored.

Element Type Description
name string

The name of the supporting service.

monitoredMetrics AzureMonitoredMetric[]

A list of metrics to be monitored for this service. It must include all the recommended metrics.

The AzureMonitoredMetric object

A metric of supporting service to be monitored.

Element Type Description
name string

The name of the metric of the supporting service.

dimensions string[]

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

The CloudTag object

A cloud tag.

Element Type Description
name string

The name of the tag.

value string

The value of the tag.

If set to null, then resources with any value of the tag are monitored.

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description
configurationVersions integer[]

A Sorted list of the version numbers of the configuration.

clusterVersion string

Dynatrace server version.

Example

In this example, the request lists the parameters of the Booking application Azure credentials configuration with the ID of AZURE_CREDENTIALS-357FDA338DAAF338.

Curl

curl -X GET \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/azure/credentials/AZURE_CREDENTIALS-357FDA338DAAF338 \
  -H 'Authorization: Api-token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/config/v1/azure/credentials/AZURE_CREDENTIALS-357FDA338DAAF338

Response body

{
  "metadata": {
    "configurationVersions": [
      0
    ],
    "clusterVersion": "1.189.0.20200225-180731"
  },
  "id": "AZURE_CREDENTIALS-357FDA338DAAF338",
  "label": "Booking application",
  "appId": "c4431dec-34fe-4d4c-ad93-aea38b4f944e",
  "directoryId": "f836b63d-8c92-4ad8-a314-bb1eeka46aa1",
  "key": null,
  "active": true,
  "autoTagging": true,
  "monitorOnlyTaggedEntities": true,
  "monitorOnlyTagPairs": [
    {
      "name": "bookingApp",
      "value": "mobile"
    },
    {
      "name": "bookingApp",
      "value": "browser"
    }
  ]
}

Response code

200