Skip to content

Commit

Permalink
Docs - Provide links on how to create Azure AD app & get info (#251)
Browse files Browse the repository at this point in the history
* Provide links on how to create Azure AD app & get info

* Make it less verbose
  • Loading branch information
tomkerkhove authored Dec 13, 2018
1 parent 19084b8 commit 895c1c1
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,14 @@ The behavior of this can be configured with the following environment variables:
- **PROMITOR_SCRAPE_SCHEDULE** - A cron expression that controls the fequency in which all the configured metrics will be scraped from Azure Monitor. If configured is specified, `*/5 * * * *` will be used.

# Authentication with Azure Monitor
Authentication with Azure Monitor is fully integrated with Azure AD where you will need to create an entity, preferably an Azure AD Application, that will be used for integrating with the Azure Monitor API.
Authentication with Azure Monitor is fully integrated with Azure AD. In order to use Promitor, you'll need to [create an Azure AD Application](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#create-an-azure-active-directory-application), that will be used for integrating with the Azure Monitor API.

The following environment variables need to be provided:
- **PROMITOR_AUTH_APPID** - Id of the Azure AD entity to authenticate with
- **PROMITOR_AUTH_APPKEY** - Secret of the Azure AD entity to authenticate with

This information can be found on the newly created AD Application as documented [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#get-application-id-and-authentication-key).

The entity in the Azure AD needs to have `Monitoring Reader` permission on the resource group that will be queried. More information can be found [here](https://docs.microsoft.com/en-us/azure/monitoring-and-diagnostics/monitoring-roles-permissions-security).

# Telemetry
Expand All @@ -35,4 +37,4 @@ It currently supports:
In order to enable this feature, the following environment variables need to be provided:
- **PROMITOR_TELEMETRY_INSTRUMENTATIONKEY** - Defines the instrumentation key to use when sending telemetry to Azure Application Insights

[← back](/)
[← back](/)

0 comments on commit 895c1c1

Please sign in to comment.