|
| 1 | +# Azure Sentinel Solution Creator V3 - Local Version |
| 2 | + |
| 3 | +## Overview |
| 4 | + |
| 5 | +This is a modified version of the `createSolutionV3.ps1` script that uses the version number from the current solution's data file instead of fetching it from the Microsoft catalog API. |
| 6 | + |
| 7 | +## Files |
| 8 | + |
| 9 | +- **`createSolutionV3_LocalVersion.ps1`** - Modified script that uses local version |
| 10 | +- **`createSolutionV3.ps1`** - Original script that uses Microsoft catalog API |
| 11 | +- **`README_LocalVersion.md`** - This documentation file |
| 12 | + |
| 13 | +## Key Differences |
| 14 | + |
| 15 | +### Original Script (`createSolutionV3.ps1`) |
| 16 | +- Calls `GetCatalogDetails()` to fetch solution details from Microsoft catalog API |
| 17 | +- Uses `GetPackageVersion()` to determine version based on catalog data |
| 18 | +- May increment version automatically based on published versions |
| 19 | +- Requires internet connectivity to Microsoft catalog API |
| 20 | + |
| 21 | +### Modified Script (`createSolutionV3_LocalVersion.ps1`) |
| 22 | +- Uses `GetLocalPackageVersion()` function instead of catalog API calls |
| 23 | +- Reads version directly from the solution's data file (`Version` field) |
| 24 | +- No internet connectivity required for version determination |
| 25 | +- No automatic version incrementation based on published versions |
| 26 | + |
| 27 | +## Usage |
| 28 | + |
| 29 | +### Command Line |
| 30 | +```powershell |
| 31 | +# Run with interactive prompt for path |
| 32 | +.\createSolutionV3_LocalVersion.ps1 |
| 33 | +
|
| 34 | +# Run with specified solution data folder path |
| 35 | +.\createSolutionV3_LocalVersion.ps1 -SolutionDataFolderPath "C:\path\to\solution\Data" |
| 36 | +
|
| 37 | +# Run with specific version bump type |
| 38 | +.\createSolutionV3_LocalVersion.ps1 -SolutionDataFolderPath "C:\path\to\solution\Data" -VersionBump "minor" |
| 39 | +``` |
| 40 | + |
| 41 | +### Examples |
| 42 | +```powershell |
| 43 | +# Patch version bump (default): 3.1.8 -> 3.1.9 |
| 44 | +.\createSolutionV3_LocalVersion.ps1 -SolutionDataFolderPath "C:\Users\fuqingwang\repos\Azure-Sentinel\Solutions\CrowdStrike Falcon Endpoint Protection\Data" |
| 45 | +
|
| 46 | +# Minor version bump: 3.1.8 -> 3.2.0 |
| 47 | +.\createSolutionV3_LocalVersion.ps1 -SolutionDataFolderPath "C:\Users\fuqingwang\repos\Azure-Sentinel\Solutions\CrowdStrike Falcon Endpoint Protection\Data" -VersionBump "minor" |
| 48 | +
|
| 49 | +# Major version bump: 3.1.8 -> 4.0.0 |
| 50 | +.\createSolutionV3_LocalVersion.ps1 -SolutionDataFolderPath "C:\Users\fuqingwang\repos\Azure-Sentinel\Solutions\CrowdStrike Falcon Endpoint Protection\Data" -VersionBump "major" |
| 51 | +``` |
0 commit comments