Configuring Azure Observer jobs
Using the Azure Observer, you can define a full load job that will read data from Azure cloud services through its REST APIs and generate a topology.
Before you begin
Important: The Azure Observer supports the cloud and SaaS Azure version.
Ensure you have the Azure details to hand, such as the Tenant ID, Client ID, and client password before running the observer job.
Tip: To configure access to Azure resources, see the following information: Create an Azure Active Directory application and service principal that can access resources
Enabling access to the URL routes
To access the URL routes for the topology Swagger documentation, see the Enabling access to URL routes topic.
About this task
The Azure Observer retrieves topology data from Azure cloud services through REST APIs exposed by the Azure API server.
In addition to the standard resources, the following resources are now also supported:
- Load Balancers
- Virtual Machine Scale Set
- Virtual Network Gateway (including VPN Gateway and Express Route Gateway)
- ExpressRoute
You define and start the following job.
Full Topology Upload job
By default, Load jobs are one-off, transient jobs that do a full upload of all requested topology data as soon as they are triggered.
You can also run these jobs (again) from the Observer UI, or schedule them to run at set times when configuring them.
Procedure
Define or edit the following parameters, then click Run job to save and run the job.
Encryption requirement: See the Configuring observer jobs security topic for more information.
Parameter | Action | Details |
---|---|---|
Unique ID | Enter a unique name for the job | Required |
Data center | Enter the data center of the Azure service | Required |
Tenant ID | Specify the Azure account tenant ID | Required |
Client ID | Specify the client ID to access the registered app | Required |
Client password | Enter the client password to access the registered app | Required |
Subscriptions to be discovered | Specify the subscription Ids to be discovered in comma-separated lists. To discover all subscriptions, use * |
Optional |
Connection timeout (milliseconds) | Define the Azure connection timeout in milliseconds. The default value is 5000. | Optional |
Read timeout (milliseconds) | Specify the read timeout in milliseconds. The default value is 5000. | Optional |
Proxy Host | Specify the proxy host | Optional |
Proxy Port | Specify the proxy port; defaults to 8080 | Optional |
Proxy Username | Specify the proxy username. | Optional |
Trust all certificates by bypassing certificate verification | Set to true to allow connection to target environment without verification. | Optional. The default is 'false'. |
Proxy Password | Specify the proxy password. | Optional |
Proxy Secure | Specify whether the proxy server is secure. | Optional |
Access scope | Enter text to provide a scope for the resources. Access scope can help map alerts to resources when resources in different scopes share the same parameters, such as matchTokens. | Optional. Tip: You can define access scope for locations, project names, namespaces, etc. |
Generate debug support file | Set this parameter to 'True' in order to capture the output of the next scheduled job run as a file. This file will be stored with an observer's log files and can be used to debug observer issues, for example at the request of your designated support team, or while using a test environment. For one-off jobs (that is, Load jobs), this parameter reverts to 'False' after the next completed run. To examine the output produced, you can load the generated debug file using the File Observer. | Optional |
Observer job description | Enter additional information to describe the job | Optional |
Job schedule | Specify when the job runs | Optional. Load jobs only. |