Skip to content

Commit 3681865

Browse files
clarify bicep param file support
1 parent 8d0f42d commit 3681865

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

articles/sentinel/ci-cd-custom-deploy.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -164,21 +164,21 @@ For more information, see the [Azure DevOps documentation](/azure/devops/pipelin
164164
165165
## Scale your deployments with parameter files
166166
167-
Rather than passing parameters as inline values in your content files, consider [using a Bicep parameter file](../azure-resource-manager/bicep/parameter-files.md) or a [JSON file that contains the parameter values](../azure-resource-manager/templates/parameter-files.md). Then map those parameter files to their associated Sentinel content files to better scale your deployments across different workspaces. There are several ways to map parameter files to Sentinel files, and the repositories deployment pipeline considers them in the following order:
167+
Rather than passing parameters as inline values in your content files, consider [using a Bicep parameter file](../azure-resource-manager/bicep/parameter-files.md) or a [JSON file that contains the parameter values](../azure-resource-manager/templates/parameter-files.md). Then map those parameter files to their associated Microsoft Sentinel content files to better scale your deployments across different workspaces. Bicep parameter files only support Bicep file templates, and JSON parameter files only support JSON ARM templates. There are several ways to map parameter files to the content files, and the repositories deployment pipeline considers them in the following order:
168168
169169
:::image type="content" source="media/ci-cd-custom-deploy/deploy-parameter-file-precedence-with-bicep.svg" alt-text="A diagram showing the precedence of parameter file mappings.":::
170170
171-
1. Is there a mapping in the *sentinel-deployment.config*? For more information, see [Customize your connection configuration](ci-cd-custom-deploy.md#customize-your-connection-configuration).
172-
1. Is there a workspace-mapped parameter file? Yes, it's a parameter file in the same directory as the content files that ends with *.\<WorkspaceID>.bicepparam* or *.parameters-\<WorkspaceID>.json*
173-
1. Is there a default parameter file? Yes, any parameter file in the same directory as the content files that ends with *.bicepparam* or *.parameters.json*
171+
1. Is there a mapping in the *sentinel-deployment.config*?</br>For more information, see [Customize your connection configuration](ci-cd-custom-deploy.md#customize-your-connection-configuration).
172+
1. Is there a workspace-mapped parameter file?</br>Yes, it's a parameter file in the same directory as the content files that ends with *.\<WorkspaceID>.bicepparam* or *.parameters-\<WorkspaceID>.json*
173+
1. Is there a default parameter file?</br>Yes, any parameter file in the same directory as the content files that ends with *.bicepparam* or *.parameters.json*
174174
175175
It's encouraged to map your parameter files through the configuration file or by specifying the workspace ID in the file name to avoid clashes in scenarios with multiple deployments.
176176
177177
> [!IMPORTANT]
178178
> Once a parameter file match is determined based on the mapping precedence, the pipeline ignores any remaining mappings.
179179
>
180180
181-
Modifying the mapped parameter file listed in the sentinel-deployment.config triggers the deployment of its paired content file. Adding or modifying a workspace-mapped parameter file or a default parameter file also triggers a deployment of the paired content files along with the newly modified parameters, unless a higher precedence parameter mappings is in place. Other content files aren't deployed as long as the smart deployments feature is still enabled in the workflow/pipeline definition file.
181+
Modifying the mapped parameter file listed in the *sentinel-deployment.config* triggers the deployment of its paired content file. Adding or modifying a workspace-mapped parameter file or a default parameter file also triggers a deployment of the paired content files along with the newly modified parameters, unless a higher precedence parameter mappings is in place. Other content files aren't deployed as long as the smart deployments feature is still enabled in the workflow/pipeline definition file.
182182
183183
Examples of workspace-mapped parameter files:
184184
- *.\<WorkspaceID>.bicepparam*
@@ -197,24 +197,24 @@ The deployment script for repositories supports the usage of a deployment config
197197
198198
:::image type="content" source="media/ci-cd-custom-deploy/deployment-config.png" alt-text="Screenshot of a repository root directory. The RepositoriesSampleContent is shown with the location of the sentinel-deployment.config file." lightbox="media/ci-cd-custom-deploy/deployment-config.png":::
199199
200-
1. Include JSON structured content in three optional sections, `"prioritizedcontentfiles":`, `"excludecontentfiles":`, and `"parameterfilemappings":`. If no sections are included or the .config file is omitted, the deployment process still runs. Invalid or unrecognized sections are ignored.
200+
1. Include your structured content in three optional sections, `"prioritizedcontentfiles":`, `"excludecontentfiles":`, and `"parameterfilemappings":`. If no sections are included or the .config file is omitted, the deployment process still runs. Invalid or unrecognized sections are ignored.
201201

202-
Here's an example of the entire contents of a valid *sentinel-deployment.config* file. This sample can also be found at the [Sentinel CICD repositories sample](https://github.com/SentinelCICD/RepositoriesSampleContent).
202+
Here's an example of the entire contents of a valid *sentinel-deployment.config* file. This sample can also be found at the [Microsoft Sentinel CICD repositories sample](https://github.com/SentinelCICD/RepositoriesSampleContent).
203203

204204
```json
205205
{
206206
"prioritizedcontentfiles": [
207207
"parsers/Sample/ASimAuthenticationAWSCloudTrail.json",
208208
"workbooks/sample/TrendMicroDeepSecurityAttackActivity_ARM.json",
209-
"Playbooks/PaloAlto-PAN-OS/PaloAltoCustomConnector/azuredeploy.json"
209+
"Playbooks/PaloAlto-PAN-OS/PaloAltoCustomConnector/azuredeploy.bicep"
210210
],
211211
"excludecontentfiles": [
212212
"Detections/Sample/PaloAlto-PortScanning.json",
213213
"parameters"
214214
],
215215
"parameterfilemappings": {
216216
"879001c8-2181-4374-be7d-72e5dc69bd2b": {
217-
"Playbooks/PaloAlto-PAN-OS/Playbooks/PaloAlto-PAN-OS-BlockIP/azuredeploy.json": "parameters/samples/parameter-file-1.json"
217+
"Playbooks/PaloAlto-PAN-OS/Playbooks/PaloAlto-PAN-OS-BlockIP/azuredeploy.bicep": "parameters/samples/auzredeploy.bicepparam"
218218
},
219219
"9af71571-7181-4cef-992e-ef3f61506b4e": {
220220
"Playbooks/Enrich-SentinelIncident-GreyNoiseCommunity-IP/azuredeploy.json": "path/to/any-parameter-file.json"
@@ -238,14 +238,15 @@ Here's an example of the entire contents of a valid *sentinel-deployment.config*
238238

239239
- **To map parameters**:
240240

241-
The deployment script accepts three methods of mapping parameters as described in [Scale your deployments with parameter files](ci-cd-custom-deploy.md#scale-your-deployments-with-parameter-files). Mapping parameters through the sentinel-deployment.config takes the highest precedence and guarantees that a given parameter file is mapped to its associated content files. Modify the `"parameterfilemappings":` section with your target connection's workspace ID and full path names of individual .json files.
241+
The deployment script accepts three methods of mapping parameters as described in [Scale your deployments with parameter files](ci-cd-custom-deploy.md#scale-your-deployments-with-parameter-files). Mapping parameters through the *sentinel-deployment.config* takes the highest precedence and guarantees that a given parameter file is mapped to its associated content files. Modify the `"parameterfilemappings":` section with your target connection's workspace ID and full path names of individual .json files.
242242

243243

244244
## Related content
245245

246-
A sample repository is available demonstrating the deployment config file and all three parameter mapping methods. For more information, see [Sentinel CICD repositories sample](https://github.com/SentinelCICD/RepositoriesSampleContent).
246+
A sample repository is available demonstrating the deployment config file and all three parameter mapping methods. For more information, see [Microsoft Sentinel CICD repositories sample](https://github.com/SentinelCICD/RepositoriesSampleContent).
247247

248248
- [Understand the structure and syntax of Bicep files](../azure-resource-manager/bicep/file.md)
249+
- [Parameters in Bicep](../azure-resource-manager/bicep/parameters.md)
249250
- [Create Resource Manager parameter file](../azure-resource-manager/templates/parameter-files.md)
250251
- [Parameters in ARM templates](../azure-resource-manager/templates/parameters.md)
251-
- [Parameters in Bicep](../azure-resource-manager/bicep/parameters.md)
252+

0 commit comments

Comments
 (0)