turbot/azuread

steampipe plugin install azureadsteampipe plugin install azuread

Azure Active Directory + Steampipe

Azure Active Directory is Microsoft’s cloud-based identity and access management service, which helps your employees sign in and access resources in:

  • External resources, such as Microsoft 365, the Azure portal, and thousands of other SaaS applications.
  • Internal resources, such as apps on your corporate network and intranet, along with any cloud apps developed by your own organization.

Steampipe is an open source CLI to instantly query cloud APIs using SQL.

For example:

select
display_name,
user_principal_name,
user_type
from
azuread_user;
+----------------+--------------------------------------------+-----------+
| display_name | user_principal_name | user_type |
+----------------+--------------------------------------------+-----------+
| Dwight Schrute | dwight@contoso.onmicrosoft.com | Member |
| Jim Halpert | jim_gmail.com#EXT#@contoso.onmicrosoft.com | Guest |
| Pam Beesly | pam_beesly@contoso.onmicrosoft.com | Member |
| Michael Scott | michael@contoso.onmicrosoft.com | Member |
+----------------+--------------------------------------------+-----------+

Documentation

Get started

Install

Download and install the latest Azure Active Directory plugin:

steampipe plugin install azuread

Credentials

ItemDescription
CredentialsUse the az login command to setup your Azure AD Default Connection
PermissionsGrant the Global Reader permission to your user.
RadiusEach connection represents a single Azure Tenant.
Resolution1. Credentials explicitly set in a steampipe config file (~/.steampipe/config/azuread.spc).
2. Credentials specified in environment variables e.g. AZURE_TENANT_ID.

Configuration

Installing the latest azuread plugin will create a config file (~/.steampipe/config/azuread.spc) with a single connection named azuread:

connection "azuread" {
plugin = "azuread"
# Defaults to "AZUREPUBLICCLOUD". Valid environments are "AZUREPUBLICCLOUD", "AZURECHINACLOUD", "AZUREGERMANCLOUD" and "AZUREUSGOVERNMENTCLOUD"
# environment = "AZUREPUBLICCLOUD"
# You can connect to Azure using one of options below:
# Use client secret authentication (https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#option-2-create-a-new-application-secret)
# tenant_id = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
# client_id = "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY"
# client_secret = "ZZZZZZZZZZZZZZZZZZZZZZZZ"
# Use client certificate authentication (https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#option-1-upload-a-certificate)
# required options:
# tenant_id = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
# client_id = "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY"
# certificate_path = "~/home/azure_cert.pem"
# certificate_password = "notreal~pwd"
# Use a managed identity (https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview)
# This method is useful with Azure virtual machines
# enable_msi = true
# msi_endpoint = "http://169.254.169.254/metadata/identity/oauth2/token"
# If no credentials are specified, the plugin will use Azure CLI authentication
}

By default, all options are commented out in the default connection, thus Steampipe will resolve your credentials using the same order as mentioned in Credentials. This provides a quick way to get started with Steampipe, but you will probably want to customize your experience using configuration options for querying multiple tenants, configuring credentials from your Azure CLI, Client Certificate, etc.

Get involved

Configuring Azure Active Directory Credentials

The Azure AD plugin support multiple formats and authentication mechanisms, and they are tried in the below order:

  1. Client Secret Credentials if set; otherwise
  2. Client Certificate Credentials if set; otherwise
  3. Azure Managed System Identity (useful with virtual machines) if set; otherwise
  4. If no credentials are supplied, then the az cli credentials are used

Client Secret Credentials

You may specify the tenant ID, client ID, and client secret to authenticate:

  • tenant_id: Specify the tenant to authenticate with.
  • client_id: Specify the app client ID to use.
  • client_secret: Specify the app secret to use.
connection "azuread_via_sp_secret" {
plugin = "azuread"
tenant_id = "00000000-0000-0000-0000-000000000000"
client_id = "00000000-0000-0000-0000-000000000000"
client_secret = "my plaintext password"
}

Client Certificate Credentials

You may specify the tenant ID, client ID, certificate path, and certificate password to authenticate:

  • tenant_id: Specify the tenant to authenticate with.
  • client_id: Specify the app client ID to use.
  • certificate_path: Specify the certificate path to use.
  • certificate_password: Specify the certificate password to use.
connection "azuread_via_sp_cert" {
plugin = "azuread"
tenant_id = "00000000-0000-0000-0000-000000000000"
client_id = "00000000-0000-0000-0000-000000000000"
certificate_path = "path/to/file.pem"
certificate_password = "my plaintext password"
}

Azure Managed Identity

Steampipe works with managed identities (formerly known as Managed Service Identity), provided it is running in Azure, e.g., on a VM. All configuration is handled by Azure. See Azure Managed Identities for more details.

  • enable_msi: Specify true to use managed identity credentials.
  • msi_endpoint: Specify the MSI endpoint to connect to, otherwise use the default Azure Instance Metadata Service (IMDS) endpoint.
connection "azure_msi" {
plugin = "azuread"
enable_msi = true
msi_endpoint = "http://169.254.169.254/metadata/identity/oauth2/token"
}

Azure CLI

If no credentials are specified and the SDK environment variables are not set, the plugin will use the active credentials from the az cli. You can run az login to set up these credentials.

connection "azuread" {
plugin = "azuread"
}

Credentials from Environment Variables

The Azure AD plugin will use the standard Azure environment variables to obtain credentials only if other arguments (tenant_id, client_id, client_secret, certificate_path, etc..) are not specified in the connection:

export AZURE_TENANT_ID="00000000-0000-0000-0000-000000000000"
export AZURE_ENVIRONMENT="AZUREPUBLICCLOUD"
export AZURE_CLIENT_ID="00000000-0000-0000-0000-000000000000"
export AZURE_CLIENT_SECRET="my plaintext secret"
export AZURE_CERTIFICATE_PATH=path/to/file.pem
export AZURE_CERTIFICATE_PASSWORD="my plaintext password"
connection "azuread" {
plugin = "azuread"
}