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

Azure Web Application Hosting Service

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 App",
  "Description": "LPU for Application, Covers Functions and Sites",
  "Actions": [
    "Microsoft.Web/*/read",
    "Microsoft.Insights/metrics/*/read",
    "Microsoft.Authorization/*/read"
  ],
  "AssignableScopes": [
    "/subscriptions/09373b6b-bc8b-4093-925d-eb87334c7d56"
  ]
}

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.
Monitor Metric Collection LevelSelects which monitor metrics should be collected.
Filter By Resource Group TypeSelects whether to use a whitelist or blacklist when filtering by Resource Groups.
Filter By Resource Group WhitelistA 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 BlacklistA 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 TypeSelects whether to use a whitelist or blacklist when filtering by Resource Groups.
Filter By Tags Group WhitelistA 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 BlacklistA 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

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.

Configuration

NameDescription
Always OnTrue if Always On is enabled; otherwise, false
API DefinitionThe URL of the API definition
App Command LineApp command line to launch
Auto Heal EnabledTrue if Auto Heal is enabled; otherwise, false
Auto Swap SlotAuto-swap slot name
Connection StringsConnection strings
CORSThe list of origins that should be allowed to make cross-origin calls
Default DocumentsDefault documents
Detailed Error Logging EnabledTrue if detailed error logging is enabled; otherwise, false
Document RootDocument root
Handler Mapping ArgumentsCommand-line arguments to be passed to the script processor
Handler Mapping ExtensionsRequests with this extension will be handled using the specified FastCGI application
Handler Mapping Script ProcessorsThe absolute path to the FastCGI application
HTTP20 EnabledConfigures a web site to allow clients to connect over http2.0
HTTP Logging EnabledTrue if HTTP logging is enabled; otherwise, false
IDResource ID of the configuration
IP Security Restriction IP AddressesIP addresses the security restriction is valid for
IP Security Restriction Subnet MasksSubnet mask for the range of IP addresses the restriction is valid for
Java ContainerJava container
Java Container VersionJava container version
Java VersionJava version
Linux FX VersionLinux App Framework and version
Load BalancingSite load balancing strategy
Local MySQL EnabledTrue to enable local MySQL; otherwise, false
Logs Directory Size LimitHTTP logs directory size limit
Machine KeySite MachineKey
Managed Pipeline ModeManaged pipeline mode
Maximum CPU Usage (%)Maximum allowed CPU usage
Maximum Disk Size (Megabytes)Maximum allowed disk size usage
Maximum Memory (Megabytes)Maximum allowed memory usage
Minimum TLS VersionThe minimum version of TLS required for SSL requests
NameResource name of the configuration
.NET Framework Version.NET Framework version
Node VersionVersion of Node.js
Number Of WorkersNumber of workers
PHP VersionVersion of PHP
Publishing UsernamePublishing user name
Python VersionVersion of Python
Remote Debugging EnabledTrue if remote debugging is enabled; otherwise, false
Remote Debugging VersionRemote debugging version
Request Tracing EnabledTrue if request tracing is enabled; otherwise, false
Request Tracing Expiration TimeRequest tracing expiration time
SCM TypeSCM type
Tracing OptionsTracing options
TypeMicrosoft Azure resource type
Use 32-Bit Worker ProcessTrue to use 32-bit worker process; otherwise, false
VNet NameVirtual Network name
Web Sockets EnabledTrue if WebSocket is enabled; otherwise, false

Function

NameDescription
App IDFunction App ID
Configuration HREFConfiguration URI
FilesList of files
HREFThe Function URI
IDResource ID of the function
LocationResource location of the function
NameResource name of the function
Script HREFScript URI
Script Root Path HREFScript root path URI
Secrets File HREFSecrets file URI
TypeMicrosoft Azure resource type

Site

NameDescription
Admin EnabledWhether or not the admin user is enabled
App Connections (Connections)Connections
Availability StateManagement information availability state for the app
Average Memory Working Set (Bytes)Average memory working set
Average Response Time (Seconds)Average Response Time
CertificatesThe certificates associated with the web app
Client Affinity EnabledTrue to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance
Client Cert EnabledTrue to enable client certificate authentication (TLS mutual authentication); otherwise false
Compute ModeThe compute mode for the website
Container SizeSize of the function container
CPU Time (Seconds)CPU Time
CSRsThe certificate signing requests associated with the web app
Daily Memory Time QuotaMaximum allowed daily memory-time quota (applicable on dynamic apps only)
Data Received (Bytes)Data In
Data Sent (Bytes)Data Out
Default Host NameDefault hostname of the app
Deployment IDGets the unique identifier of the deployment in which the web app is running
Disabled ReasonThe reason the site has been disabled
EnabledWhether or not the app is enabled
Enabled Host NamesEnabled hostnames for the app
Function Execution CountFunction Execution Count
Function Execution UnitsFunction Execution Units
Handle CountHandle Count
Host NamesHostnames associated with the app
Host Names DisabledTrue to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.
Hosting EnvironmentThe name of the App Service Environment where the web app was created
Hosting Environment IDResource ID of the App Service Environment
Hosting Environment ProfileApp Service Environment to use for the app
HTTP 101Http 101
HTTP 2xxHttp 2xx
HTTP 3xxHttp 3xx
HTTP 401Http 401
HTTP 403Http 403
HTTP 404Http 404
HTTP 406Http 406
HTTP 4xxHttp 4xx
HTTP 5xxHttp Server Errors
HTTPS OnlyWhether a web site is configured to accept only https requests. Issues redirect for http requests
IDSite ID
KindKind of site
Last Modified TimeLast time the app was modified
LocationSite location
Maximum Number Of WorkersMaximum number of workers. This only applies to Functions container
Memory Working Set (Bytes)Memory working set
ModeA string that represents the website mode
NameSite name
Outbound IP AddressesList of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings
OwnerThe owner of the web app
Possible Outbound IP AddressesList of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants
Repository Site NameName of the repository site
Requests (Requests)Requests
ReservedWhether or not the site is reserved
Resource GroupName of the resource group the app belongs to
Runtime Availability StateThe availability of the website
SCM Site Also StoppedTrue to stop SCM (KUDU) site when the app is stopped; otherwise, false
Self LinkDirect URL to the website endpoint on Windows Azure Web Sites that includes the subscription ID, webspace name, and site name
Server Farm IDResource ID of the associated App Service plan
SKUThe name of the SKU for the web app
SSL CertificatesThe SSL certificates associated with the site
StateCurrent state of the slot
Suspended TillApp suspended till in case memory-time quota is exceeded
TagsTags assigned to the site
Target Swap SlotSpecifies which deployment slot this app will swap into
Thread Count (Threads)Thread Count
Traffic Manager Host NamesAzure Traffic Manager hostnames associated with the web app
TypeResource type
Usage StateState indicating whether the app has exceeded its quota usage
Web SpaceThe name of the webspace in which the website is located

Site Instance

NameDescription
App Connections (Connections)Connections
Average Memory Working Set (Bytes)Average memory working set
Average Response Time (Seconds)Average Response Time
CPU Time (Seconds)CPU Time
Data Received (Bytes)Data In
Data Sent (Bytes)Data Out
Function Execution CountFunction Execution Count
Function Execution UnitsFunction Execution Units
Handle CountHandle Count
HTTP 101Http 101
HTTP 2xxHttp 2xx
HTTP 3xxHttp 3xx
HTTP 401Http 401
HTTP 403Http 403
HTTP 404Http 404
HTTP 406Http 406
HTTP 4xxHttp 4xx
HTTP 5xxHttp Server Errors
InstanceInstance
Memory Working Set (Bytes)Memory working set
Parent IDThe ID of the parent site
Requests (Requests)Requests
Thread Count (Threads)Thread Count

Slot

NameDescription
Admin EnabledWhether or not the admin user is enabled
App Connections (Connections)Connections
Availability StateManagement information availability state for the slot
Average Memory Working Set (Bytes)Average memory working set
Average Response Time (Seconds)Average Response Time
CertificatesThe certificates associated with the web slot
Client Affinity EnabledTrue to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance
Client Cert EnabledTrue to enable client certificate authentication (TLS mutual authentication); otherwise false
Compute ModeThe compute mode for the website
Container SizeSize of the function container
CPU Time (Seconds)CPU Time
CSRsThe certificate signing requests associated with the web slot
Current AssembliesThe number of assemblies currently associated to the slot
Daily Memory Time QuotaMaximum allowed daily memory-time quota (slotlicable on dynamic slots only)
Data Received (Bytes)Data In
Data Sent (Bytes)Data Out
Default Host NameDefault hostname of the slot
Deployment IDGets the unique identifier of the deployment in which the web slot is running
EnabledWhether or not the slot is enabled
Enabled Host NamesEnabled hostnames for the slot
Function Execution CountFunction Execution Count
Function Execution UnitsFunction Execution Units
Gen 0 CollectionsDisplays the number of times the generation 0 objects (that is, the youngest, most recently allocated objects) are garbage collected since the application started.
Gen 1 CollectionsDisplays the number of times the generation 1 objects are garbage collected since the application started
Gen 2 CollectionsDisplays the number of times the generation 2 objects are garbage collected since the application started
Handle CountHandle Count
Host NamesHostnames associated with the slot
Host Names DisabledTrue to disable the public hostnames of the slot; otherwise, false. If true, the slot is only accessible via API management process.
Hosting EnvironmentThe name of the slot Service Environment where the web slot was created
Hosting Environment IDResource ID of the slot Service Environment
Hosting Environment ProfileSlot Service Environment to use for the slot
HTTP 101Http 101
HTTP 2xxHttp 2xx
HTTP 3xxHttp 3xx
HTTP 401Http 401
HTTP 403Http 403
HTTP 404Http 404
HTTP 406Http 406
HTTP 4xxHttp 4xx
Http Server ErrorsHttp Server Errors
HTTPS OnlyWhether a slot is configured to accept only https requests. Issues redirect for http requests
IDResource ID of the configuration
I/O Other Data (Bytes per Second)Other I/O data during monitoring period
I/O Other Operations (Operations per Second)Other I/O
I/O Read Data (Bytes per Second)Average data read from disk during monitoring period
I/O Read Operations (Operations per Second)Disk read I/O
I/O Write Data (Bytes per Second)Average data written from disk during monitoring period
I/O Write Operations (Operations per Second)Disk write I/O
KindKind of site
Last Modified TimeLast time the slot was modified
LocationSite location
Maximum Number Of WorkersMaximum number of workers. This only slotlies to Functions container
Memory Working Set (Bytes)Memory working set
ModeA string that represents the website mode
NameSite name
Outbound IP AddressesList of IP addresses that the slot uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings
OwnerThe owner of the web slot
Possible Outbound IP AddressesList of IP addresses that the slot uses for outbound connections (e.g. database access). Includes VIPs from all tenants
Repository Site NameName of the repository site
Requests (Requests)Requests
Requests In Application Queue (Requests)The total number of requests in the application queue
ReservedWhether or not the site is reserved
Resource GroupName of the resource group the slot belongs to
Runtime Availability StateThe availability of the slot
SCM Site Also StoppedTrue to stop SCM (KUDU) site when the slot is stopped; otherwise, false
Self LinkDirect URL to the website endpoint on Windows Azure Web Sites that includes the subscription ID, webspace name, and site name
Server Farm IDResource ID of the associated slot Service plan
SKUThe name of the SKU for the web slot
SSL CertificatesThe SSL certificates associated with the site
StateCurrent state of the slot
Suspended TillSlot suspended till in case memory-time quota is exceeded
TagsTags assigned to the slot
Target Swap SlotSpecifies which deployment slot this slot will swap into
Thread CountThread Count
Total App DomainsThe total number of app domains associated to the slot
Total App Domains UnloadedThe total number of app domains that have been unloaded in the slot due to adversely affecting the performance of the entire process
Traffic Manager Host NamesAzure Traffic Manager hostnames associated with the web slot
TypeResource type
Usage StateState indicating whether the slot has exceeded its quota usage
Web SpaceThe name of the webspace in which the website is located

Slot Instance

NameDescription
App Connections (Connections)Connections
Average Memory Working Set (Bytes)Average memory working set
Average Response Time (Seconds)Average Response Time
CPU Time (Seconds)CPU Time
Current AssembliesThe number of assemblies currently associated to the slot
Data Received (Bytes)Data In
Data Sent (Bytes)Data Out
Function Execution CountFunction Execution Count
Function Execution UnitsFunction Execution Units
Gen 0 CollectionsDisplays the number of times the generation 0 objects (that is, the youngest, most recently allocated objects) are garbage collected since the application started.
Gen 1 CollectionsDisplays the number of times the generation 1 objects are garbage collected since the application started
Gen 2 CollectionsDisplays the number of times the generation 2 objects are garbage collected since the application started
Handle CountHandle Count
HTTP 101Http 101
HTTP 2xxHttp 2xx
HTTP 3xxHttp 3xx
HTTP 401Http 401
HTTP 403Http 403
HTTP 404Http 404
HTTP 406Http 406
HTTP 4xxHttp 4xx
Http Server ErrorsHttp Server Errors
InstanceInstance
I/O Other Data (Bytes per Second)Other I/O data during monitoring period
I/O Other Operations (Operations per Second)Other I/O
I/O Read Data (Bytes per Second)Average data read from disk during monitoring period
I/O Read Operations (Operations per Second)Disk read I/O
I/O Write Data (Bytes per Second)Average data written from disk during monitoring period
I/O Write Operations (Operations per Second)Disk write I/O
Memory Working Set (Bytes)Memory working set
Parent IDThe ID of the parent slot
Requests (Requests)Requests
Requests In Application Queue (Requests)The total number of requests in the application queue
Thread CountThread Count
Total App DomainsThe total number of app domains associated to the slot
Total App Domains UnloadedThe total number of app domains that have been unloaded in the slot due to adversely affecting the performance of the entire process

Usage

NameDescription
Current ValueThe current value of the resource counter
LimitThe resource limit
NameLocalized name for the quota
Next Reset TimeNext reset time for the resource counter
Parent IDThe ID of the parent site
UnitUnits of measurement for the quota resource

Updated 8 months ago

Microsoft Azure Web App


Azure Web Application Hosting Service

Suggested Edits are limited on API Reference Pages

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