Overview
This template can be used to remove one or multiple files from SharePoint.
The match type selected greatly affects how this Template works.
Variables
|
Name |
Reference |
Type |
Required |
Default |
Options |
Description |
|---|---|---|---|---|---|---|
|
Client ID |
SHAREPOINT_CLIENT_ID |
Password |
✅ |
- |
- |
The Client ID of the app created in Azure |
|
Client Secret |
SHAREPOINT_CLIENT_SECRET |
Password |
✅ |
- |
- |
The secret value of the app created in Azure |
|
Tenant |
SHAREPOINT_TENANT |
Alphanumeric |
✅ |
- |
- |
The ID of the tenant associated with the app |
|
Site Name |
SHAREPOINT_SITE_NAME |
Alphanumeric |
✅ |
- |
- |
The name of the SharePoint Site |
|
Shipyard File Match Type |
SHAREPOINT_FILE_MATCH_TYPE |
Select |
✅ |
|
Exact Match: Regex Match: |
The match type used to identify files to load |
|
SharePoint Folder Name |
SHAREPOINT_FOLDER_NAME |
Alphanumeric |
➖ |
- |
- |
The optional name of the folder where the target file is located. If omitted, the file will be searched in the root directory |
|
SharePoint File Name |
SHAREPOINT_FILE_NAME |
Alphanumeric |
✅ |
- |
- |
The name of the file to remove from SharePoint |
YAML
Below is the YAML template for this Template and can be used in the Fleet YAML Editor.
source:
blueprint: Microsoft 365 SharePoint - Remove files from SharePoint
inputs:
SHAREPOINT_CLIENT_ID: null ## REQUIRED
SHAREPOINT_CLIENT_SECRET: null ## REQUIRED
SHAREPOINT_TENANT: null ## REQUIRED
SHAREPOINT_SITE_NAME: null ## REQUIRED
SHAREPOINT_FILE_MATCH_TYPE: exact_match ## REQUIRED
SHAREPOINT_FOLDER_NAME: null
SHAREPOINT_FILE_NAME: null ## REQUIRED
type: BLUEPRINT
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- '180'
- '181'
- '182'
- '183'
- '184'
- '200'
- '202'
- '203'
- '204'
- '205'
- '206'
- '207'
- '208'
- '209'
- '210'
- '249'