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 Virtual Machine Scale Sets

For more information on how to use the below LPU and other Azure Data Collection setup. See the Microsoft Azure Sources topic

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 Microsoft Azure Virtual Machine Scale Sets",
  "Description": "LPU for Microsoft Azure Virtual Machine Scale Sets",
  "Actions": [
    "Microsoft.Compute/virtualMachineScaleSets/*/read",
    "Microsoft.Insights/metrics/*/read",
    "Microsoft.Authorization/*/read"
  ],
  "AssignableScopes": [
    "/subscriptions/[Subscription ID]"
  ]
}

Connection Parameters

Name
Required?
Description

Subscription ID

Required

GUID Subscription ID

Tenant ID

Required

GUID Tenant ID (also known as Directory ID)

Client ID

Required

GUID Client ID (also known as Application ID)

Client Secret

Required

The 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.

Metrics

API Usage

Name
Description

Average Pages

The average amount of pages needed for a paged resource type.

Average Request Retries

The average number of retry requests per unique requests made.

Average Retry Attempts

The 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 ID

The client ID used to make API calls.

Failed Requests

The total number of requests that returned a failure response.

Maximum Pages

The most amount of pages needed for a paged resource type.

Maximum Retries

The highest number of retries made for a single request.

Maximum Retry Wait (Milliseconds)

The most amount of time a retried request spent waiting.

Minimum Pages

The 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 Responses

The total number of successful requests that responded with some other accepted status.

Request Timeouts

The total number of requests that timed out waiting for a response.

Requests Retried

The number of unique requests that were retried.

Retry Status Responses

The total number of successful requests that responded with the status TOO MANY REQUESTS (429).

Retry Timeouts

The total number of requests that needed to be retried, but the request retry time exceeded the maximum retry time.

Status OK Responses

The total number of successful requests that responded with the status OK (200).

Subscription ID

The subscription ID used to make API calls.

Successful Requests

The total number of requests that returned a successful response.

Tenant ID

The tenant ID used to make API calls.

Total Monitor Requests

The total number of requests made to get monitor metrics.

Total Paged Requests

The total amount of resource types that required paging.

Total Requests

The total number of requests made during collection.

Total Retries

The total number of retry requests that were made.

Unique Monitor Requests

The number of unique requests made to get monitor metrics.

Unique Requests

The number of requests made with unique endpoints.

Virtual Machine

Name
Description

CPU Credits Consumed

Total number of credits consumed by the Virtual Machine.

CPU Credits Remaining

Total number of credits available to burst.

CPU Utilization (%)

The ratio of compute units that are currently in use by the Virtual Machine(s) to allocated compute units.

Disk Read (Bytes)

Total amount of data read from disk during monitoring period.

Disk Read Rate (Operations per Second)

The disk read operations rate.

Disk Write (Bytes)

Total amount of data written to disk during monitoring period.

Disk Write Rate (Operations per Second)

The disk write operations rate.

ID

The Azure Resource ID.

Instance ID

The virtual machine instance ID.

Latest Model Applied

Specifies whether the latest model has been applied to the virtual machine.

Location

The resource location.

Name

The resource name.

Network In (Bytes)

The amount of data received on all network interfaces by the Virtual Machine(s) (Incoming Traffic).

Network Out (Bytes)

The amount of data out on all network interfaces by the Virtual Machine(s) (Outgoing Traffic).

OS Per Disk Queue Depth

OS Disk Queue Depth (or Queue Length).

OS Per Disk Read Rate (Operations per Second)

Total read operation rate done while reading from a single disk during monitoring period for OS disk.

OS Per Disk Read Throughput (Bytes per Second)

Total read throughput from a single disk during monitoring period for OS disk.

OS Per Disk Write Rate (Operations per Second)

Total write operation rate done while writing to a single disk during monitoring period for OS disk.

OS Per Disk Write Throughput (Bytes per Second)

Total write throughput to a single disk during monitoring period for OS disk.

OS Profile Admin Username

Specifies the name of the administrator account.

OS Profile Computer Name

Specifies the host OS name of the virtual machine.

Per Disk Queue Depth

Data Disk Queue Depth (or Queue Length).

Per Disk Read Rate (Operations per Second)

Total read operations rate done while reading from a single disk during monitoring period.

Per Disk Read Throughput (Bytes per Second)

Total read throughput from a single disk during monitoring period.

Per Disk Write Rate (Operations per Second)

Total write operations rate done while writing to a single disk during monitoring period.

Per Disk Write Throughput (Bytes per Second)

Total write throughput to a single disk during monitoring period.

Provisioning State

The provisioning state, which only appears in the response.

SKU Name

The SKU name.

SKU Tier

Specifies the tier of virtual machines in a scale set. Possible values are: Standard, Basic.

VM ID

The Azure VM unique ID.

Virtual Machine Scale Set

Name
Description

CPU Credits Consumed

Total number of credits consumed by the Virtual Machine.

CPU Credits Remaining

Total number of credits available to burst.

CPU Utilization (%)

The ratio of compute units that are currently in use by the Virtual Machine(s) to allocated compute units.

Disk Read (Bytes)

Total data read from disk during monitoring period.

Disk Read Rate (Operations per Second)

Disk read operation rate.

Disk Write (Bytes)

Total data written to disk during monitoring period.

Disk Write Rate (Operations per Second)

Disk write operation rate.

ID

The Azure Resource ID.

Location

Specifies the supported Azure location where the cluster should be created.

Name

Specifies the name of the virtual machine scale set.

Network In (Bytes)

The amount of data received on all network interfaces by the Virtual Machine(s) (Incoming Traffic).

Network Out (Bytes)

The amount of data out on all network interfaces by the Virtual Machine(s) (Outgoing Traffic).

OS Per Disk Queue Depth

OS Disk Queue Depth (or Queue Length).

OS Per Disk Read Rate (Operations per Second)

Total read operation rate done while reading from a single disk during monitoring period for OS disk.

OS Per Disk Read Throughput (Bytes per Second)

Total read throughput from a single disk during monitoring period for OS disk.

OS Per Disk Write Rate (Operations per Second)

Total write operation rate done while writing to a single disk during monitoring period for OS disk.

OS Per Disk Write Throughput (Bytes per Second)

Total write throughput to a single disk during monitoring period for OS disk.

Over Provisioned

Specifies whether the scale set is over-provisioned.

Per Disk Queue Depth

Data Disk Queue Depth (or Queue Length).

Per Disk Read Rate (Operations per Second)

Total read operation rate done while reading from a single disk during monitoring period.

Per Disk Read Throughput (Bytes per Second)

Total read throughput from a single disk during monitoring period.

Per Disk Write Rate (Operations per Second)

Total write operation rate done while writing to a single disk during monitoring period.

Per Disk Write Throughput (Bytes per Second)

Total write throughput to a single disk during monitoring period.

Provisioning State

The provisioning state.

Resource Group

The Resource Group of the Azure resource.

Single Placement Group

When true this limits the scale set to a single placement group, of max size 100 virtual machines.

SKU Capacity

Specifies the number of virtual machines in the scale set.

SKU Name

The SKU Name.

SKU Tier

Specifies the tier of virtual machines in a scale set. Possible values are: Standard, Basic.

Unique ID

Specifies the unique id for this virtual machine scale set.

Upgrade Policy Mode

Specifies the mode of an upgrade to virtual machines in the scale set. Possible values are: Manual (You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action), Automatic (All virtual machines in the scale set are automatically updated at the same time).