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

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

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.

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.

Virtual Machine

NameDescription
CPU Credits ConsumedTotal number of credits consumed by the Virtual Machine.
CPU Credits RemainingTotal 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.
IDThe Azure Resource ID.
Instance IDThe virtual machine instance ID.
Latest Model AppliedSpecifies whether the latest model has been applied to the virtual machine.
LocationThe resource location.
NameThe 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 DepthOS 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 UsernameSpecifies the name of the administrator account.
OS Profile Computer NameSpecifies the host OS name of the virtual machine.
Per Disk Queue DepthData 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 StateThe provisioning state, which only appears in the response.
SKU NameThe SKU name.
SKU TierSpecifies the tier of virtual machines in a scale set. Possible values are: Standard, Basic.
VM IDThe Azure VM unique ID.

Virtual Machine Scale Set

NameDescription
CPU Credits ConsumedTotal number of credits consumed by the Virtual Machine.
CPU Credits RemainingTotal 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.
IDThe Azure Resource ID.
LocationSpecifies the supported Azure location where the cluster should be created.
NameSpecifies 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 DepthOS 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 ProvisionedSpecifies whether the scale set is over-provisioned.
Per Disk Queue DepthData 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 StateThe provisioning state.
Resource GroupThe Resource Group of the Azure resource.
Single Placement GroupWhen true this limits the scale set to a single placement group, of max size 100 virtual machines.
SKU CapacitySpecifies the number of virtual machines in the scale set.
SKU NameThe SKU Name.
SKU TierSpecifies the tier of virtual machines in a scale set. Possible values are: Standard, Basic.
Unique IDSpecifies the unique id for this virtual machine scale set.
Upgrade Policy ModeSpecifies 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).

Updated 8 months ago

Microsoft Azure Virtual Machine Scale Sets


Suggested Edits are limited on API Reference Pages

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