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.

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

Parameters

Parameter Type Description In Required
body AzureCredentials

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

body optional

The AzureCredentials object

Configuration of Azure app-level credentials.

Element Type Description Required
metadata ConfigurationMetadata

Metadata useful for debugging.

optional
id string

The Dynatrace entity ID of the Azure credentials configuration.

optional
label string

The unique name of the Azure credentials configuration.

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

required
appId string

The Application ID (also referred to as Client ID)

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

required
directoryId string

The Directory ID (also referred to as Tenant ID)

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

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

optional
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
autoTagging boolean

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

required
monitorOnlyTaggedEntities boolean

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

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

required

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, then resources with any value of the tag are monitored.

optional

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description Required
clusterVersion string

Dynatrace server version.

optional
configurationVersions integer[]

A Sorted list of the version numbers of the configuration.

optional

Response format

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description
id string

The ID of the Dynatrace entity.

name string

The name of the Dynatrace entity.

description string

A short description of the 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.

The request consumes an application/json payload.

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

Response codes

Code 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 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