Azure credentials API - PUT credentials
Updates an existing Azure credentials configuration. Check the connection status for these credentials after 10 minutes with the GET credentials request.
If a credentials configuration with the specified ID doesn’t exist, a new configuration is created.
The request consumes and produces an application/json payload.
| PUT | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/azure/credentials/{id} |
| Environment ActiveGate | https://{your-activegate-domain}:9999/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
The ID of the Azure credentials configuration to be updated.
The JSON body of the request. Contains updated parameters of the Azure credentials configuration.
Request body objects
The AzureCredentials object
Configuration of Azure app-level credentials.
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.
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.
The automatic capture of Azure tags is on (true) or off (false).
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.
The Dynatrace entity ID of the Azure credentials configuration.
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.
The unique name of the Azure credentials configuration.
Allowed characters are letters, numbers, and spaces. Also the special characters .+-_ are allowed.
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.
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.
Monitor only resources that have specified Azure tags (true) or all resources (false).
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
Dynatrace version.
A sorted list of the version numbers of the configuration.
A sorted list of version numbers of the configuration.
The CloudTag object
A cloud tag.
The name of the tag.
The value of the tag.
If set to null or "", then resources with any value of the tag are monitored.
The AzureSupportingService object
A service to be monitored.
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 name of the service. Valid supported service names can be discovered using /azure/supportedServices restAPI
The AzureMonitoredMetric object
A metric of service to be monitored.
A list of metric's dimensions names. It must include all the recommended dimensions.
The name of the metric of the service.
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
Success. The new Azure credentials configuration has been created. The response body contains the ID of the configuration.
Success. The Azure credentials configuration has been updated. Response doesn't have a body.
Response body objects
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
A short description of the Dynatrace entity.
The ID of the Dynatrace entity.
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.
| POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/azure/credentials/{id}/validator |
| Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/azure/credentials/{id}/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
Validated. The submitted configuration is valid. The response doesn't have a body.
Example
In this example, the request updates the Azure credentials configuration from the POST request example.
It provides a new password and changes monitoring mode from resources with specified tags to all resources:
- monitorOnlyTaggedEntities value has been changed to
false - monitorOnlyTagPairs array is empty.
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 PUT \https://mySampleEnv.live.dynatrace.com/api/config/v1/azure/credentials/AZURE_CREDENTIALS-357FDA338DAAF338 \-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/AZURE_CREDENTIALS-357FDA338DAAF338
Request body
{"id": "AZURE_CREDENTIALS-357FDA338DAAF338","label": "Booking application","appId": "c4431dec-34fe-4d4c-ad93-aea38b4f944e","directoryId": "f836b63d-8c92-4ad8-a314-bb1eeka46aa1","key": "p459-346vs;ojkg[]","active": true,"autoTagging": true,"monitorOnlyTaggedEntities": false,"monitorOnlyTagPairs": []}
Response code
204