Table: azure_search_service - Query Azure Search Services using SQL
Azure Search Service is a fully managed cloud search service provided by Microsoft Azure. It offers scalable and secure search capabilities across all your data. With Azure Search Service, you can quickly add sophisticated search capabilities to your applications, making it easier for users to find the information they are looking for.
Table Usage Guide
The azure_search_service
table provides insights into the Search Services within Microsoft Azure. As a developer or system administrator, you can explore service-specific details through this table, including properties, settings, and status. Utilize it to uncover information about each search service, such as its provisioning state, SKU, and network rules, to manage and optimize your application's search capabilities effectively.
Examples
Basic info
Explore the status and configuration of your Azure Search Services to assess resource allocation and utilization. This can help in identifying areas for optimization and managing your resources efficiently.
select name, id, type, provisioning_state, status, sku_name, replica_countfrom azure_search_service;
select name, id, type, provisioning_state, status, sku_name, replica_countfrom azure_search_service;
List publicly accessible search services
Determine the areas in which publicly accessible search services are enabled. This is useful in identifying potential security risks and ensuring appropriate access controls are in place.
select name, id, public_network_accessfrom azure_search_servicewhere public_network_access = 'Enabled';
select name, id, public_network_accessfrom azure_search_servicewhere public_network_access = 'Enabled';
Control examples
- All Controls > Cognitive Search > Cognitive Search services should maintain SLA for index updates
- All Controls > Cognitive Search > Cognitive Search services should use managed identity
- Azure Cognitive Search service should use a SKU that supports private link
- Azure Cognitive Search services should disable public network access
- Azure Cognitive Search services should use private link
- Resource logs in Search services should be enabled
Schema for azure_search_service
Name | Type | Operators | Description |
---|---|---|---|
_ctx | jsonb | Steampipe context in JSON form. | |
akas | jsonb | Array of globally unique identifier strings (also known as) for the resource. | |
cloud_environment | text | The Azure Cloud Environment. | |
diagnostic_settings | jsonb | A list of active diagnostic settings for the search service. | |
hosting_mode | text | 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. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'. Possible values include: 'Default', 'HighDensity'. | |
id | text | Fully qualified resource ID for the resource. | |
identity | jsonb | The identity of the resource. | |
name | text | = | The name of the resource. |
network_rule_set | jsonb | Network specific rules that determine how the azure cognitive search service may be reached. | |
partition_count | bigint | The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3. | |
private_endpoint_connections | jsonb | The list of private endpoint connections to the azure cognitive search service. | |
provisioning_state | text | The state of the last provisioning operation performed on the search service. | |
public_network_access | text | This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method. Possible values include: 'Enabled', 'Disabled'. | |
region | text | The Azure region/location in which the resource is located. | |
replica_count | bigint | The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU. | |
resource_group | text | = | The resource group which holds this resource. |
shared_private_link_resources | jsonb | The list of shared private link resources managed by the azure cognitive search service. | |
sku_name | text | The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new search service. | |
sp_connection_name | text | =, !=, ~~, ~~*, !~~, !~~* | Steampipe connection name. |
sp_ctx | jsonb | Steampipe context in JSON form. | |
status | text | The status of the search service. Possible values include: 'running', deleting', 'provisioning', 'degraded', 'disabled', 'error' etc. | |
status_details | text | The details of the search service status. | |
subscription_id | text | =, !=, ~~, ~~*, !~~, !~~* | The Azure Subscription ID in which the resource is located. |
tags | jsonb | A map of tags for the resource. | |
title | text | Title of the resource. | |
type | text | The type of the resource. |
Export
This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.
You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh
script:
/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- azure
You can pass the configuration to the command with the --config
argument:
steampipe_export_azure --config '<your_config>' azure_search_service