IntuneCD 1.0.9

Tool to backup and update configurations in Intune

IntuneCD tool

IntuneCD or, Intune Continuous Delivery as it stands for is a Python package that is used to backup and update configurations in Intune. It was created with running it from a pipeline in mind. Using this approach we get complete history of which configurations has been changed and what setting has been changed.

The main function is to back up configurations from Intune to a Git repositry from a DEV environment and if any configurations has changed, push them to PROD Intune environment.

The package can also be run standalone outside of a pipeline, or in one to only backup data. Since 1.0.4, configurations are also created if they cannot be found. This means this tool could be used in a tenant to tenant migration scenario as well.

Whats new in 1.0.9

• Bug fix where the script exited with "local variable referenced before assignment" if a management intent does not exist
• Added a new parameter to let you exclude assignments from backups. To exclude assignments from backup, you can now use -e assignments when running IntuneCD-startbackup.

Whats new in 1.0.8

Main focus for this release has been to improve the performance as large setups can take a while to backup/update. With these enhancements, I was able to cut the run time by 80% in most cases

• Added module to use MS Graph batching to get assignments instead on getting them for each configuration individually
• General code clean up
• Added new module for getting and updating assignments, the old one was quite messy
• For some configurations, additional information is appended to the filename, this is because there might be configurations with the same name
  • App Configurations (appends odata type)
  • App Protections (appends management type for ios/android and odata type for windows)
  • Applications (for Windows it now appends the app type e.g. Win32 and version)
  • Compliance (appends odata type)
  • Profiles (appends odata type)
• All configurations are now requested from the start and matched in script with displayName and/or odata type instead of requesting each configuration based on displayName
• Management intents are now batched using the new batching module
• Assignments are now batched using the new batching module
• If 504 or 502 is encounterd while getting configurations, the tool will now try again to get the configuration
• For Windows apps in documentation, detection scripts etc will now have a "Click to expand..." instead of showing the whole script

Whats new in 1.0.7

• Added backup and documentation of Apple Push Notification configuration
• Added backup and documentation of Apple Volume Purchase Program tokens
• Added backup and documentation of Applications
• Added backup and documentation of Managed Google Play Configuration
• Added backup and documentation of Partner Connections (Compliance, Management and Remote Assistance)
• Added backup, documentation and update module for Proactive Remediations
• Added a new option to the documentation module, '-i', which lets you configure your own introduction that will be displayed at the top
• Changed documentation to display a collapsible view of long strings, now you can see the whole script payload for example
• Improved console output when changes are detected, instead of writing the full path to the key, old output: Setting: 'PayloadContent'][0]['PayloadContent']['corp.sap.privileges']['Forced'][0]['mcx_preference_settings']['ReasonMinLength', New Value: 15, Old Value: 20, new output: Setting: 'ReasonMinLength', New Value: 15, Old Value: 20

Install this package

pip install IntuneCD

Update this package

pip install IntuneCD --upgrade

What is backed up?

• Apple Push Notification
• Apple Volume Purchase Program tokens
• Application Configuration Policies
  • Including assignments
• Application Protection Policies
  • Including assignments
• Applications
  • Including assignments
• Compliance Policies
  • Including assignments
• Device Configurations
  • Including assignments
  • For custom macOS and iOS configurations, mobileconfigs are backed up
• Enrollment profiles
  • Apple Business Manager
  • Windows Autopilot
    • Including assignments
• Endpoint Security
  • Including assignments
  • Security Baselines
  • Antivirus
  • Disk Encryption
  • Firewall
  • Endpoint Detection and Response
  • Attack Surface Reduction
  • Account Protection
• Filters
• Managed Google Play
• Notification Templates
• Proactive Remediations
  • Including assignments
• Partner Connections
  • Compliance
  • Management
  • Remote Assistance
• Scripts
  • Including assignments
  • Powershell
  • Shell
• Settings Catalog Policies
  • Including assignments

What can be updated?

Well... most of the above ;)

• Application Configuration Policies
  • Including assignments
• Application Protection Policies
  • Including assignments
• Compliance Policies
  • Including assignments
• Device Configurations
  • Including assignments
  • Including custom macOS/iOS .mobileconfigs and custom Windows profiles
• Enrollment profiles
  • Apple Business Manager
  • Windows Autopilot
    • Including assignments
• Endpoint Security
  • Including assignments
  • Security Baselines
  • Antivirus
  • Disk Encryption
  • Firewall
  • Endpoint Detection and Response
  • Attack Surface Reduction
  • Account Protection
• Filters
• Notification Templates
• Proactive Remediations
  • Including assignments
• Scripts
  • Including assignments
  • Powershell
  • Shell
• Settings Catalog Policies
  • Including assignments

What can be created?

If the configuration the script is looking for cannot be found, it will create it. Supported configurations for creation are:

• Application Configuration Policies
  • Including assignments
• Application Protection Policies
  • Including assignments
• Compliance Policies
  • Including assignments
• Device Configurations
  • Including assignments
  • Including custom macOS/iOS .mobileconfigs and custom Windows profiles
• Endpoint Security
  • Including assignments
  • Security Baselines
  • Antivirus
  • Disk Encryption
  • Firewall
  • Endpoint Detection and Response
  • Attack Surface Reduction
  • Account Protection
• Filters
• Notification Templates
• Proactive Remediations
  • Including assignments
• Scripts
  • Including assignments
  • Powershell
  • Shell
• Settings Catalog Policies
  • Including assignments

Required Azure AD application Graph API permissions

• DeviceManagementApps.ReadWrite.All
• DeviceManagementConfiguration.ReadWrite.All
• DeviceManagementServiceConfig.ReadWrite.All
• Group.Read.All

If you just want to backup you can get away with only Read permission (except for DeviceManagementConfiguration)!

How do I use it?

You have two options, using a pipeline or running it locally. Let's have a look at both.

Parameters

To see which parameters you have to provide just type: IntuneCD-startbackup --help, IntuneCD-startupdate --help or IntuneCD-startdocumentation --help

Example options:

• -h, --help show this help message and exit
• -o OUTPUT, --output=OUTPUT
  • The format backups will be saved as, valid options are json or yaml. Default is json
• -p PATH, --path=PATH
  • The path to which the configurations will be saved. Default value is $(Build.SourcesDirectory)
• -m MODE, --mode=MODE
  • The mode in which the script is run, 0 = devtoprod (backup from dev -> update to prod) uses os.environ DEV_TENANT_NAME, DEV_CLIENT_ID, DEV_CLIENT_SECRET, 1 = standalone (backup from prod) uses os.environ TENANT_NAME, CLIENT_ID, CLIENT_SECRET
• -a LOCALAUTH, --localauth=LOCALAUTH
  • When this paramater is set, provide a path to a local json file containing the following keys: params:TENANT_NAME, CLIENT_ID, CLIENT_SECRET when run in standalone mode and params:DEV_TENANT_NAME, DEV_CLIENT_ID, DEV_CLIENT_SECRET when run in devtoprod

For IntuneCD-startupdate 1.0.4 the -u parameter has been added which, if set, updates assignments for existing configurations. Again the groups are matched with displayName, so they must be the same in both tenants.

Run locally

First install the package using pip, then you must create a json which contains authentication parameters in the following format:

{
    "params":{
        "TENANT_NAME": "",
        "CLIENT_ID": "",
        "CLIENT_SECRET": ""
    }
}

When you have created the json, you can now run these commands

IntuneCD-startbackup -m 1 -o yaml -p /path/to/save/in -a /path/to/auth.json/

If you run without the -m parameter, make sure you have one auth.json pointing to DEV and another pointing to PROD, example:

{
    "params":{
        "DEV_TENANT_NAME": "",
        "DEV_CLIENT_ID": "",
        "DEV_CLIENT_SECRET": ""
    }
}

{
    "params":{
        "PROD_TENANT_NAME": "",
        "PROD_CLIENT_ID": "",
        "PROD_CLIENT_SECRET": ""
    }
}

IntuneCD-startbackup -o yaml -p /path/to/save/in -a /path/to/auth_DEV.json/

IntuneCD-startupdate -p /path/to/save/in -a /path/to/auth_PROD.json/

Run from a pipeline

I have tested this with Azure DevOps which is what I will give an example to. But it could just as well be run using GitHub Actions.

In the example pipeline below I'm running with the parameters -m 1 (standalone mode) and -o yaml (output configurations in yaml format). If you are running this in DEV -> PROD mode, remove -m and add DEV_ in front of all env: variables except for REPO_DIR. CLIENT_SECRET should be added as a secret variable.

DEV env variables:

  env:
    REPO_DIR: $(REPO_DIR)
    DEV_TENANT_NAME: $(TENANT_NAME)
    DEV_CLIENT_ID: $(CLIENT_ID)
    DEV_CLIENT_SECRET: $(CLIENT_SECRET)

Example backup pipeline:

pool:
  vmImage: ubuntu-latest

variables:
  REPO_DIR: $(Build.SourcesDirectory)
  TENANT_NAME: example.onmicrosoft.com
  CLIENT_ID: xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxxxxx

steps:

- checkout: self
  persistCredentials: true

- script: pip3 install IntuneCD
  displayName: Install IntuneCD

- script: |
      git config --global user.name "devopspipeline"
      git config --global user.email "[e-mail]"
  displayName: Configure Git

- script: IntuneCD-startbackup -m 1 -o yaml
  env:
    REPO_DIR: $(REPO_DIR)
    TENANT_NAME: $(TENANT_NAME)
    CLIENT_ID: $(CLIENT_ID)
    CLIENT_SECRET: $(CLIENT_SECRET)
  displayName: Run IntuneCD backup

- script: |
    cd $(REPO_DIR)
    git add --all
    git commit -m "Updated configurations"
    git push origin HEAD:main
  displayName: Commit changes

The following shows a pipeline which updates configurations in Intune. Again I'm running with -m 1. If this should update PROD, add PROD_ in front of all env: variables except REPO_DIR. CLIENT_SECRET should be added as a secret variable.

PROD env variables:

  env:
    REPO_DIR: $(REPO_DIR)
    PROD_TENANT_NAME: $(TENANT_NAME)
    PROD_CLIENT_ID: $(CLIENT_ID)
    PROD_CLIENT_SECRET: $(CLIENT_SECRET)

Example update pipeline:

pool:
  vmImage: ubuntu-latest

variables:
  REPO_DIR: $(Build.SourcesDirectory)
  TENANT_NAME: example.onmicrosoft.com
  CLIENT_ID: xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxxxxx

steps:

- checkout: self
  persistCredentials: true

- script: pip3 install IntuneCD
  displayName: Install IntuneCD

- script: IntuneCD-startupdate -m 1
  env:
    REPO_DIR: $(REPO_DIR)
    TENANT_NAME: $(TENANT_NAME)
    CLIENT_ID: $(CLIENT_ID)
    CLIENT_SECRET: $(CLIENT_SECRET)
  displayName: Run update

Run documentation locally

To create a markdown document from the backup files, run this command

IntuneCD-startdocumentation -p /path/to/backup/directory -o /path/to/create/markdown.md -t nameoftenant -i 'This is a demo introduction'

Run documentation in a pipeline

This step should be added to the backup pipeline to make sure the markdown document is updated when configurations changes. By default it writes to the README.md file in the repo, you can change this with the -o option

- script: IntuneCD-startdocumentation -t $(TENANT_NAME) -i 'This is a demo introduction'
  env:
    REPO_DIR: $(REPO_DIR)
  displayName: Run IntuneCD documentation

Good to know

When this tool tries to update configurations, it matches the displayname. Therefore the displayname from DEV must match in PROD.

Current known limitations

Updating Windows Update Rings configurations is currently not supported, the tool can however create update rings if they don't exist.