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 Storage

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 Storage",
  "Description": "LPU for Storage (both classic and standard)",
  "Actions": [
    "Microsoft.ClassicStorage/*/read",
    "Microsoft.Storage/*/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.

Blob Service

Name
Description

Availability (%)

The availability for the storage service or the specified API operation. Availability is calculated by taking the TotalBillableRequests value and dividing it by the number of applicable requests, including those that produced unexpected errors. All unexpected errors result in reduced availability for the storage service or the specified API operation.

Blob Capacity (Bytes)

The amount of storage used by the storage account?s Blob service.

Blob Container Count

The number of containers in the storage account?s Blob service.

Blob Count

The number of Blobs in the storage account?s Blob service.

Block Blob Capacity (Bytes)

The amount of Block storage used by the storage account?s Blob service.

Block Blob Count

The number of Block Blobs in the storage account?s Blob service.

Egress (Bytes)

The amount of egress data. This number includes egress from an external client into Azure Storage as well as egress within Azure. As a result, this number does not reflect billable egress.

ID

The ID of the blob service account

Ingress (Bytes)

The amount of ingress data. This number includes ingress from an external client into Azure Storage as well as ingress within Azure.

Page Blob Capacity (Bytes)

The amount of Page storage used by the storage account?s Blob service.

Page Blob Count

The number of Page Blobs in the storage account?s Blob service.

Success E2E Latency (Milliseconds)

The average end-to-end latency of successful requests made to a storage service or the specified API operation. This value includes the required processing time within Azure Storage to read the request, send the response, and receive acknowledgment of the response.

Success Server Latency (Milliseconds)

The average latency used by Azure Storage to process a successful request. This value does not include the network latency specified in AverageE2ELatency.

Transactions (Transactions)

The number of requests made to a storage service or the specified API operation. This number includes successful and failed requests, as well as requests which produced errors

Cluster

Name
Description

Availability (%)

The amount of availability for the storage service or the specified API operation. Availability is calculated by taking the TotalBillableRequests value and dividing it by the number of applicable requests, including those that produced unexpected errors. All unexpected errors result in reduced availability for the storage service or the specified API operation.

Egress (Bytes)

The amount of egress data. This number includes egress from an external client into Azure Storage as well as egress within Azure. As a result, this number does not reflect billable egress.

Geo Type

Primary or Secondary cluster. When secondary, the cluster is a Read Access Geo Redundant Storage (RA-GRS).

Ingress (Bytes)

The amount of ingress data. This number includes ingress from an external client into Azure Storage as well as ingress within Azure.

Parent ID

The ID of the parent storage account

Success E2E Latency (Milliseconds)

The average end-to-end latency of successful requests made to a storage service or the specified API operation. This value includes the required processing time within Azure Storage to read the request, send the response, and receive acknowledgment of the response.

Success Server Latency (Milliseconds)

The average latency used by Azure Storage to process a successful request. This value does not include the network latency specified in AverageE2ELatency.

Transactions (Requests)

The number of requests made to a storage service. This number includes successful and failed requests, as well as requests which produced errors.

Transactions Authorization Error (Requests)

The number of requests made to a storage service that failed due to unauthorized access of data or an authorization failure.

Transactions Client Other Error (Requests)

The number of requests made to a storage service that failed due to an unspecified client error.

Transactions Client Throttling Error (Requests)

The number of requests made to a storage service that failed due to a client-side throttling error.

Transactions Client Timeout Error (Requests)

The number of requests made to a storage service that failed due to a client timeout error (status code 500). If the client?s network timeout or the request timeout is set to a lower value than expected by the storage service, it is an expected timeout.

Transactions Network Error (Requests)

The number of requests made to a storage service that failed due to network errors. This most commonly occurs when a client prematurely closes a connection before timeout expiration.

Transactions Server Busy Error (Requests)

The number of requests made to a storage service that resulted in busy server error (status code 503).

Transactions Server Other Error (Requests)

The number of requests made to a storage service that resulted in an unspecified server error.

Transactions Server Timeout Error (Requests)

The number of requests made to a storage service that resulted in a server timeout error (status code 500). The timeout obscured due to a server error.

Transactions Succeeded (Requests)

The number of requests made to a storage service that succeeded.

File Service

Name
Description

Availability (%)

The availability for the storage service or the specified API operation. Availability is calculated by taking the TotalBillableRequests value and dividing it by the number of applicable requests, including those that produced unexpected errors. All unexpected errors result in reduced availability for the storage service or the specified API operation.

Egress (Bytes)

The amount of egress data. This number includes egress from an external client into Azure Storage as well as egress within Azure. As a result, this number does not reflect billable egress.

File Capacity (Bytes)

The amount of storage used by the storage account?s File service.

File Count

The number of files in the storage account?s File service.

File Share Count

The number of file shares in the storage account?s File service.

ID

The ID of the file service account

Ingress (Bytes)

The amount of ingress data. This number includes ingress from an external client into Azure Storage as well as ingress within Azure.

Success E2E Latency (Milliseconds)

The average end-to-end latency of successful requests made to a storage service or the specified API operation. This value includes the required processing time within Azure Storage to read the request, send the response, and receive acknowledgment of the response.

Success Server Latency (Milliseconds)

The average latency used by Azure Storage to process a successful request. This value does not include the network latency specified in AverageE2ELatency.

Transactions (Transactions)

The number of requests made to a storage service or the specified API operation. This number includes successful and failed requests, as well as requests which produced errors

Queue Service

Name
Description

Availability (%)

The availability for the storage service or the specified API operation. Availability is calculated by taking the TotalBillableRequests value and dividing it by the number of applicable requests, including those that produced unexpected errors. All unexpected errors result in reduced availability for the storage service or the specified API operation.

Egress (Bytes)

The amount of egress data. This number includes egress from an external client into Azure Storage as well as egress within Azure. As a result, this number does not reflect billable egress.

ID

The ID of the queue service account

Ingress (Bytes)

The amount of ingress data. This number includes ingress from an external client into Azure Storage as well as ingress within Azure.

Queue Capacity (Bytes)

The amount of storage used by the storage account?s Queue service.

Queue Count

The number of queues in the storage account?s Queue service.

Queue Message Count

The approximate number of queue messages in the storage account?s Queue service.

Success E2E Latency (Milliseconds)

The average end-to-end latency of successful requests made to a storage service or the specified API operation. This value includes the required processing time within Azure Storage to read the request, send the response, and receive acknowledgment of the response.

Success Server Latency (Milliseconds)

The average latency used by Azure Storage to process a successful request. This value does not include the network latency specified in AverageE2ELatency.

Transactions (Transactions)

The number of requests made to a storage service or the specified API operation. This number includes successful and failed requests, as well as requests which produced errors

Storage Account

Name
Description

Availability (%)

The amount of availability for the storage service or the specified API operation. Availability is calculated by taking the TotalBillableRequests value and dividing it by the number of applicable requests, including those that produced unexpected errors. All unexpected errors result in reduced availability for the storage service or the specified API operation.

Creation Time

Gets the creation date and time of the storage account

Egress (Bytes)

The amount of egress data. This number includes egress from an external client into Azure Storage as well as egress within Azure. As a result, this number does not reflect billable egress.

ID

The ID of the storage account

Ingress (Bytes)

The amount of ingress data. This number includes ingress from an external client into Azure Storage as well as ingress within Azure.

Kind

Indicates the type of storage account

Location

The location of the storage account

Name

The name of the storage account

Primary Endpoints

Gets the URLs that are used to perform a retrieval of a public blob, queue, or table objects

Primary Location

Gets the location of the primary data center for the storage account

Provisioning State

The status of the storage account at the time the operation was called

Resource Group

The Resource Group of the Azure resource.

Secondary Endpoints

Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object from the secondary location of the storage account

Secondary Location

Gets the location of the secondary data center for the storage account

SKU Name

The SKU name associated with the storage account

SKU Tier

The the tier of the SKU associated with the storage account

Status Of Primary

Gets the status indicating whether the primary location of the storage account is available or unavailable

Status Of Secondary

Gets the status indicating whether the secondary location of the storage account is available or unavailable

Success E2E Latency (Milliseconds)

The average end-to-end latency of successful requests made to a storage service or the specified API operation. This value includes the required processing time within Azure Storage to read the request, send the response, and receive acknowledgment of the response.

Success Server Latency (Milliseconds)

The average latency used by Azure Storage to process a successful request. This value does not include the network latency specified in AverageE2ELatency.

Supports HTTPS Traffic Only

Whether the storage account allows https traffic only to the storage service

Tags

Microsoft Azure resource tags

Transactions (Requests)

The number of requests made to a storage service. This number includes successful and failed requests, as well as requests which produced errors.

Transactions Authorization Error (Requests)

The number of requests made to a storage service that failed due to unauthorized access of data or an authorization failure.

Transactions Client Other Error (Requests)

The number of requests made to a storage service that failed due to an unspecified client error.

Transactions Client Throttling Error (Requests)

The number of requests made to a storage service that failed due to a client-side throttling error.

Transactions Client Timeout Error (Requests)

The number of requests made to a storage service that failed due to a client timeout error (status code 500). If the client?s network timeout or the request timeout is set to a lower value than expected by the storage service, it is an expected timeout.

Transactions Network Error (Requests)

The number of requests made to a storage service that failed due to network errors. This most commonly occurs when a client prematurely closes a connection before timeout expiration.

Transactions Server Busy Error (Requests)

The number of requests made to a storage service that resulted in busy server error (status code 503).

Transactions Server Other Error (Requests)

The number of requests made to a storage service that resulted in an unspecified server error.

Transactions Server Timeout Error (Requests)

The number of requests made to a storage service that resulted in a server timeout error (status code 500). The timeout obscured due to a server error.

Transactions Succeeded (Requests)

The number of requests made to a storage service that succeeded.

Trusted Directories

A list of trusted directories belonging to the storage account

Type

Microsoft Azure resource type

Used Capacity (Bytes)

Account used capacity

Table Service

Name
Description

Availability (%)

The availability for the storage service or the specified API operation. Availability is calculated by taking the TotalBillableRequests value and dividing it by the number of applicable requests, including those that produced unexpected errors. All unexpected errors result in reduced availability for the storage service or the specified API operation.

Egress (Bytes)

The amount of egress data. This number includes egress from an external client into Azure Storage as well as egress within Azure. As a result, this number does not reflect billable egress.

ID

The ID of the table service account

Ingress (Bytes)

The amount of ingress data. This number includes ingress from an external client into Azure Storage as well as ingress within Azure.

Success E2E Latency (Milliseconds)

The average end-to-end latency of successful requests made to a storage service or the specified API operation. This value includes the required processing time within Azure Storage to read the request, send the response, and receive acknowledgment of the response.

Success Server Latency (Milliseconds)

The average latency used by Azure Storage to process a successful request. This value does not include the network latency specified in AverageE2ELatency.

Table Capacity (Bytes)

The amount of storage used by the storage account?s Table service.

Table Count

The number of tables in the storage account?s Table service.

Table Entity Count

The number of table entities in the storage account?s Table service.

Transactions (Transactions)

The number of requests made to a storage service or the specified API operation. This number includes successful and failed requests, as well as requests which produced errors