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

For more information on how to use the below LPU and other Azure Data Collection setup. See the Microsoft Azure Sources topic

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 NotificationHubs",
  "Description": "LPU for NotificationHubs",
  "Actions": [
    "Microsoft.NotificationHubs/namespaces/*/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.

Namespace

Name
Description

Created At

The time the namespace was created.

Critical

Whether or not the namespace is set as Critical.

Enabled

Whether or not the namespace is currently enabled.

ID

Resource Identifier.

Kind

Specifies namespace type.

Location

Resource location.

Name

Microsoft Azure resource name.

Namespace Type

Type of namespace. Valid values are Messaging and NotificationHub.

Provisioning State

Provisioning state of the Namespace.

Service Bus Endpoint

Endpoint you can use to perform NotificationHub operations.

SKU Name

Name of the notification hub SKU.

Status

Status of the namespace. It can be any of these values:1 = Created/Active, 2 = Creating, 3 = Suspended, 4 = Deleting.

Type

Microsoft Azure resource type.

Updated At

The time the namespace was last updated.

Notification Hub

Name
Description

APNS Bad Channel Error Count (Errors)

The count of pushes that failed because the token is invalid (APNS status code: 8).

APNS Communication Error Count (Errors)

Notification not delivered because of errors communicating with APNS.

APNS Credentials Error Count (Errors)

The count of pushes that failed because the PNS did not accept the provided credentials or the credentials are blocked.

APNS Expired Channel Error Count (Errors)

The count of token that were invalidated by the APNS feedback channel.

APNS Notification Size Error Count (Errors)

The count of pushes that failed because the payload was too large (APNS status code: 7).

APNS Successful Notifications Count

The count of all successful APNS notifications.

Bad Channel Errors Count (Errors)

The count of pushes that failed because the channel/token/registrationId in the registration was expired or invalid.

Channel Errors Count (Errors)

The count of pushes that failed because the channel was invalid not associated with the correct app throttled or expired.

Delete Operations Count (Operations)

Count of Delete Installation Operations.

Failed Incoming Requests Count

Total incoming failed requests for a notification hub.

GCM Authentication Error Count (Errors)

The count of pushes that failed because the PNS did not accept the provided credentials the credentials are blocked or the SenderId is not correctly configured in the app (GCM result: MismatchedSenderId).

GCM Bad Channel Error Count (Errors)

The count of pushes that failed because the registrationId in the registration was not recognized (GCM result: Invalid Registration).

GCM Communication Error Count (Errors)

Notification not delivered because of errors communicating with GCM.

GCM Credentials Error Count (Errors)

The count of pushes that failed because the PNS did not accept the provided credentials or the credentials are blocked.

GCM Expired Channel Error Count (Errors)

The count of pushes that failed because the registrationId in the registration was expired (GCM result: NotRegistered).

GCM Notification Format Error Count (Errors)

The count of pushes that failed because the payload was not formatted correctly (GCM result: InvalidDataKey or InvalidTtl).

GCM Notification Size Error Count (Errors)

The count of pushes that failed because the payload was too large (GCM result: MessageTooBig).

GCM Successful Notifications Count

The count of all successful GCM notifications.

GCM Throttled Count (Errors)

The count of pushes that failed because GCM throttled this app (GCM status code: 501-599 or result:Unavailable).

GCM Wrong Channel Error Count (Errors)

The count of pushes that failed because the registrationId in the registration is not associated to the current app (GCM result: InvalidPackageName).

Get Operations Count (Operations)

Count ofGet Installation Operations.

ID

Resource Identifier.

Incoming Messages

The count of all successful send API calls.

Incoming Requests Count

Total incoming requests for a notification hub.

Installation Operations Count (Operations)

Count of installation management operations.

Location

Region where resource is deployed.

MPNS Authentication Error Count (Errors)

The count of pushes that failed because the PNS did not accept the provided credentials or the credentials are blocked.

MPNS Bad Channel Error Count (Errors)

The count of pushes that failed because the ChannelURI in the registration was not recognized (MPNS status: 404 not found).

MPNS Channel Disconnected Error Count (Errors)

The count of pushes that failed because the ChannelURI in the registration was disconnected (MPNS status: 412 not found).

MPNS Communication Error Count (Errors)

Notification not delivered because of errors communicating with MPNS.

MPNS Credentials Error Count (Errors)

The count of pushes that failed because the PNS did not accept the provided credentials or the credentials are blocked.

MPNS Dropped Notifications Count (Errors)

The count of pushes that were dropped by MPNS (MPNS response header: X-NotificationStatus: QueueFull or Suppressed).

MPNS Notification Format Error Count (Errors)

The count of pushes that failed because the payload of the notification was too large.

MPNS Successful Notifications Count

The count of all successful MPNS notifications.

MPNS Throttled Count (Errors)

The count of pushes that failed because MPNS is throttling this app (WNS MPNS: 406 Not Acceptable).

Name

Microsoft Azure resource name.

Outgoing Notifications Count

All outgoing notifications of the notification hub.

Patch Operations Count (Operations)

Count of Patch Installation Operations.

Payload Errors Count (Errors)

The count of pushes that failed because the PNS returned a bad payload error.

PNS Errors Count (Errors)

The count of pushes that failed because there was a problem communicating with the PNS.

Registration Create Count (Operations)

The count of all successful registration creations.

Registration Delete Count (Operations)

The count of all successful registration deletions.

Registration Get Count (Operations)

The count of all successful registration queries.

Registration Operations (Operations)

The count of all successful registration operations (creations updates queries and deletions).

Registration Update Count (Operations)

The count of all successful registration updates.

Resource Group

The Resource Group of the Azure resource.

Scheduled Messages Canceled

Count of scheduled push notifications Canceled.

Scheduled Messages Pending

Count of pending scheduled Notifications.

Scheduled Messages Sent

Count od scheduled Push Notifications Sent.

Successful Notifications Count

The count of all successful notifications.

Type

Microsoft Azure resource type.

Upsert Operations Count (Operations)

Count of Upsert Installation Operations.

WNS Authentication Error Count (Errors)

Notification not delivered because of errors communicating with Windows Live invalid credentials or wrong token.

WNS Bad Channel Error Count (Errors)

The count of pushes that failed because the ChannelURI in the registration was not recognized.

WNS Channel Disconnected Error Count (Errors)

The notification was dropped because the ChannelURI in the registration is disconnected.

WNS Channel Throttled Error Count (Errors)

The notification was dropped because the ChannelURI in the registration is throttled.

WNS Communication Error Count (Errors)

Notification not delivered because of errors communicating with WNS.

WNS Credentials Error Count (Errors)

The count of pushes that failed because the PNS did not accept the provided credentials or the credentials are blocked.

WNS Dropped Notifications Count (Errors)

The notification was dropped because the ChannelURI in the registration is dropped (X-WNS-NotificationStatus: dropped but not X-WNS-DeviceConnectionStatus: disconnected).

WNS Expired Channel Error Count (Errors)

The count of pushes that failed because the ChannelURI is expired.

WNS Invalid Token Error Count (Errors)

The token provided to WNS is not valid.

WNS Notification Format Error Count (Errors)

The format of the notification is invalid.

WNS Notification Size Error Count (Errors)

The notification payload is too large.

WNS Successful Notifications Count

The count of all successful WNS notifications.

WNS Throttled Count (Errors)

The count of pushes that failed because WNS is throttling this app.

WNS Unreachable Count (Errors)

Windows Live is not reachable.

WNS Wrong Token Error Count (Errors)

The token provided to WNS is valid but for another application.