リポジトリのデプロイをカスタマイズする (パブリックプレビュー)

適用対象: Microsoft Sentinel in the Microsoft Defender portal, Microsoft Sentinel in the Azure portal

リポジトリコンテンツのデプロイをワークスペースにMicrosoft Sentinelするには、主に 2 つの方法があります。各メソッドは異なるファイルと構文を使用するため、これらの例を検討して作業を開始します。

カスタマイズ方法	対象となるデプロイオプション
GitHub ワークフロー DevOps パイプライン	接続のデプロイトリガーをカスタマイズするデプロイパスをカスタマイズするスマートデプロイの有効化
構成ファイル	コンテンツ展開の優先順位付け順序を制御する展開から特定のコンテンツファイルを除外することを選択しますパラメーターファイルを特定のコンテンツファイルにマッピングして、異なるワークスペース間でデプロイをスケーリングする

重要

Microsoft Sentinel リポジトリ機能は現在プレビュー段階です。ベータ版、プレビュー版、または一般公開されていないAzure機能に適用されるその他の法的条件については、「Microsoft Azure プレビューの補足使用条件」を参照してください。

前提条件

リポジトリのデプロイをカスタマイズするには、リポジトリ接続が存在する必要があります。接続の作成の詳細については、「リポジトリからカスタムコンテンツをデプロイする」を参照してください。接続が確立されると、次の前提条件が適用されます。

GitHub リポジトリへのコラボレーターアクセスまたはプロジェクト管理者がAzure DevOps リポジトリにアクセスする
Azure DevOps で有効になっている GitHub とパイプラインに対して有効なアクション
ワークスペースにデプロイするカスタムコンテンツファイルがサポートされている形式であることを確認します。サポートされている形式については、「リポジトリコンテンツを計画する」を参照してください。

デプロイ可能なコンテンツタイプの詳細については、「リポジトリコンテンツを計画する」を参照してください。

ワークフローまたはパイプラインをカスタマイズする

既定のワークフローでは、リポジトリへのコミットに基づいて、前回のデプロイ以降に変更されたコンテンツのみがデプロイされます。さまざまなデプロイトリガーを構成したり、特定のルートフォルダーから排他的にコンテンツを展開したりするようにカスタマイズします。

接続の種類に応じて、次のいずれかのタブを選択します。

GitHub
Azure DevOps

GitHub デプロイワークフローをカスタマイズするには:

GitHub で、リポジトリに移動し、 .github/workflows ディレクトリでワークフローを見つけます。

ワークフローファイルは、 sentinel-deploy-xxxxx.yml以降の YML ファイルです。そのファイルを開き、ワークフロー名が最初の行に表示され、次の既定の名前付け規則があります: Deploy Content to <workspace-name> [<deployment-id>]。

例: name: Deploy Content to repositories-demo [xxxxx-dk5d-3s94-4829-9xvnc7391v83a]
ページの右上にある鉛筆ボタンを選択して編集用のファイルを開き、次のようにデプロイを変更します。
- デプロイトリガーを変更するには、コード内の on セクションを更新します。このセクションでは、ワークフローを実行するようにトリガーするイベントについて説明します。
  
  既定では、この構成は on: push に設定されています。これは、既存のコンテンツへの変更とリポジトリへの新しいコンテンツの追加の両方を含む、接続されたブランチへの任意のプッシュでワークフローがトリガーされることを意味します。例:
```
on:
    push:
        branches: [ main ]
        paths:
        - `**`
        - `!.github/workflows/**` # this filter prevents other workflow changes from triggering this workflow
        - `.github/workflows/sentinel-deploy-<deployment-id>.yml`
```
  これらの設定を変更します。たとえば、ワークフローを定期的に実行するようにスケジュールしたり、異なるワークフローイベントを組み合わせたりします。
  
  詳細については、ワークフローイベントの構成に関する GitHub ドキュメントを参照してください。
- スマートデプロイを無効にするには:スマートデプロイの動作は、説明されているデプロイトリガーとは別です。ワークフローの [ jobs ] セクションに移動します。 smartDeployment既定値を true から false に切り替えます。この変更がコミットされると、スマートデプロイ機能がオフになり、この接続の今後のすべてのデプロイで、リポジトリの関連するすべてのコンテンツファイルが接続されたワークスペースに再デプロイされます。
- デプロイパスを変更するには:
  
  on セクションに表示される既定の構成では、paths セクションの最初の行のワイルドカード (**) は、ブランチ全体がデプロイトリガーのパスにあることを示します。
  
  この既定の構成は、コンテンツがブランチの任意の部分にプッシュされるたびにデプロイワークフローがトリガーされることを意味します。
  
  ファイルの後半の jobs セクションには、次の既定の構成が含まれています: directory: '${{ github.workspace }}'。この行は、GitHub ブランチ全体が、フォルダーパスをフィルター処理せずに、コンテンツデプロイのパスにあることを示します。
  
  特定のフォルダーパスからのみコンテンツを展開するには、 paths と directory 構成の両方にコンテンツを追加します。たとえば、 SentinelContent という名前のルートフォルダーからのみコンテンツを展開するには、次のようにコードを更新します。
```
paths:
- `SentinelContent/**`
- `!.github/workflows/**` # this filter prevents other workflow changes from triggering this workflow
- `.github/workflows/sentinel-deploy-<deployment-id>.yml`

...
    directory: '${{ github.workspace }}/SentinelContent'
```

詳細については、GitHub ワークフローのGitHub Actionsと編集に関する GitHub ドキュメントを参照してください。

Azure DevOps デプロイパイプラインをカスタマイズするには:

DevOps Azureで、リポジトリに移動し、パイプライン定義ファイルを .sentinel ディレクトリで見つけます。

パイプライン名はパイプラインファイルの最初の行に表示され、既定の名前付け規則は Deploy Content to <workspace-name> [<deployment-id>]。

例: name: Deploy Content to repositories-demo [xxxxx-dk5d-3s94-4829-9xvnc7391v83a]
ページの右上にある鉛筆ボタンを選択して編集用のファイルを開き、次のようにデプロイを変更します。
- デプロイトリガーを変更するには、コード内の trigger セクションを更新します。このセクションでは、ワークフローを実行するようにトリガーするイベントについて説明します。
  
  既定では、この構成は、既存のコンテンツへの変更とリポジトリへの新しいコンテンツの追加の両方を含む、接続されたブランチへのプッシュを検出するように設定されています。
  
  このトリガーを、スケジューリングトリガーやプル要求トリガーなど、DevOps トリガー Azure使用できる任意のトリガーに変更します。詳細については、devOps トリガーのAzureに関するドキュメントを参照してください。
- スマートデプロイを無効にするには:スマートデプロイの動作は、説明されているデプロイトリガーとは別です。パイプラインの [ ScriptArguments ] セクションに移動します。 smartDeployment既定値を true から false に切り替えます。この変更がコミットされると、スマートデプロイ機能がオフになり、この接続の今後のすべてのデプロイで、リポジトリの関連コンテンツファイルがすべて接続されたワークスペースに再デプロイされます。
- デプロイパスを変更するには:
  
  trigger セクションの既定の構成には、main ブランチがデプロイトリガーのパスにあることを示す次のコードがあります。
```
trigger:
    branches:
        include:
        - main
```
  この既定の構成は、コンテンツが main ブランチの任意の部分にプッシュされるたびにデプロイパイプラインがトリガーされることを意味します。
  
  特定のフォルダーパスからのみコンテンツを展開するには、トリガーの [ include ] セクションにフォルダー名を追加し、展開パスを [ steps ] セクションに追加します。
  
  たとえば、main ブランチの SentinelContent という名前のルートフォルダーからのみコンテンツを展開するには、次のようにincludeとworkingDirectory設定をコードに追加します。
```
paths:
    exclude:
    - .sentinel/*
    include:
    - .sentinel/sentinel-deploy-39d8ekc8-397-5963-49g8-5k63k5953829.yml
    - SentinelContent
....
steps:
- task: AzurePowerShell@5
  inputs:
    azureSubscription: `Sentinel_Deploy_ServiceConnection_0000000000000000`
    workingDirectory: `SentinelContent`
```

詳細については、Azure DevOps YAML スキーマに関する Azure DevOps ドキュメントを参照してください。

重要

GitHub と Azure DevOps の両方で、トリガーパスとデプロイパスディレクトリの一貫性を維持してください。

パラメーターファイルを使用してデプロイをスケーリングする

コンテンツファイルでパラメーターをインライン値として渡すのではなく、 Bicep パラメーターファイルまたはパラメーター値を含む JSON ファイルの使用を検討してください。次に、これらのパラメーターファイルを関連する Microsoft Sentinel コンテンツファイルにマップして、さまざまなワークスペース間でのデプロイのスケーリングを改善します。

パラメーターファイルをコンテンツファイルにマップするには、いくつかの方法があります。 Bicep パラメーターファイルでは Bicep ファイルテンプレートのみがサポートされますが、JSON パラメーターファイルでは両方がサポートされることに注意してください。リポジトリのデプロイパイプラインでは、次の順序でパラメーターファイルが考慮されます。

パラメーターファイルマッピングの優先順位を示す図。

sentinel-deployment.config?
にマッピングはありますか?詳細については、「接続構成をカスタマイズする」を参照してください。
ワークスペースにマップされたパラメーターファイルはありますか? はい。コンテンツファイルは、ワークスペースマップパラメーターファイルと同じディレクトリ内に存在し、次のいずれかのパターンに一致します:
.<WorkspaceID>.bicepparam
.parameters-<WorkspaceID>.json
既定のパラメーターファイルはありますか? はい。コンテンツファイルは同じディレクトリに存在し、パラメーターファイルは
.bicepparam
のいずれかと一致します.parameters.json

構成ファイルを使用してパラメーターファイルをマッピングするか、ファイル名にワークスペース ID を指定することで、複数のワークスペース展開との競合を回避します。

重要

マッピングの優先順位に基づいてパラメーターファイルの一致が決定されると、パイプラインは残りのマッピングを無視します。

sentinel-deployment.config に一覧表示されているマップされたパラメーターファイルを変更すると、ペアリングされたコンテンツファイルのデプロイがトリガーされます。ワークスペースマップパラメーターファイルまたは既定のパラメーターファイルを追加または変更すると、優先順位の高いパラメーターマッピングが設定されていない限り、ペアになっているコンテンツファイルと新しく変更されたパラメーターのデプロイもトリガーされます。スマートデプロイ機能がワークフロー/パイプライン定義ファイルで引き続き有効になっている限り、他のコンテンツファイルはデプロイされません。

接続構成をカスタマイズする

リポジトリのデプロイスクリプトでは、2022 年 7 月の時点で、各リポジトリブランチのデプロイ構成ファイルの使用がサポートされています。構成 JSON ファイルは、パラメーターファイルを関連するコンテンツファイルにマップし、デプロイ内の特定のコンテンツに優先順位を付け、特定のコンテンツをデプロイから除外するのに役立ちます。

リポジトリのルートに sentinel-deployment.config ファイルを作成します。この構成ファイルを追加、削除、または変更すると、更新された構成に従って、リポジトリ内のすべてのコンテンツの完全なデプロイがトリガーされます。
構造化コンテンツを、 "prioritizedcontentfiles":、 "excludecontentfiles":、 "parameterfilemappings":の 3 つの省略可能なセクションに含めます。セクションが含まれていない場合、または .config ファイルが省略された場合でも、デプロイプロセスが実行されます。無効なセクションまたは認識されないセクションは無視されます。

有効な sentinel-deployment.config ファイルの内容全体の例を次に示します。このサンプルは、Microsoft Sentinel CICD リポジトリのサンプルでも確認できます。

{
  "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"
}

注:

どのコンテンツパスにも円記号 "\" 文字を使用しないでください。代わりにスラッシュ "/" を使用します。

コンテンツファイルに優先順位を付ける方法:

リポジトリ内のコンテンツの量が増えるにつれて、デプロイ時間が長くなる可能性があります。このセクションに時間の影響を受けやすいコンテンツを追加して、トリガーが発生したときにデプロイに優先順位を付けます。

[ "prioritizedcontentfiles": ] セクションに完全なパス名を追加します。現時点では、ワイルドカードの一致はサポートされていません。
コンテンツファイルを除外するには、個々の.json コンテンツファイルの完全なパス名を使用して "excludecontentfiles": セクションを変更します。
パラメーターをマップするには:

デプロイスクリプトは、「パラメーターファイルを使用してデプロイをスケーリングする」で説明されているように、3 つのマッピングパラメーターの方法を受け入れます。 sentinel-deployment.config を介したパラメーターのマッピングが最も優先順位が高く、指定されたパラメーターファイルが関連付けられているコンテンツファイルにマップされることを保証します。ターゲット接続のワークスペース ID と個々の.json ファイルの完全なパス名を使用して、 "parameterfilemappings": セクションを変更します。

サンプルリポジトリは、デプロイ構成ファイルと 3 つのパラメーターマッピングメソッドすべてを示しています。詳細については、「MICROSOFT SENTINEL CICD リポジトリのサンプル」を参照してください。

フィードバック

このページはお役に立ちましたか?

Last updated on 2026-04-23

リポジトリのデプロイをカスタマイズする (パブリック プレビュー)

前提条件

ワークフローまたはパイプラインをカスタマイズする

パラメーター ファイルを使用してデプロイをスケーリングする

接続構成をカスタマイズする

関連コンテンツ

フィードバック

その他のリソース

リポジトリのデプロイをカスタマイズする (パブリックプレビュー)

パラメーターファイルを使用してデプロイをスケーリングする