Personalización de implementaciones de repositorios

Hay dos formas principales de personalizar el despliegue del contenido de su repositorio en las áreas de trabajo de Microsoft Sentinel. Cada método usa diferentes archivos y sintaxis, por lo que considere estos ejemplos para empezar. Antes de comenzar, asegúrese de que se cumplen los requisitos previos de implementación y conexión del repositorio necesarios.

Requisitos previos

Para personalizar una implementación de repositorio, necesita una conexión de repositorio existente. Para crear uno, consulte Implementación de contenido personalizado desde el repositorio. Después de crear la conexión, asegúrese de cumplir estos requisitos:

• Acceso del colaborador al repositorio de GitHub o al acceso del administrador de proyectos al repositorio de DevOps de Azure
• Acciones habilitadas para GitHub y canalizaciones habilitadas para Azure DevOps
• Asegúrese de que los archivos de contenido personalizados que desea implementar en las áreas de trabajo están en un formato compatible. Para ver los formatos admitidos, consulte Planear el contenido del repositorio.

Para obtener más información sobre los tipos de contenido que se pueden implementar, vea Planear el contenido del repositorio.

Personalización del flujo de trabajo o la canalización

El flujo de trabajo predeterminado solo implementa el contenido modificado desde la última implementación, en función de las confirmaciones en el repositorio. Personaliza el flujo de trabajo o la canalización para configurar diferentes desencadenantes de despliegue, o para desplegar contenido exclusivamente desde una carpeta raíz específica.

Seleccione una de las pestañas siguientes en función del tipo de conexión:

Escalado de las implementaciones con archivos de parámetros

En lugar de pasar parámetros como valores insertados en los archivos de contenido, considere la posibilidad de usar un archivo de parámetros de Bicep o un archivo JSON que contenga los valores de parámetro. A continuación, asigne esos archivos de parámetros a sus archivos de contenido Microsoft Sentinel asociados para escalar mejor las implementaciones en diferentes áreas de trabajo.

Hay varias maneras de asignar archivos de parámetros a los archivos de contenido. Tenga en cuenta que los archivos de parámetros de Bicep solo admiten plantillas de archivo de Bicep, pero los archivos de parámetros JSON admiten ambos. La canalización de implementación de repositorios tiene en cuenta los archivos de parámetros en el orden siguiente:

1. ¿Hay un mapeo en sentinel-deployment.config?
   Para obtener más información, consulte Personalice la configuración de la conexión.

2. ¿Hay un archivo de parámetros asignado al área de trabajo? Sí, los archivos de contenido están en el mismo directorio, con un archivo de parámetros asignado al área de trabajo que coincida con uno de estos patrones:
   .<WorkspaceID>.bicepparam
   .parameters-<WorkspaceID>.json

3. ¿Hay un archivo de parámetros predeterminado? Sí, los archivos de contenido están en el mismo directorio con un archivo de parámetros que coincide con uno de estos patrones:
   .bicepparam
   .parameters.json

Para evitar conflictos con despliegues de varios espacios de trabajo, asocie los archivos de parámetros mediante el archivo de configuración o especifique el identificador del espacio de trabajo en el nombre del archivo.

La modificación del archivo de parámetros asignado que se muestra en sentinel-deployment.config desencadena la implementación de su archivo de contenido emparejado. Agregar o modificar un archivo de parámetros asignado al área de trabajo o un archivo de parámetros predeterminado también desencadena una implementación de los archivos de contenido emparejados junto con los parámetros recién modificados, a menos que se haya implementado una asignación de parámetros de prioridad superior. Otros archivos de contenido no se implementan siempre que la característica de implementaciones inteligentes siga estando habilitada en el archivo de definición de flujo de trabajo o canalización.

Personalización de la configuración de conexión

El script de implementación para repositorios admite el uso de un archivo de configuración de implementación para cada rama de repositorio a partir de julio de 2022. El archivo JSON de configuración le ayuda a asignar archivos de parámetros a archivos de contenido pertinentes, priorizar contenido específico en implementaciones y excluir contenido específico de las implementaciones.

1. Cree el archivo sentinel-deployment.config en la raíz de su repositorio.

   

2. Incluya el contenido estructurado en tres secciones opcionales, "prioritizedcontentfiles":, "excludecontentfiles":y "parameterfilemappings":. Si no se incluye ninguna sección o se omite el archivo .config, el proceso de implementación sigue ejecutándose. Se omiten las secciones no válidas o no reconocidas.

Este es un ejemplo del contenido completo de un archivo sentinel-deployment.config válido. Este ejemplo también puede encontrarse en el ejemplo de repositorios de CI/CD de Microsoft Sentinel.

{
  "prioritizedcontentfiles": [
    "parsers/Sample/ASimAuthenticationAWSCloudTrail.json",
    "workbooks/sample/TrendMicroDeepSecurityAttackActivity_ARM.json",
    "Playbooks/PaloAlto-PAN-OS/PaloAltoCustomConnector/azuredeploy.bicep"
  ], 
  "excludecontentfiles": [
     "Detections/Sample/PaloAlto-PortScanning.json",
     "parameters"
  ],
  "parameterfilemappings": {
    "879001c8-2181-4374-be7d-72e5dc69bd2b": {
      "Playbooks/PaloAlto-PAN-OS/Playbooks/PaloAlto-PAN-OS-BlockIP/azuredeploy.bicep": "parameters/samples/auzredeploy.bicepparam"
    },
    "9af71571-7181-4cef-992e-ef3f61506b4e": {
      "Playbooks/Enrich-SentinelIncident-GreyNoiseCommunity-IP/azuredeploy.json": "path/to/any-parameter-file.json"
    }
  },
  "DummySection": "This shouldn't impact deployment"
}

• Para priorizar los archivos de contenido:

  A medida que aumenta la cantidad de contenido del repositorio, los tiempos de implementación pueden aumentar. Agregue contenido sensible al tiempo a esta sección para priorizar su implementación cuando se produzca un desencadenador.

  Agregue nombres de ruta completos a la sección "prioritizedcontentfiles":. No se admite la coincidencia de caracteres comodín en este momento.

• Para excluir archivos de contenido, modifica la "excludecontentfiles": sección con los nombres completos de rutas de los archivos de contenido individuales .json.

• Para mapear los parámetros:

  El script de implementación acepta tres métodos de parámetros de asignación (asignaciones de archivos de configuración, archivos de parámetros asignados al área de trabajo y archivos de parámetros predeterminados), como se describe en Escalado de las implementaciones con archivos de parámetros. La asignación de parámetros a través de la sentinel-deployment.config tiene la prioridad más alta y garantiza que un archivo de parámetros determinado se asigna a sus archivos de contenido asociados. Modifique la sección "parameterfilemappings": con el ID del área de trabajo de la conexión de destino y las rutas de acceso completas de los archivos .json individuales.

Contenido relacionado

• Ejemplo de repositorios CICD de Microsoft Sentinel.
• Descripción de la estructura y la sintaxis de los archivos de Bicep
• Parámetros en Bicep
• Crear archivo de parámetros de Resource Manager
• Parámetros en plantillas de ARM