Documentation Index

Fetch the complete documentation index at: https://docs.turbo360.com/llms.txt

Use this file to discover all available pages before exploring further.

Managing document configurations

  • 4 minute(s) read
Prev Next

Overview

A document configuration defines all the settings Azure Documenter uses to generate a report — document name, type, Service principal scope, branding, publish destination, optional schedule, and notification channels. Configurations are created through the Add configuration wizard and managed from the document configurations list.

Business value

  • Standardize how each report is generated — all settings are saved in one reusable configuration
  • Produce recurring reports on demand or on a schedule without reconfiguring settings each time
  • Manage all configurations from a central list with generate, edit, and delete options per configuration

Prerequisites

Required permissions

Azure Documenter requires the following access to generate documents for a subscription:

Service principal access

A Service principal with Reader access to the target Azure subscription. See Prerequisites and Service principal setup.

Turbo360 access

Role Permission level Access
Account owner, Owner, Contributor — Full access to the Documentation tab
Custom role Documentation enabled Can create documents and perform all activities within the Documentation tab

Dependencies

A configured Service principal is required before you can create a document configuration — Azure Documenter uses it to retrieve the subscriptions available for selection.

How it works

Each document configuration is created through the Add configuration wizard and saved to the document configurations list. A configuration stores all settings needed to generate a report: the document name and type, the Service principal and subscriptions that provide Azure access, branding for the document cover page, the publish destination, an optional recurring schedule, and notification channels.

Once saved, a configuration can be generated on demand, scheduled for recurring generation, edited to update any setting, or deleted from the document configurations list.

Steps

Use the following steps to add, edit, or delete a document configuration. Start from the Documentation tab in Azure Documenter.

Add a configuration

Creating a configuration saves the document type, Service principal scope, branding, publish settings, and schedule that Azure Documenter reuses every time this document is generated.

  1. In the document configurations list, click + New configuration.
  2. Complete the Add configuration wizard:
    • Basics — enter a Name (required) and optional Description. Under Choose document type, select a document type using the filter tabs (Executive, Finance, Security, Operations, Architecture, Sustainability, Microsoft 365) or the search field. Configure the document-type-specific options that appear (for example, billing range and currency for cost-related types).
    • Service principal — select the Service principal and the subscriptions to include. Click Bulk scope selection to apply scope filters across multiple subscriptions at once.
    • Branding — set an Accent colour (default #2b6cb0) and optionally upload a Logo (PNG, JPG, SVG, or ICO; max 100 KB). These apply to the document cover page and accent elements.
    • Publish settings — choose Publish document to Azure Storage account (PDF, Word, or Excel) or Publish document to Document360.
    • Schedule — optionally enable a recurring generation schedule. Set the Frequency (Weekly or Monthly), day, and time. Click + Add schedule to add multiple schedules.
    • Notifications — optionally enable Download report from notifications, enter a Recipient email address, select an Email template, and choose additional notification channels to receive alert notifications when a document generation succeeds or fails.
    • Review — a Summary of all settings is displayed. Click Preview document to preview the output, or click Generate to save the configuration and generate the document immediately.

Edit a configuration

Editing lets you update an existing configuration's settings without recreating it.

  1. Click the Actions menu next to the configuration you want to edit.
  2. Select Edit.
  3. Update any of the configuration's settings — name, description, document type, Service principal, subscriptions, branding, publish settings, schedule, or notification channels.
  4. Click Save changes.

Delete a configuration

Deleting a configuration permanently removes it and all its settings from Azure Documenter.

  1. Click the Actions menu next to the configuration you want to delete.
  2. Select Delete.
  3. Click Delete in the confirmation dialog.

Example scenario

A team lead needs a recurring Cost comparison report for two production subscriptions, delivered monthly. They click + New configuration, enter the name Monthly cost comparison – Production in the Basics step, select Cost comparison as the document type, and set the billing ranges. In the Service principal step, they select the Service principal and both subscriptions. In the Schedule step, they set up a monthly schedule on the first of the month. In the Notifications step, they add the team email so members are alerted when the report is ready. They click Generate in the Review step. Future runs happen automatically without any additional input.

Troubleshooting

  1. Subscriptions don't appear in the Service principal step
    Cause: The Service principal doesn't have Reader access to the target subscription, or the Service principal selected has no subscriptions assigned to it.
    Fix: Verify the Service principal has Reader access to the required subscriptions in the Azure portal. See Service principal setup.

  2. Can't edit a configuration's subscription selection
    Cause: You aren't assigned a role with sufficient access — Account owner, Owner, Contributor, or a custom role with the Documentation permission enabled.
    Fix: Confirm you're assigned the Account owner, Owner, or Contributor role, or a custom role with Documentation permission enabled, then retry the edit.

  3. Notification channel doesn't receive the completion alert
    Cause: The notification channel is misconfigured or the recipient email address is missing.
    Fix: Open the configuration for editing, navigate to the Notifications step, and verify the recipient email address and channel configuration.

FAQs

  1. Can I add multiple schedules to a single configuration?
    Yes. In the Schedule step, click + Add schedule to add multiple recurring schedules with different frequencies, days, and times — for example, a weekly report on Mondays and a monthly report on the first of the month.

  2. Who can edit the subscription selection on a configuration?
    Users with the Account owner, Owner, or Contributor role, or a custom role with the Documentation permission enabled, can edit the subscription selection.

Related articles