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 Machines

Azure Hosted Virtual Machines

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 Virtual Machines",
  "Description": "LPU for Virtual Machines",
  "Actions": [
    "Microsoft.Compute/virtualMachines/*/read",
    "Microsoft.Network/publicIPAddresses/*/read",
    "Microsoft.Network/networkInterfaces/*/read",
    "Microsoft.Network/virtualNetworks/*/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.

Monitor Metric Collection Level

Selects which monitor metrics should be collected.

Filter By Resource Group Type

Selects whether to use a whitelist or blacklist when filtering by Resource Groups.

Filter By Resource Group Whitelist

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

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

Selects whether to use a whitelist or blacklist when filtering by Resource Groups.

Filter By Tags Group Whitelist

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

A 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

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

Availability Set ID

The availability set that the virtual machine should be assigned to.

Average CPU Credits Remaining

Total number of credits available to burst.

Average Data Disk Queue Depth

Data Disk Queue Depth (or Queue Length).

Average OS Disk Queue Depth

OS Disk Queue Depth (or Queue Length).

Boot Diagnostics Enabled

Whether boot diagnostics should be enabled on the Virtual Machine.

CPU Credits Consumed (per Minute)

Total number of credits consumed by the Virtual Machine.

CPU Usage (%)

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

Disk Read (Bytes)

Total data read from disk during monitoring period.

Disk Read Operations (Operations per Second)

Disk Read operations rate.

Disk Write (Bytes)

Total data written to disk during monitoring period.

Disk Write Operations (Operations per Second)

Disk write operations rate.

Enable Automatic Windows Updates

Indicates whether virtual machine is enabled for automatic updates.

Fully Qualified Domain Names

List of fully qualified domain names of the Virtual Machine.

ID

Resource ID.

Identity Type

The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.

IP Addresses

List of public IP addresses of the Virtual Machine.

License Type

Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

Linux Password Authentication Disabled

Specifies whether password authentication should be disabled.

Location

Resource location.

Name

Resource name.

Network In (Bytes)

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

Network Interfaces

Specifies the list of resource Ids for the network interfaces associated with the virtual machine.

Network Out (Bytes)

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

OS Admin Username

Specifies the name of the administrator account.

OS Computer Name

Specifies the host O/S name of the virtual machine.

OS Disk Image

The source user image virtual hard disk.

OS Disk Managed Disk ID

ID of the managed disk.

OS Disk Managed Disk Storage Account Type

Specifies the storage account type for the managed disk.

OS Disk Read Data (Bytes per Second)

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

OS Disk Read Operations (Operations per Second)

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

OS Disk Size (Gigabytes)

Specifies the size of an empty data disk.

OS Disk Virtual Hard Disk

Specifies the virtual hard disk's uri.

OS Disk Write Accelerator Enabled

Specifies whether writeAccelerator should be enabled or disabled on the disk.

OS Disk Write Data (Bytes per Second)

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

OS Disk Write Operations (Operations per Second)

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

OS Type

This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

Power State

Power state of the Virtual Machine.

Private IP Addresses

List of private IP addresses of the Virtual Machine.

Provisioning State

The provisioning state, which only appears in the response.

Resource Group

The Resource Group of the Azure resource.

Service Tier

Specifies the size of the virtual machine.

Subnet Prefixes

List of subnet prefixes of the Virtual Machine.

Subnets

List of subnets of the Virtual Machine.

Subscription ID

The Subscription ID that the Azure resource belongs to.

Tags

Microsoft Azure resource tags.

Type

Microsoft Azure resource type.

UID

Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.

Windows Provision VM Agent Enabled

Indicates whether virtual machine agent should be provisioned on the virtual machine.

Windows Time Zone

Specifies the time zone of the virtual machine.

Zones

The virtual machine zones.

Microsoft Azure Virtual Machines


Azure Hosted Virtual Machines

Suggested Edits are limited on API Reference Pages

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