CloudQuery Azure Source Plugin Configuration Reference

Example #

kind: source
spec:
  # Source spec section
  name: "azure"
  path: "cloudquery/azure"
  registry: "cloudquery"
  version: "v16.0.3"
  destinations: ["postgresql"]
  tables: ["azure_compute_virtual_machines"]
  # Learn more about the configuration options at https://cql.ink/azure_source
  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 #

• 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, AzureGovernment.
• concurrency (integer) (default: 50000):

  The best effort maximum number of Go routines to use. Lower this number to reduce memory usage.
• discovery_concurrency (integer) (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.
• scheduler (string) (default: dfs):

  The scheduler to use when determining the priority of resources to sync. Supported values are dfs (depth-first search), round-robin, shuffle and shuffle-queue.

  For more information about this, see performance tuning.
• 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

retry_options #

• max_retries (integer) (default: 10)

• try_timeout_seconds (integer) (default: 0)

• retry_delay_seconds (integer) (default: 4)

• max_retry_delay_seconds (integer) (default: 60)

• status_codes ([]integer) (default: null)