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 Resource Management

📘

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 ResourceGroup",
  "Description": "LPU for ResourceGroups",
  "Actions": [
    "Microsoft.Resources/*/read",
    "Microsoft.Resources/subscriptions/resourceGroups/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.

Feature

NameDescription
IDThe Resource ID of the feature
NameThe name of the feature
StateThe registration state of the feature for the subscription
TypeMicrosoft Azure resource type

Resource

NameDescription
IDResource ID
IdentityThe identity of the resource
KindThe kind of the resource
LocationResource location
Managed ByID of the resource that manages this resource
NameResource name
PlanThe plan of the resource
SKU CapacityThe SKU capacity associated with the resource
SKU FamilyThe SKU family associated with the resource
SKU ModelThe SKU model associated with the resource
SKU NameThe SKU name associated with the resource
SKU SizeThe SKU size associated with the resource
SKU TierThe SKU tier associated with the resource
TagsMicrosoft Azure resource tags
TypeMicrosoft Azure resource type

Resource Group

NameDescription
IDThe ID of the resource group
LocationThe location of the resource group
Managed ByID of the resource that manages this resource
NameThe name of the resource group
Provisioning StateThe provisioning state of the resource group
TagsMicrosoft Azure resource tags

Tag

NameDescription
Count TypeThe type of count
Count ValueThe total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0
IDID of the tag
Tag NameName of the tag

Updated 8 months ago

Microsoft Azure Resource Management


Suggested Edits are limited on API Reference Pages

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