Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

Microsoft Azure Traffic Manager

📘

Not Included in the BindPlane with Google Stackdriver offering

All of the Google Cloud Platform sources listed within this documentation are not included with the BindPlane with Google Stackdriver offering.

Please refer to the Microsoft Azure Sources topic for additional information on how to configure the LPU, and general Azure Data Collection setup details.

Least Privileged User

Steps:

  1. Using the Azure CLI Client, find the Subscription ID and Tenant ID from your account list
  2. Create a custom RBAC role using the JSON provided. Include your Subscription ID and rename the file to azure.json
  3. Create an Active Directory Service Principal and assign the custom RBAC role t it.

Creating custom roles using the Azure CLI:

https://docs.microsoft.com/en-us/azure/role-based-access-control/custom-roles

Assigning roles using the Azure CLI:

https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal

{
  "Name": "LPU Traffic Manager",
  "Description": "LPU for Traffic Manager",
  "Actions": [
    "Microsoft.Network/trafficmanagerprofiles/*/read",
    "Microsoft.Insights/metrics/*/read",
    "Microsoft.Authorization/*/read"
  ],
  "AssignableScopes": [
    "/subscriptions/[Subscription ID]"
  ]
}

Connection Parameters


NameRequired?Description
Subscription IDRequiredGUID Subscription ID
Tenant IDRequiredGUID Tenant ID (also known as Directory ID)
Client IDRequiredGUID Client ID (also known as Application ID)
Client SecretRequiredThe Secret (also known as Key) corresponding to the Client ID.
Maximum HTTP Retry Time (seconds)The maximum amount of time in seconds to retry each API request when the API is throttling.
HTTP Request Timeout (seconds)The maximum amount of time in seconds before a single HTTP request will fail.
Monitor Metric Collection LevelSelects which monitor metrics should be collected.
Filter By Resource Group TypeSelects whether to use a whitelist or blacklist when filtering by Resource Groups.
Filter By Resource Group WhitelistA comma separated list of resource groups to explicitly allow. A '*' character is used to represent 'all', and a blank string is used for 'none'.
Filter By Resource Group BlacklistA comma separated list of resource groups to filter out. A '*' character is used to represent 'all', and a blank string is used for 'none'.
Filter By Tags Group TypeSelects whether to use a whitelist or blacklist when filtering by Resource Groups.
Filter By Tags Group WhitelistA comma separated list of tags to explicitly allow. Tags must follow the format <key:value>. Instead of a specific tag, or tag value, a '*' character is used to represent 'all'. A blank entry is treated as 'none'.
Filter By Tags Group BlacklistA comma separated list of tags to filter out. Tags must follow the format <key:value>. Instead of a specific tag, or tag value, a '*' character is used to represent 'all'. A blank entry is treated as 'none'.

Metrics

API Usage

NameDescription
Average PagesThe average amount of pages needed for a paged resource type.
Average Request RetriesThe average number of retry requests per unique requests made.
Average Retry AttemptsThe average number of retry requests made per unique request that was retried.
Average Retry Wait (Milliseconds)The average amount of time retried requests spent waiting.
Client IDThe client ID used to make API calls.
Failed RequestsThe total number of requests that returned a failure response.
Maximum PagesThe most amount of pages needed for a paged resource type.
Maximum RetriesThe highest number of retries made for a single request.
Maximum Retry Wait (Milliseconds)The most amount of time a retried request spent waiting.
Minimum PagesThe least amount of pages needed for a paged resource type.
Minimum Retry Wait (Milliseconds)The least amount of time a retried request spent waiting.
Other Status ResponsesThe total number of successful requests that responded with some other accepted status.
Request TimeoutsThe total number of requests that timed out waiting for a response.
Requests RetriedThe number of unique requests that were retried.
Retry Status ResponsesThe total number of successful requests that responded with the status TOO MANY REQUESTS (429).
Retry TimeoutsThe total number of requests that needed to be retried, but the request retry time exceeded the maximum retry time.
Status OK ResponsesThe total number of successful requests that responded with the status OK (200).
Subscription IDThe subscription ID used to make API calls.
Successful RequestsThe total number of requests that returned a successful response.
Tenant IDThe tenant ID used to make API calls.
Total Monitor RequestsThe total number of requests made to get monitor metrics.
Total Paged RequestsThe total amount of resource types that required paging.
Total RequestsThe total number of requests made during collection.
Total RetriesThe total number of retry requests that were made.
Unique Monitor RequestsThe number of unique requests made to get monitor metrics.
Unique RequestsThe number of requests made with unique endpoints.

Endpoint

NameDescription
Geo-mappingThe list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method.
IDFully qualified resource Id for the resource.
LocationSpecifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.
Monitor StatusThe monitoring status of the endpoint.
NameThe name of the resource.
PriorityThe priority of this endpoint when using the 'Priority' traffic routing method.
Probe Agent StatusReturns 1 if an endpoint's probe status is 'Enabled', 0 otherwise.
Query CountNumber of times a Traffic Manager endpoint was returned in the given time frame.
StatusThe status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method.
TargetThe fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint.
Target Resource IDThe Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.
WeightThe weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000.

Profile

NameDescription
DNS FQDNThe fully-qualified domain name (FQDN) of the Traffic Manager profile.
DNS Relative NameThe relative DNS name provided by this Traffic Manager profile.
DNS TTL (Seconds)The DNS Time-To-Live (TTL).
IDFully qualified resource Id for the resource.
LocationThe Azure Region where the resource lives.
Maximum Returned EndpointsMaximum number of endpoints to be returned for MultiValue routing type.
Monitor Interval (Seconds)The monitor interval for endpoints in this profile.
Monitor PathThe path relative to the endpoint domain name used to probe for endpoint health.
Monitor PortThe TCP port used to probe for endpoint health.
Monitor ProtocolThe protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.
Monitor StatusThe profile-level monitoring status of the Traffic Manager profile.
Monitor Timeout (Seconds)The monitor timeout for endpoints in this profile.
NameThe name of the resource.
Probe Agent StatusReturns 1 if an endpoint's probe status is 'Enabled', 0 otherwise.
Query CountNumber of times a Traffic Manager endpoint was returned in the given time frame.
StatusThe status of the Traffic Manager profile.
TagsMicrosoft Azure resource tags.
Tolerated Failures CountThe number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check.
Traffic Routing MethodThe traffic routing method of the Traffic Manager profile.
Traffic View Enrollment StatusIndicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile.

Updated 8 months ago

Microsoft Azure Traffic Manager


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.