You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/sentinel/ci-cd-custom-deploy.md
+13-12Lines changed: 13 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -164,21 +164,21 @@ For more information, see the [Azure DevOps documentation](/azure/devops/pipelin
164
164
165
165
## Scale your deployments with parameter files
166
166
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:
168
168
169
169
:::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.":::
170
170
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*
174
174
175
175
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.
176
176
177
177
> [!IMPORTANT]
178
178
> Once a parameter file match is determined based on the mapping precedence, the pipeline ignores any remaining mappings.
179
179
>
180
180
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.
182
182
183
183
Examples of workspace-mapped parameter files:
184
184
- *.\<WorkspaceID>.bicepparam*
@@ -197,24 +197,24 @@ The deployment script for repositories supports the usage of a deployment config
197
197
198
198
:::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":::
199
199
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.
201
201
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).
@@ -238,14 +238,15 @@ Here's an example of the entire contents of a valid *sentinel-deployment.config*
238
238
239
239
- **To map parameters**:
240
240
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.
242
242
243
243
244
244
## Related content
245
245
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).
247
247
248
248
- [Understand the structure and syntax of Bicep files](../azure-resource-manager/bicep/file.md)
249
+
- [Parameters in Bicep](../azure-resource-manager/bicep/parameters.md)
0 commit comments