6c989dbd78
New script for OneDrive and Sharepoint cleanup Commit by commit review is encouraged for readability since this involves renames of older scripts. --- #### Does this PR need a docs update or release note? - [ ] ✅ Yes, it's included - [ ] 🕐 Yes, but in a later PR - [x] ⛔ No #### Type of change <!--- Please check the type of change your PR introduces: ---> - [ ] 🌻 Feature - [ ] 🐛 Bugfix - [ ] 🗺️ Documentation - [ ] 🤖 Test - [x] 💻 CI/Deployment - [ ] 🧹 Tech Debt/Cleanup #### Issue(s) #### Test Plan <!-- How will this be tested prior to merging.--> - [x] 💪 Manual - [ ] ⚡ Unit test - [ ] 💚 E2E Tested this with `nektos/act `so action logic should be mostly sound. There is one issue with the script installed for exchange that I believe is just a difference the container image used by GHA and the local I could use for `act`
72 lines
3.0 KiB
YAML
72 lines
3.0 KiB
YAML
name: Purge M365 User Data
|
|
|
|
# Hard deletion of an m365 user's data. Our CI processes create a lot
|
|
# of data churn (creation and immediate deletion) of files, the likes
|
|
# of which wouldn't otherwise be seen by users of the system. Standard
|
|
# APIs don't have the tooling to gut out all the cruft which we accrue
|
|
# in microsoft's hidden nooks and secret crannies. A manual, SOAPy
|
|
# exorcism is the only way.
|
|
#
|
|
# The script focuses on the cleaning up the following:
|
|
# * All folders, descending from the exchange root, of a given prefix.
|
|
# * All folders in PersonMetadata
|
|
# * All already soft-deleted items
|
|
# * All folders under recoverable items
|
|
|
|
inputs:
|
|
user:
|
|
description: User whose data is to be purged.
|
|
site:
|
|
description: Sharepoint site where data is to be purged.
|
|
folder-prefix:
|
|
description: Name of the folder to be purged. If falsy, will purge the set of static, well known folders instead.
|
|
older-than:
|
|
description: Minimum-age of folders to be deleted.
|
|
azure-client-id:
|
|
description: Secret value of for AZURE_CLIENT_ID
|
|
azure-client-secret:
|
|
description: Secret value of for AZURE_CLIENT_SECRET
|
|
azure-tenant-id:
|
|
description: Secret value of for AZURE_TENANT_ID
|
|
m365-admin-user:
|
|
description: Secret value of for M365_TENANT_ADMIN_USER
|
|
m365-admin-password:
|
|
description: Secret value of for M365_TENANT_ADMIN_PASSWORD
|
|
|
|
runs:
|
|
using: composite
|
|
steps:
|
|
- name: Run the all Exchange amd OneDrive purge scripts for user
|
|
if: ${{ inputs.user != '' }}
|
|
shell: pwsh
|
|
working-directory: ./src/cmd/purge/scripts
|
|
env:
|
|
AZURE_CLIENT_ID: ${{ inputs.azure-client-id }}
|
|
AZURE_CLIENT_SECRET: ${{ inputs.azure-client-secret }}
|
|
AZURE_TENANT_ID: ${{ inputs.azure-tenant-id }}
|
|
M365_TENANT_ADMIN_USER: ${{ inputs.m365-admin-user }}
|
|
M365_TENANT_ADMIN_PASSWORD: ${{ inputs.m365-admin-password }}
|
|
run: |
|
|
./exchangePurge.ps1 -User ${{ inputs.user }} -FolderNamePurgeList PersonMetadata -FolderPrefixPurgeList ${{ inputs.folder-prefix }} -PurgeBeforeTimestamp ${{ inputs.older-than }}
|
|
./onedrivePurge.ps1 -User ${{ inputs.user }} -FolderPrefixPurgeList ${{ inputs.folder-prefix }} -PurgeBeforeTimestamp ${{ inputs.older-than }}
|
|
|
|
- name: Run SharePoint purge script
|
|
if: ${{ inputs.user == '' }}
|
|
shell: pwsh
|
|
working-directory: ./src/cmd/purge/scripts
|
|
env:
|
|
M365_TENANT_ADMIN_USER: ${{ inputs.m365-admin-user }}
|
|
M365_TENANT_ADMIN_PASSWORD: ${{ inputs.m365-admin-password }}
|
|
run: |
|
|
./onedrivePurge.ps1 -Site ${{ inputs.site }} -FolderPrefixPurgeList ${{ inputs.folder-prefix }} -PurgeBeforeTimestamp ${{ inputs.older-than }}
|
|
|
|
- name: Reset retention for all mailboxes to 0
|
|
if: ${{ inputs.user == '' }}
|
|
shell: pwsh
|
|
working-directory: ./src/cmd/purge/scripts
|
|
env:
|
|
M365_TENANT_ADMIN_USER: ${{ inputs.m365-admin-user }}
|
|
M365_TENANT_ADMIN_PASSWORD: ${{ inputs.m365-admin-password }}
|
|
run: |
|
|
./exchangeRetention.ps1
|