Azure credentials API - DELETE credentials
Deletes the specified Azure credentials configuration. You can't undo a deletion.
DELETE |
|
Authentication
To execute this request, you need the 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 | required |
Response
Response codes
Code | Description |
---|---|
200 | Success |
Response body
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 |
appId | string | The Application ID (also referred to as Client ID) |
directoryId | string | The Directory ID (also referred to as Tenant ID) |
key | string | The secret key associated with the Application ID. For security reasons, GET requests return this field as 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 ( If not set on creation, the If the field is omitted during an update, the old value remains unaffected. |
autoTagging | boolean | The automatic capture of Azure tags is on ( |
monitorOnlyTaggedEntities | boolean | Monitor only resources that have specified Azure tags ( |
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 |
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 |
The ConfigurationMetadata object
Metadata useful for debugging
Element | Type | Description |
---|---|---|
configurationVersions | integer[] | A Sorted list of the version numbers of the configuration. |
currentConfigurationVersions | string[] | A Sorted list of string version numbers of the configuration. |
clusterVersion | string | Dynatrace server version. |
{
"metadata": {
"configurationVersions": [
"integer"
],
"currentConfigurationVersions": [
"string"
],
"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
curl -X DELETE \
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 code
204