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

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

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.

Blob Service

NameDescription
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 CountThe number of containers in the storage account?s Blob service.
Blob CountThe 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 CountThe 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.
IDThe 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 CountThe 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

NameDescription
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 TypePrimary 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 IDThe 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

NameDescription
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 CountThe number of files in the storage account?s File service.
File Share CountThe number of file shares in the storage account?s File service.
IDThe 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

NameDescription
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.
IDThe 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 CountThe number of queues in the storage account?s Queue service.
Queue Message CountThe 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

NameDescription
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 TimeGets 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.
IDThe 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.
KindIndicates the type of storage account
LocationThe location of the storage account
NameThe name of the storage account
Primary EndpointsGets the URLs that are used to perform a retrieval of a public blob, queue, or table objects
Primary LocationGets the location of the primary data center for the storage account
Provisioning StateThe status of the storage account at the time the operation was called
Resource GroupThe Resource Group of the Azure resource.
Secondary EndpointsGets 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 LocationGets the location of the secondary data center for the storage account
SKU NameThe SKU name associated with the storage account
SKU TierThe the tier of the SKU associated with the storage account
Status Of PrimaryGets the status indicating whether the primary location of the storage account is available or unavailable
Status Of SecondaryGets 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 OnlyWhether the storage account allows https traffic only to the storage service
TagsMicrosoft 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 DirectoriesA list of trusted directories belonging to the storage account
TypeMicrosoft Azure resource type
Used Capacity (Bytes)Account used capacity

Table Service

NameDescription
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.
IDThe 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 CountThe number of tables in the storage account?s Table service.
Table Entity CountThe 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

Updated 8 months ago

Microsoft Azure Storage


Suggested Edits are limited on API Reference Pages

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