Microsoft Azure Search
Microsoft Azure Search as a Service
This source has been deprecated
observIQ is in the process of transitioning a subset of BindPlane's monitoring capabilities to the observIQ OpenTelemetry Collector. As a result, this Source is no longer publicly available in BindPlane. If you need access to this Source, please reach out to our support via chat or via [email protected].
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:
- Using the Azure CLI Client, find the Subscription ID and Tenant ID from your account list
- Create a custom RBAC role using the JSON provided. Include your Subscription ID and rename the file to azure.json
- 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 Search",
"Description": "LPU for Search",
"Actions": [
"Microsoft.Search/searchServices/*/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. |
Query Key
| Name | Description |
|---|---|
| Key | The value of the query API key |
| Name | The name of the query API key |
| Parent ID | The ID of this query's parent search service. |
Search Service
| Name | Description |
|---|---|
| Etag | A unique read-only string that changes whenever the resource is updated |
| Hosting Mode | Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU |
| ID | The ID of the search service |
| Location | The geographic location of the search service |
| Name | The name of the search service |
| Partition Count | The number of partitions in the search service |
| Provisioning State | The state of the last provisioning operation performed on the search service |
| Replica Count | The number of replicas in the search service |
| Resource Group | The Resource Group of the Azure resource. |
| Search Latency (Seconds) | Average search latency for the search service |
| Search Queries (per Second) | Search queries per second for the search service |
| SKU | The SKU of the Search service |
| Status | The status of the search service |
| Status Details | The details of the Search service status |
| Throttled Search Queries (%) | Percentage of search queries that were throttled for the search service |
| Type | Microsoft Azure resource type |
Updated about 2 years ago