microsoft_security data source

blackstork/microsoft, v0.4.2

Description

The microsoft_security data source queries Microsoft Security API.

Installation

To use the microsoft_security data source locally via blackstork-cli, you must declare the blackstork/microsoft plugin as a dependency in your global configuration block.

blackstork {
  plugin_versions = {
    "blackstork/microsoft" = ">= v0.4.2"
  }
}

After declaring the dependency, execute blackstork-cli install to fetch the plugin. See Configuration for details.

Configuration

This data source accepts the following configuration arguments within a config data microsoft_security block:

config data microsoft_security {
  # The Azure client ID
  #
  # Required string.
  #
  # For example:
  client_id = "some string"

  # The Azure client secret. Required if `private_key_file` or `private_key` is not provided.
  #
  # Optional string.
  # Default value:
  client_secret = null

  # The Azure tenant ID
  #
  # Required string.
  #
  # For example:
  tenant_id = "some string"

  # The path to the private key file. Ignored if `private_key` or `client_secret` is provided.
  #
  # Optional string.
  # Default value:
  private_key_file = null

  # The private key contents. Ignored if `client_secret` is provided.
  #
  # Optional string.
  # Default value:
  private_key = null

  # The key passphrase. Ignored if `client_secret` is provided.
  #
  # Optional string.
  # Default value:
  key_passphrase = null
}

Usage

This data source accepts the following arguments within a data microsoft_security block:

data microsoft_security {
  # API endpoint to query
  #
  # Required string.
  #
  # For example:
  endpoint = "/users"

  # HTTP query parameters
  #
  # Optional map of string.
  # Default value:
  query_params = null

  # Number of objects to be returned
  #
  # Optional number.
  # Must be >= 1
  # Default value:
  size = 50

  # Indicates if API endpoint serves a single object. If set to `true`, `query_params` and `size` arguments are ignored.
  #
  # Optional bool.
  # Default value:
  is_object_endpoint = false
}