Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve table docs and recompile plugin with steampipe-plugin-sdk v5.7.0 #697

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/tables/azure_ad_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Azure Active Directory groups is used to manage access to your cloud-based apps,
## Examples

### Basic info
Determine the areas in which your Azure Active Directory groups are mail-enabled. This could be beneficial for managing group email communications and understanding which groups have specific email settings.

```sql
select
Expand All @@ -21,6 +22,7 @@ from


### List of AD groups where security is not enabled
Determine the areas in which Azure Active Directory groups are not security-enabled. This is crucial for identifying potential vulnerabilities and enhancing the security posture of your organization.

```sql
select
Expand All @@ -35,6 +37,7 @@ where


### List of AD groups where mail is not enabled
Determine the areas in which Azure Active Directory groups have not enabled mail. This can be useful in identifying groups that may not be receiving important communications or updates.

```sql
select
Expand All @@ -45,4 +48,4 @@ from
azure_ad_group
where
not mail_enabled;
```
```
6 changes: 5 additions & 1 deletion docs/tables/azure_ad_service_principal.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ An Azure service principal is an identity created for use with applications, hos
## Examples

### List of ad service principals where service principal account is disabled
Determine which ad service principals have their account disabled in Azure. This is useful for identifying potential inactive or unused resources within your Azure environment.

```sql
select
Expand All @@ -22,6 +23,7 @@ where


### List of ad service principals where app role assignment is not required
Determine the areas in which ad service principals do not require app role assignments. This is useful to identify potential areas of your Azure AD environment where security could be improved by requiring app role assignments.

```sql
select
Expand All @@ -36,6 +38,7 @@ where


### Application role info of service principals
Identify the roles of service principals within an application to gain insights into their permissions and status. This is useful for understanding who has access to what within your application and ensuring appropriate security measures are in place.

```sql
select
Expand All @@ -53,6 +56,7 @@ from


### Oauth 2.0 permission info of ad service principal
This query is useful to gain insights into the permissions related to the OAuth 2.0 protocol for an advertising service principal in Azure. It allows you to understand the consent descriptions, display names, IDs and the status (enabled or not) of these permissions, which is crucial for managing access and maintaining security.

```sql
select
Expand All @@ -66,4 +70,4 @@ select
from
azure_ad_service_principal
cross join jsonb_array_elements(oauth2_permissions) as perm;
```
```
6 changes: 4 additions & 2 deletions docs/tables/azure_ad_user.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Azure Active Directory (Azure AD) is Microsoft's cloud-based identity and access
## Examples

### Basic active directory user info
Explore user details within your Azure Active Directory to gain insights into their status and contact information. This can be particularly useful for managing user access and maintaining up-to-date records.

```sql
select
Expand All @@ -22,6 +23,7 @@ from


### List of guest users in the active directory
Determine the areas in which guest users are active within your directory. This can help in managing user access and maintaining security protocols.

```sql
select
Expand All @@ -38,6 +40,7 @@ where


### Password profile info of each user
Determine the areas in which user password policies are enforced and where users are required to change their passwords at their next login. This helps to understand and manage user security within your Azure Active Directory.

```sql
select
Expand All @@ -47,5 +50,4 @@ select
additional_properties -> 'passwordProfile' -> 'forceChangePasswordNextLogin' as change_password_next_login
from
azure_ad_user;
```

```
7 changes: 6 additions & 1 deletion docs/tables/azure_alert_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Azure Alert Management is a service and set of tools within Microsoft Azure that
## Examples

### Basic info
Explore which alerts are currently active within your Azure management system. This can help you identify potential issues or areas that may require your attention, thus improving system monitoring and management.

```sql
select
Expand All @@ -40,6 +41,7 @@ from
```

### List fired alerts
Discover the alerts that have been triggered in your Azure environment. This can help you quickly identify potential issues or anomalies that require attention.

```sql
select
Expand All @@ -57,6 +59,7 @@ where
```

### List alerts within the last 7 days
Gain insights into recent alerts by identifying those that occurred within the past week. This is useful for keeping track of recent system issues or identifying patterns in alert occurrences.

```sql
select
Expand All @@ -73,6 +76,7 @@ where
```

### List critical alerts
Uncover the details of critical alerts in your Azure environment to promptly address any severe issues affecting your resources. This query helps in identifying and prioritizing alerts with the highest severity for immediate action.

```sql
select
Expand All @@ -90,6 +94,7 @@ where
```

### List alerts of VMInsights monitoring service
Explore alerts generated by the VMInsights monitoring service. This can help you gain insights into system performance and identify potential issues with your virtual machines.

```sql
select
Expand All @@ -104,4 +109,4 @@ from
azure_alert_management
where
monitor_service = 'VMInsights';
```
```
19 changes: 16 additions & 3 deletions docs/tables/azure_api_management.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
# Table: azure_api_management
---
title: "Steampipe Table: azure_api_management - Query Azure API Management Services using SQL"
description: "Allows users to query Azure API Management Services."
---

Azure API Management is a fully managed service that enables customers to publish, secure, transform, maintain, and monitor APIs.
# Table: azure_api_management - Query Azure API Management Services using SQL

Azure API Management is a fully managed service that helps customers publish, secure, transform, maintain, and monitor APIs. With Azure API Management, organizations can ensure that their APIs are always available and performing as expected, and that their valuable data is secure. The service also includes a developer portal to help onboard developers and foster a developer community.

## Table Usage Guide

The 'azure_api_management' table provides insights into API Management Services within Azure. As a DevOps engineer, explore service-specific details through this table, including API names, locations, and associated metadata. Utilize it to uncover information about services, such as those with specific SKUs, the regions they are deployed in, and the verification of their identities. The schema presents a range of attributes of the API Management Service for your analysis, like the service name, resource group, subscription ID, and associated tags.

## Examples

### Public and private IP address info of each API management
Gain insights into the public and private IP addresses associated with each API management system in your Azure environment. This allows for better network management and security monitoring.

```sql
select
Expand All @@ -17,6 +27,7 @@ from


### API management publisher info
Gain insights into the publishers of your Azure API management service, including their names and contact emails, to facilitate effective communication and management.

```sql
select
Expand All @@ -29,6 +40,7 @@ from


### List of premium API managements and their computing capacity
Identify premium Azure API management services and their computing capacities. This is useful for assessing your organization's API management capabilities and planning for potential upgrades or expansions.

```sql
select
Expand All @@ -43,6 +55,7 @@ where


### List of API management without application tag key
Identify instances where API management in Azure is missing the 'application' tag. This can aid in pinpointing areas where tagging conventions may not have been followed, helping to improve resource management and compliance.

```sql
select
Expand All @@ -52,4 +65,4 @@ from
azure_api_management
where
not tags :: JSONB ? 'application';
```
```
20 changes: 17 additions & 3 deletions docs/tables/azure_app_configuration.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
# Table: azure_app_configuration
---
title: "Steampipe Table: azure_app_configuration - Query Azure App Configuration Stores using SQL"
description: "Allows users to query Azure App Configuration Stores"
---

Azure App Configuration provides a service to centrally manage application settings and feature flags. App Configuration is used to store all the settings for your application and secure their accesses in one place.
# Table: azure_app_configuration - Query Azure App Configuration Stores using SQL

Azure App Configuration is a managed service that helps developers centralize their application and feature settings simply and securely. It provides a way to manage and distribute application settings, helping to improve the speed and reliability of application deployment. Azure App Configuration also allows you to automate the process of managing and updating these settings across multiple environments.

## Table Usage Guide

The 'azure_app_configuration' table provides insights into App Configuration Stores within Azure App Configuration. As a DevOps engineer, explore store-specific details through this table, including store names, resource groups, subscription IDs, and associated metadata. Utilize it to uncover information about stores, such as their provisioning states, creation times, and the number of failed requests. The schema presents a range of attributes of the App Configuration Store for your analysis, like the store name, creation date, provisioning state, and associated tags.

## Examples

### Basic info
Explore the status and creation dates of your Azure application configurations. This can help you understand the overall state of your applications, allowing for better management and timely updates.

```sql
select
Expand All @@ -18,6 +28,7 @@ from
```

### List public network access enabled app configurations
Explore which app configurations have public network access enabled. This can be useful in identifying potential security risks and ensuring your app configurations adhere to best practices.

```sql
select
Expand All @@ -33,6 +44,7 @@ where
```

### List app configurations with user assigned identities
This query helps in identifying the application configurations within Azure that have been assigned user identities. It is useful in managing and tracking user access, contributing to improved security and compliance.

```sql
select
Expand All @@ -53,6 +65,7 @@ where
```

### List private endpoint connection details for app configurations
Explore the details of private endpoint connections for your app configurations. This can help you understand their current status, any required actions, and their provisioning state, which can be useful for troubleshooting or optimizing your app's performance.

```sql
select
Expand All @@ -70,6 +83,7 @@ from
```

### List encryption details for app configurations
Explore the encryption details of your app configurations to ensure secure data handling. This is particularly useful in maintaining data security standards and regulatory compliance.

```sql
select
Expand All @@ -79,4 +93,4 @@ select
encryption -> 'keyVaultProperties' ->> 'keyIdentifier' as key_vault_key_identifier
from
azure_app_configuration;
```
```
18 changes: 15 additions & 3 deletions docs/tables/azure_app_service_environment.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
# Table: azure_app_service_environment
---
title: "Steampipe Table: azure_app_service_environment - Query Azure App Service Environments using SQL"
description: "Allows users to query Azure App Service Environments"
---

The Azure App Service Environment provides a fully isolated and dedicated environment for securely running App Service apps at high scale.
# Table: azure_app_service_environment - Query Azure App Service Environments using SQL

Azure App Service Environment is a fully isolated and dedicated environment for securely running App Service apps at high scale. It is designed for applications that require secure, scalable and isolated environments for their execution. It provides network isolation and improved scalability capabilities, making it ideal for applications that require high levels of security and isolation, or that run at a large scale.

## Table Usage Guide

The 'azure_app_service_environment' table provides insights into App Service Environments within Azure. As a DevOps engineer, explore environment-specific details through this table, including the environment's capacity, status, and associated metadata. Utilize it to uncover information about the environments, such as their virtual network integration, worker pool specifications, and inbound and outbound IP addresses. The schema presents a range of attributes of the App Service Environment for your analysis, like the environment's ID, location, resource group, and tags.

## Examples

### List of app service environments which are not healthy
Identify the Azure app service environments that are not functioning properly. This is useful for promptly addressing issues and maintaining optimal application performance.

```sql
select
Expand All @@ -17,6 +27,7 @@ where
```

### Virtual network info of each app service environment
Gain insights into the virtual network configuration of each app service environment to understand the internal load balancing mode and ensure optimal resource allocation.

```sql
select
Expand All @@ -30,6 +41,7 @@ from
```

### List cluster settings details
Explore the configuration details of your Azure app service environment to gain insights into the specific cluster settings. This can help you understand the current setup and make informed decisions on potential modifications.

```sql
select
Expand All @@ -40,4 +52,4 @@ select
from
azure_app_service_environment,
jsonb_array_elements(cluster_settings) as settings;
```
```
19 changes: 16 additions & 3 deletions docs/tables/azure_app_service_function_app.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
# Table: azure_app_service_function_app
---
title: "Steampipe Table: azure_app_service_function_app - Query Azure App Service Function Apps using SQL"
description: "Allows users to query Azure App Service Function Apps."
---

A function app is the container that hosts the execution of individual functions.
# Table: azure_app_service_function_app - Query Azure App Service Function Apps using SQL

Azure App Service is a fully managed platform for building, deploying, and scaling web apps. Azure Function Apps, a part of Azure App Service, is a serverless compute service that lets you run event-triggered code without having to provision or manage infrastructure. It enables developers to host and run chunks of code, or "functions," in the cloud, without needing to create a virtual machine or publish a web application.

## Table Usage Guide

The 'azure_app_service_function_app' table provides insights into Function Apps within Azure App Service. As a DevOps engineer, explore Function App-specific details through this table, including App settings, connection strings, default hostname, and associated metadata. Utilize it to uncover information about Function Apps, such as those with specific configurations, the relationships between apps, and the verification of connection strings. The schema presents a range of attributes of the Function App for your analysis, like the app service plan id, creation date, default hostname, and associated tags.

## Examples

### List of app functions which accepts HTTP traffic
Identify Azure app functions that accept HTTP traffic to assess potential security risks and ensure secure communication protocols are in place.

```sql
select
Expand All @@ -20,6 +30,7 @@ where


### List of all unreserved app function
Explore which Azure app service function apps are not reserved. This is useful for identifying potential resource allocation inefficiencies and optimizing your cloud infrastructure.

```sql
select
Expand All @@ -34,6 +45,7 @@ where


### Outbound IP addresses and possible outbound IP addresses info of each function app
Explore the outbound IP addresses associated with each function app to understand potential network communication paths. This is useful in identifying and managing the network traffic routes for your application.

```sql
select
Expand All @@ -46,6 +58,7 @@ from


### List of app functions where client certificate mode is disabled.
Explore which Azure app service functions have the client certificate mode disabled. This can be useful for identifying potential security vulnerabilities in your application services.

```sql
select
Expand All @@ -57,4 +70,4 @@ from
azure_app_service_function_app
where
not client_cert_enabled;
```
```
Loading