Azure credentials API - DELETE credentials
Deletes the specified Azure credentials configuration. You can't undo a deletion.
| DELETE | ManagedDynatrace for Government | 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 an access token with WriteConfig scope.
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 | Type | Description |
|---|---|---|
| 200 | Azure | Success |
Response body objects
The AzureCredentials object
Configuration of Azure app-level credentials.
| Element | Type | Description |
|---|---|---|
| metadata | Configuration | Metadata useful for debugging |
| 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). The field is required when creating a new credentials configuration. The field is ignored during an update, the old value remains unaffected. |
| 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. |
| 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. The field is required when creating a new credentials 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 | Cloud | 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 |
| monitorOnlyExcludingTagPairs | Cloud | 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 |
| supportingServices | Azure | 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. |
The ConfigurationMetadata object
Metadata useful for debugging
| Element | Type | Description |
|---|---|---|
| currentConfigurationVersions | string[] | A sorted list of version numbers of the configuration. |
| configurationVersions | integer[] | A sorted list of the version numbers of the configuration. |
| clusterVersion | string | Dynatrace version. |
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 AzureSupportingService object
A service to be monitored.
| Element | Type | Description |
|---|---|---|
| name | string | The name of the service. Valid supported service names can be discovered using /azure/supportedServices restAPI |
| monitoredMetrics | Azure | 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. |
The AzureMonitoredMetric object
A metric of service to be monitored.
| Element | Type | Description |
|---|---|---|
| name | string | The name of the metric of the service. |
| dimensions | string[] | A list of metric's dimensions names. It must include all the recommended dimensions. |
Response body JSON model
{
"metadata": {
"currentConfigurationVersions": [
"1.0.4",
"1.23"
],
"configurationVersions": [
4,
2
],
"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"
}
],
"monitorOnlyExcludingTagPairs": [
{}
],
"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 dt0c01.abc123.abcdefjhij1234567890'Request URL
https://mySampleEnv.live.dynatrace.com/api/config/v1/azure/credentials/AZURE_CREDENTIALS-357FDA338DAAF338Response code
204