steampipe plugin install azure

Table: azure_signalr_service - Query Azure SignalR Services using SQL

Azure SignalR Service is a fully-managed service that allows developers to focus on building real-time web experiences without worrying about capacity provisioning, reliable connections, scaling, encryption, or authentication. It is an Azure service that helps to simplify the process of adding real-time web functionality to applications over HTTP. This functionality enables applications to stream content updates to connected clients instantly.

Table Usage Guide

The azure_signalr_service table offers insights into Azure SignalR Services within Microsoft Azure. As a developer or system administrator, you can explore service-specific details through this table, including service tiers, client negotiation endpoints, and associated metadata. Use this table to monitor and manage your SignalR Services, identify their capacity and usage, and ensure optimal performance and security for your real-time web applications.

Examples

Basic info

Explore the status and type of your Azure SignalR services to understand their current operational state and categorization. This is beneficial for managing and monitoring your application's real-time messaging services.

select
name,
id,
type,
kind,
provisioning_state
from
azure_signalr_service;
select
name,
id,
type,
kind,
provisioning_state
from
azure_signalr_service;

List network ACL details for SignalR service

This query helps you explore the network access control list (ACL) details for your SignalR service. It's useful for understanding the default actions and the configuration of private and public networks, which in turn can aid in managing access control and enhancing security.

select
name,
id,
type,
provisioning_state,
network_acls ->> 'defaultAction' as default_action,
jsonb_pretty(network_acls -> 'privateEndpoints') as private_endpoints,
jsonb_pretty(network_acls -> 'publicNetwork') as public_network
from
azure_signalr_service;
select
name,
id,
type,
provisioning_state,
json_extract(network_acls, '$.defaultAction') as default_action,
network_acls as private_endpoints,
network_acls as public_network
from
azure_signalr_service;

List private endpoint connection details for SignalR service

Determine the areas in which private endpoint connections are established for the SignalR service. This is useful for understanding and managing the security and access of your SignalR services.

select
name,
id,
connections ->> 'ID' as connection_id,
connections ->> 'Name' as connection_name,
connections ->> 'PrivateEndpointPropertyID' as property_private_endpoint_id,
jsonb_pretty(connections -> 'PrivateLinkServiceConnectionState') as property_private_link_service_connection_state,
connections ->> 'Type' as connection_type
from
azure_signalr_service,
jsonb_array_elements(private_endpoint_connections) as connections;
select
name,
id,
json_extract(connections.value, '$.ID') as connection_id,
json_extract(connections.value, '$.Name') as connection_name,
json_extract(connections.value, '$.PrivateEndpointPropertyID') as property_private_endpoint_id,
connections.value as property_private_link_service_connection_state,
json_extract(connections.value, '$.Type') as connection_type
from
azure_signalr_service,
json_each(private_endpoint_connections) as connections;

Schema for azure_signalr_service

NameTypeOperatorsDescription
_ctxjsonbSteampipe context in JSON form.
akasjsonbArray of globally unique identifier strings (also known as) for the resource.
cloud_environmenttextThe Azure Cloud Environment.
corsjsonbCross-Origin Resource Sharing (CORS) settings of the resource.
diagnostic_settingsjsonbA list of active diagnostic settings for the SignalR service.
external_iptextThe publicly accessible IP of the SignalR service.
featuresjsonbList of SignalR feature flags.
host_nametextFQDN of the SignalR service instance.
host_name_prefixtextPrefix for the host name of the SignalR service.
idtextFully qualified resource ID for the resource.
kindtextThe kind of the service. Possible values include: 'SignalR', 'RawWebSockets'.
nametext=The name of the resource.
network_aclsjsonbNetwork ACLs of the resource.
private_endpoint_connectionsjsonbPrivate endpoint connections to the SignalR resource.
provisioning_statetextProvisioning state of the resource. Possible values include: 'Unknown', 'Succeeded', 'Failed', 'Canceled', 'Running', 'Creating', 'Updating', 'Deleting', 'Moving'.
public_portbigintThe publicly accessible port of the SignalR service which is designed for browser/client side usage.
regiontextThe Azure region/location in which the resource is located.
resource_grouptext=The resource group which holds this resource.
server_portbigintThe publicly accessible port of the SignalR service which is designed for customer server side usage.
skujsonbThe billing information of the resource.
sp_connection_nametext=, !=, ~~, ~~*, !~~, !~~*Steampipe connection name.
sp_ctxjsonbSteampipe context in JSON form.
subscription_idtext=, !=, ~~, ~~*, !~~, !~~*The Azure Subscription ID in which the resource is located.
tagsjsonbA map of tags for the resource.
titletextTitle of the resource.
typetextThe type of the resource.
upstreamjsonbUpstream settings when the Azure SignalR is in server-less mode.
versiontextVersion of the SignalR 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_signalr_service