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

Least Privileged User

Use the Azure CLI client to find the subscription ID and Tenant ID from your account list. Then create a custom RBAC role using the JSON provided by adding your subscription ID and renaming to azure.json. Finally, create an Active Directory Service Principal and assign the role to 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 EventHub",
  "Description": "LPU for EventHub",
  "Actions": [
    "Microsoft.EventHub/*/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.

Authorization Rule

Name
Description

ID

Resource ID of the rule

Name

Resource Name of the rule

Rights

The rights associated with the rule

Type

Microsoft Azure resource type

Event Hub

Name
Description

Capture Backlog

Capture Backlog for Microsoft.EventHub.

Capture Destination

Name for capture destination

Capture Enabled

A value that indicates whether capture description is enabled

Capture Encoding

The encoding format of capture description

Capture Interval (Seconds)

The time window allows you to set the frequency with which the capture to Azure Blobs will happen

Capture Size Limit (Bytes)

The size window defines the amount of data built up in your Event Hub before an capture operation

Captured Data (Bytes)

Captured data for Microsoft.EventHub.

Captured Messages

Captured Messages for Microsoft.EventHub.

Connections Closed

Connections Closed for Microsoft.EventHub.

Connections Opened

Connections Opened for Microsoft.EventHub.

Created At

The exact time the Event Hub was created

ID

Resource ID of the Event Hub.

Incoming Data (Bytes)

Incoming data for Microsoft.EventHub.

Incoming Messages

Incoming Messages for Microsoft.EventHub.

Incoming Requests (Requests)

Incoming Requests for Microsoft.EventHub.

Message Retention

Number of days to retain the events for this Event Hub

Name

Resource name of the Event Hub

Outgoing Data (Bytes)

Outgoing data for Microsoft.EventHub.

Outgoing Messages

Outgoing Messages for Microsoft.EventHub.

Partition Count

Number of partitions created for the Event Hub

Partition IDs

A current list of shards on the Event Hub

Quota Exceeded Errors

Quota Exceeded Errors for Microsoft.EventHub.

Server Errors

Server Errors for Microsoft.EventHub.

Size (Bytes)

Size of an EventHub.

Status

The current status of the Event Hub

Successful Requests (Requests)

Successful Requests for Microsoft.EventHub.

Throttled Requests (Requests)

Throttled Requests for Microsoft.EventHub.

Type

Microsoft Azure resource type

Updated At

The exact time the message was updated

User Errors

User Errors for Microsoft.EventHub.

Namespace

Name
Description

Active Connections

Total Active Connections for Microsoft.EventHub.

Archived Messages

Event Hub archived messages in a namespace

Archived Messages Throughput (Bytes)

Event Hub archived message throughput in a namespace

Backlog Archived Messages

Event Hub archive messages in backlog for a namespace

Capture Backlog

Capture Backlog for Microsoft.EventHub.

Captured Data (Bytes)

Captured data for Microsoft.EventHub.

Captured Messages

Captured Messages for Microsoft.EventHub.

Connections Closed

Connections Closed for Microsoft.EventHub.

Connections Opened

Connections Opened for Microsoft.EventHub.

Created At

The time the Namespace was created

Event Hub Incoming Messages

Incoming Messages for Microsoft.EventHub.

Event Hub Incoming Requests (Requests)

Incoming Requests for Microsoft.EventHub.

Event Hub Outgoing Messages

Outgoing Messages for Microsoft.EventHub.

Event Hub Successful Requests (Requests)

Successful Requests for Microsoft.EventHub.

Failed Requests (Requests)

Total failed requests for a namespace

ID

Event hub namespace ID

Incoming Data (Bytes)

Incoming data for Microsoft.EventHub.

Incoming Messages

Total incoming messages for a namespace

Incoming Requests (Requests)

Total incoming send requests for a namespace

Internal Server Errors

Total internal server errors for a namespace

Is Auto Inflate Enabled

Value that indicates whether AutoInflate is enabled for event hub namespace

Location

Location of the namespace

Maximum Throughput Units

Upper limit of throughput units when AutoInflate is enabled

Metric ID

Identifier for Azure Insights metrics

Miscellaneous Server Errors

Miscellaneous server errors for a namespace

Name

Name of the event hub namespace

Outgoing Data (Bytes)

Outgoing data for Microsoft.EventHub.

Outgoing Message Throughput (Bytes)

Event Hub outgoing message throughput for a namespace

Outgoing Messages

Total outgoing messages for a namespace

Provisioning State

Provisioning state of the namespace

Quota Exceeded Errors

Quota Exceeded Errors for Microsoft.EventHub.

Resource Group

The Resource Group of the Azure resource.

Server Busy Errors

Total server busy errors for a namespace

Server Errors

Server Errors for Microsoft.EventHub.

Service Bus Endpoint

Endpoint you can use to perform Service Bus operations

Size (Bytes)

Size of an EventHub.

SKU Capacity

The Event Hubs throughput units

SKU Name

Name of the SKU

SKU Tier

The billing tier of this particular SKU

Status

Status of the namespace

Successful Requests (Requests)

Total successful requests for a namespace

Tags

Microsoft Azure resource tags

Throttled Requests (Requests)

Throttled Requests for Microsoft.EventHub.

Type

Microsoft Azure resource type

Updated At

The time the Namespace was updated

User Errors

User Errors for Microsoft.EventHub.