Azure credentials API - POST new credentials

Creates a new Azure credentials configuration.

The body must not provide an ID. The Dynatrace server automatically assigns an ID.

The request consumes and produces an application/json payload.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/azure/credentials
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/azure/credentials

Authentication

To execute this request, you need an access token with WriteConfig scope.

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

Parameters

Parameter
Type
Description
In
Required
body

The JSON body of the request. Contains parameters of the new Azure credentials configuration.

body
optional

Request body objects

The AzureCredentialsCreation object

Configuration of Azure app-level credentials.

Element
Type
Description
Required
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.

optional
appId
string

The application ID (also referred to as client ID).

The field is required when creating a new credentials configuration.

The field is ignored during an update, the old value remains unaffected.

required
autoTagging
boolean

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

required
directoryId
string

The directory ID (also referred to as tenant ID).

The field is required when creating a new credentials configuration.

The field is ignored during an update, the old value remains unaffected.

required
id
string

The Dynatrace entity ID of the Azure credentials configuration.

optional
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.

The field is required when creating a new credentials configuration. If the field is omitted during an update, the old value remains unaffected.

required
label
string

The unique name of the Azure credentials configuration.

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

required
metadata

Metadata useful for debugging

optional
monitorOnlyExcludingTagPairs

A list of Azure tags to be excluded from monitoring.

You can specify up to 20 tags. A resource tagged with any of the specified tags will not be monitored.

Only applicable when the monitorOnlyTaggedEntities parameter is set to true.

optional
monitorOnlyTagPairs

A list of Azure tags to be monitored.

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

Only applicable when the monitorOnlyTaggedEntities parameter is set to true.

optional
monitorOnlyTaggedEntities
boolean

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

required
supportingServices

Deprecated. To manage services use /azure/credentials/{id}/services operation. Built-in services are not supported here.

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.

optional

The ConfigurationMetadata object

Metadata useful for debugging

Element
Type
Description
Required
clusterVersion
string

Dynatrace version.

optional
configurationVersions
integer[]

A sorted list of the version numbers of the configuration.

optional
currentConfigurationVersions
string[]

A sorted list of version numbers of the configuration.

optional

The CloudTag object

A cloud tag.

Element
Type
Description
Required
name
string

The name of the tag.

optional
value
string

The value of the tag.

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

optional

The AzureSupportingService object

A service to be monitored.

Element
Type
Description
Required
monitoredMetrics

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.

optional
name
string

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

required

The AzureMonitoredMetric object

A metric of service to be monitored.

Element
Type
Description
Required
dimensions
string[]

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

required
name
string

The name of the metric of the service.

required

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
  "active": true,
  "appId": "string",
  "autoTagging": true,
  "directoryId": "string",
  "id": "string",
  "key": "string",
  "label": "string",
  "metadata": {
    "clusterVersion": "1.192.1",
    "configurationVersions": [
      4,
      2
    ],
    "currentConfigurationVersions": [
      "1.0.4",
      "1.23"
    ]
  },
  "monitorOnlyExcludingTagPairs": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "monitorOnlyTagPairs": [
    {}
  ],
  "monitorOnlyTaggedEntities": true,
  "supportingServices": [
    {
      "monitoredMetrics": [
        {
          "dimensions": [
            "string"
          ],
          "name": "string"
        }
      ],
      "name": "string"
    }
  ]
}

Response

Response codes

Code
Type
Description
201

Success. The new Azure credentials configuration has been created. The response body contains the ID of the configuration.

400

Failed. The input is invalid.

Response body objects

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element
Type
Description
description
string

A short description of the Dynatrace entity.

id
string

The ID of the Dynatrace entity.

name
string

The name of the Dynatrace entity.

Response body JSON model

{
  "description": "Dynatrace entity for the REST API example",
  "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
  "name": "Dynatrace entity"
}

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/azure/credentials/validator
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/azure/credentials/validator

Authentication

To execute this request, you need an access token with WriteConfig scope.

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

Response

Response codes

Code
Type
Description
204
-

Validated. The submitted configuration is valid. The response doesn't have a body.

400

Failed. The input is invalid.

Example

In this example, the request creates a new configuration of Azure app-level credentials.

The API token is passed in the Authorization header.

Because the request body is lengthy, it is truncated in this example Curl section. See the full body in the Request body section.

Curl

curl -X POST \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/azure/credentials \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \
  -d '{<truncated - see the Request body section >}'

Request URL

https://mySampleEnv.live.dynatrace.com/api/config/v1/azure/credentials

Request body

{
  "label": "Booking application",
  "appId": "c4431dec-34fe-4d4c-ad93-aea38b4f944e",
  "directoryId": "f836b63d-8c92-4ad8-a314-bb1eeka46aa1",
  "key": "fzksjdfsjdfghsrtgbh",
  "active": true,
  "autoTagging": true,
  "monitorOnlyTaggedEntities": true,
  "monitorOnlyTagPairs": [
    {
      "name": "bookingApp",
      "value": "mobile"
    },
    {
      "name": "bookingApp",
      "value": "browser"
    }
  ]
}

Response body

{
    "id": "AZURE_CREDENTIALS-357FDA338DAAF338",
    "name": "Booking application"
}

Response code

201

Related topics