Azure credentials API - DELETE credentials

Deletes the specified Azure credentials configuration. You can't undo a deletion.

DELETE	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}`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/azure/credentials/{id}`

Authentication

To execute this request, you need Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
id	string	The ID of the required Azure credentials configuration.	path	optional

Response

Response codes

Code	Type	Description
200	AzureCredentials	Success

Response body objects

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 field is required when creating a new credentials configuration. The field is ignored during an update, the old value remains unaffected.	optional
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.	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.	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
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.	optional

The `ConfigurationMetadata` object

Metadata useful for debugging

Element	Type	Description	Required
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
clusterVersion	string	Dynatrace version.	optional

The `CloudTag` object

A cloud tag.

Element Type Description Required

name

string

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 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 `AzureSupportingService` object

A supporting service to be monitored.

Element	Type	Description	Required
name	string	The name of the supporting service.	required
monitoredMetrics	AzureMonitoredMetric[]	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

The `AzureMonitoredMetric` object

A metric of supporting service to be monitored.

Element	Type	Description	Required
name	string	The name of the metric of the supporting service.	required
dimensions	string[]	A list of metric's dimensions names. It must include all the recommended dimensions.	required

Response body JSON model

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

Example

In this example, the request deletes Azure app-level credentials from the POST request example. The response code of 204 indicates that the deletion was successful.

The API token is passed in the Authorization header.

Curl

bash
curl -X DELETE \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/azure/credentials/AZURE_CREDENTIALS-357FDA338DAAF338 \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

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

Response code

204