CloudQuery Azure Source Plugin Configuration Reference

Example

This example connects a single Azure subscription to a single destination. The (top level) source spec section is described in the Source Spec Reference.

kind: source
spec:
  # Source spec section
  name: "azure"
  path: "cloudquery/azure"
  version: "v10.1.0"
  destinations: ["postgresql"]
  tables: ["azure_compute_virtual_machines"]
  spec:
    # Optional parameters
    # subscriptions: []
    # cloud_name: ""
    # concurrency: 50000
    # discovery_concurrency: 400
    # skip_subscriptions: []
    # normalize_ids: false
    # oidc_token: ""
    # retry_options:
    #   max_retries: 3
    #   try_timeout_seconds: 0
    #   retry_delay_seconds: 4
    #   max_retry_delay_seconds: 60

Azure Spec

This is the (nested) spec used by the Azure source plugin.

subscriptions ([]string) (default: empty. Will use all visible subscriptions)

Specify which subscriptions to sync data from.
cloud_name (string) (default: empty)

The name of the cloud environment to use. Possible values are AzureCloud, AzureChinaCloud, AzureUSGovernment. See the Azure CLI documentation for more information (opens in a new tab).
concurrency (int) (default: 50000):

The best effort maximum number of Go routines to use. Lower this number to reduce memory usage.
discovery_concurrency (int) (default: 400)

During initialization the Azure source plugin discovers all resource groups and enabled resource providers per subscription, to be used later on during the sync process. The plugin runs the discovery process in parallel. This setting controls the maximum number of concurrent requests to the Azure API during discovery. Only accounts with many subscriptions should require modifying this setting, to either lower it to avoid network errors, or to increase it to speed up the discovery process.
skip_subscriptions ([]string) (default: empty)

A list of subscription IDs that CloudQuery will skip syncing. This is useful if CloudQuery is discovering the list of subscription IDs and there are some subscriptions that you want to not even attempt syncing.
normalize_ids (bool) (default: false)

Enabling this setting will force all id column values to be lowercase. This is useful to avoid case sensitivity and uniqueness issues around the id primary keys
oidc_token (string) (default: empty)

An OIDC token can be used to authenticate with Azure instead of AZURE_CLIENT_SECRET. This is useful for Azure AD workload identity federation. When using this option, the AZURE_CLIENT_ID and AZURE_TENANT_ID environment variables must be set.
retry_options (RetryOptions) (default: empty)

Retry options to pass to the Azure Go SDK, see more details here (opens in a new tab)

`retry_options`

max_retries (integer) (default: 3)

Described in the Azure Go SDK (opens in a new tab)

try_timeout_seconds (integer) (default: 0)

Disabled by default, see the Azure Go SDK (opens in a new tab) for more details

retry_delay_seconds (integer) (default: 4)

Described in the Azure Go SDK (opens in a new tab)

max_retry_delay_seconds (integer) (default: 60)

Described in the Azure Go SDK (opens in a new tab)

status_codes ([]integer) (default: nil)

Described in the Azure Go SDK (opens in a new tab) The default of nil uses the default status codes (opens in a new tab). An empty value disables retries for HTTP status codes.

Overview Tables