Feature - add set data factory trigger state

build/templates/run-pester-tests.yml

@@ -18,7 +18,10 @@ steps:
       script: |
         Install-Module -Name Pester -Force -SkipPublisherCheck
         Install-Module -Name Az -Force -SkipPublisherCheck
-        Import-Module -Name ./src/Arcus.Scripting.KeyVault -ErrorAction Stop
+
+        Get-ChildItem -Path ./src -Filter *.psm1 -Recurse |
+            % { Import-Module -Name $_.DirectoryName -ErrorAction Stop }
+
         Invoke-Pester -Script "./src/${{ parameters.projectName }}/" -OutputFile "./pester.test.results.xml" -OutputFormat 'NUnitXML'
   - task: PublishTestResults@2
     displayName: 'Publish test results'

docs/preview/features/powershell/azure-data-factory.md

@@ -0,0 +1,61 @@
+---
+title: "Scripts related to interacting with Azure Data Factory"
+layout: default
+---
+
+# Azure Data Factory
+
+## Installation
+
+To have access to the following features, you have to import the module:
+
+```powershell
+PS> Import-Module -Name Arcus.Scripting.DataFactory
+```
+
+## Enable the trigger of a Azure Data Factory
+
+Enable a Data Factory V2 Trigger.
+
+| Parameter                   | Mandatory | Description                                                                              |
+| --------------------------- | --------- | ---------------------------------------------------------------------------------------- |
+| `ResourceGroupName`         | yes       | The resource group containing the Azure Data Factory V2                                  |
+| `DataFactoryName`           | yes       | The name of the Azure Data Factory V2                                                    |
+| `DataFactoryTriggerName`    | yes       | The name of the trigger to be enabled                                                    |
+| `FailWhenTriggerIsNotFound` | no        | Indicate whether to throw an exception if the trigger cannot be found (default: `false`) |
+
+**Example**
+
+```powershell
+PS> Enable-AzDataFactoryTrigger -ResourceGroupName "my-resource-group" -DataFactoryName "my-data-factory-name" -DataFactoryTriggerName "my-data-factory-trigger-name"
+# The trigger 'my-data-factory-trigger-name' has been enabled.
+```
+
+```powershell
+PS> Enable-AzDataFactoryTrigger -ResourceGroupName "my-resouce-group" -DataFactoryName "my-data-factory-name" -DataFactoryTriggerName "unknown-data-factory-trigger-name" -FailWhenTriggerIsNotFound
+# Error: Error retrieving trigger 'unknown-data-factory-trigger-name' in data factory 'my-data-factory'.
+```
+
+
+## Disable the trigger of a Azure Data Factory
+
+Disable a Data Factory V2 Trigger.
+
+| Parameter                   | Mandatory | Description                                                                              |
+| --------------------------- | --------- | ---------------------------------------------------------------------------------------- |
+| `ResourceGroupName`         | yes       | The resource group containing the Azure Data Factory V2                                  |
+| `DataFactoryName`           | yes       | The name of the Azure Data Factory V2                                                    |
+| `DataFactoryTriggerName`    | yes       | The name of the trigger to be disabled                                                   |
+| `FailWhenTriggerIsNotFound` | no        | Indicate whether to throw an exception if the trigger cannot be found (default: `false`) |
+
+**Example**
+
+```powershell
+PS> Disable-AzDataFactoryTrigger -ResourceGroupName "my-resource-group" -DataFactoryName "my-data-factory-name" -DataFactoryTriggerName "my-data-factory-trigger-name"
+# The trigger 'my-data-factory-trigger-name' has been disabled.
+```
+
+```powershell
+PS> Disable-AzDataFactoryTrigger -ResourceGroupName "my-resouce-group" -DataFactoryName "my-data-factory-name" -DataFactoryTriggerName "unknown-data-factory-trigger-name" -FailWhenTriggerIsNotFound
+# Error: Error retrieving trigger 'unknown-data-factory-trigger-name' in data factory 'my-data-factory'.
+```

docs/preview/index.md

@@ -18,7 +18,8 @@ For more granular packages we recommend reading the documentation.
 
 # Features
 
-* Automate Azure Key Vault tasks ([powershell](features/powershell/key-vault))
+* Automate Azure Data Factory tasks ([powershell](featues/powershell/azure-data-factory))
+* Automate Azure Key Vault tasks ([powershell](features/powershell/azure-key-vault))
 
 # License
 This is licensed under The MIT License (MIT). Which means that you can use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the web application. But you always need to state that Codit is the original author of this web application.

src/Arcus.Scripting.DataFactory/Arcus.Scripting.DataFactory.psm1

@@ -0,0 +1,75 @@
+<#
+ .Synopsis
+  Change the state of a DataFactory V2 Trigger.
+
+ .Description
+  Enable a DataFactory V2 Trigger.
+
+ .Parameter ResourceGroupName
+  The resource group containing the DataFactory V2.
+
+ .Parameter DataFactoryName
+  The name of the DataFactory V2.
+
+ .Parameter DataFactoryTriggerName
+  The name of the trigger to be enabled.
+
+ .Parameter FailWhenTriggerIsNotFound
+  Indicate whether to throw an exception if the trigger cannot be found.
+#>
+function Enable-AzDataFactoryTrigger {
+	param(
+		[Parameter(Mandatory=$true)][string]$ResourceGroupName = $(throw "ResourceGroup is required"),
+		[Parameter(Mandatory=$true)][string]$DataFactoryName = $(throw "The name of the data factory is required"),
+		[Parameter(Mandatory=$true)][string]$DataFactoryTriggerName = $(throw "The name of the trigger is required"),
+		[Parameter(Mandatory=$false)][switch]$FailWhenTriggerIsNotFound = $false
+	)
+	if($FailWhenTriggerIsNotFound)
+	{
+		. $PSScriptRoot\Scripts\Set-AzDataFactoryTriggerState.ps1 -Action Start -ResourceGroupName $ResourceGroupName -DataFactoryName $DataFactoryName -DataFactoryTriggerName $DataFactoryTriggerName -FailWhenTriggerIsNotFound
+	}
+	else
+	{
+		. $PSScriptRoot\Scripts\Set-AzDataFactoryTriggerState.ps1 -Action Start -ResourceGroupName $ResourceGroupName -DataFactoryName $DataFactoryName -DataFactoryTriggerName $DataFactoryTriggerName
+	}
+}
+
+Export-ModuleMember Enable-AzDataFactoryTrigger
+
+<#
+ .Synopsis
+  Change the state of a DataFactory V2 Trigger.
+
+ .Description
+  Disable a DataFactory V2 Trigger.
+
+ .Parameter ResourceGroupName
+  The resource group containing the DataFactory V2.
+
+ .Parameter DataFactoryName
+  The name of the DataFactory V2.
+
+ .Parameter DataFactoryTriggerName
+  The name of the trigger to be disabled.
+
+ .Parameter FailWhenTriggerIsNotFound
+  Indicate whether to throw an exception if the trigger cannot be found.
+#>
+function Disable-AzDataFactoryTrigger {
+	param(
+		[Parameter(Mandatory=$true)][string]$ResourceGroupName = $(throw "ResourceGroup is required"),
+		[Parameter(Mandatory=$true)][string]$DataFactoryName = $(throw "The name of the data factory is required"),
+		[Parameter(Mandatory=$true)][string]$DataFactoryTriggerName = $(throw "The name of the trigger is required"),
+		[Parameter(Mandatory=$false)][switch]$FailWhenTriggerIsNotFound = $false
+	)
+	if($FailWhenTriggerIsNotFound)
+	{
+		. $PSScriptRoot\Scripts\Set-AzDataFactoryTriggerState.ps1 -Action Stop -ResourceGroupName $ResourceGroupName -DataFactoryName $DataFactoryName -DataFactoryTriggerName $DataFactoryTriggerName -FailWhenTriggerIsNotFound
+	}
+	else
+	{
+		. $PSScriptRoot\Scripts\Set-AzDataFactoryTriggerState.ps1 -Action Stop -ResourceGroupName $ResourceGroupName -DataFactoryName $DataFactoryName -DataFactoryTriggerName $DataFactoryTriggerName
+	}
+}
+
+Export-ModuleMember Disable-AzDataFactoryTrigger

src/Arcus.Scripting.DataFactory/Arcus.Scripting.DataFactory.pssproj

@@ -0,0 +1,39 @@
+<Project ToolsVersion="4.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
+    <SchemaVersion>2.0</SchemaVersion>
+    <ProjectGuid>{87004bab-daac-4344-a719-2c8164da9b27}</ProjectGuid>
+    <OutputType>Exe</OutputType>
+    <RootNamespace>MyApplication</RootNamespace>
+    <AssemblyName>MyApplication</AssemblyName>
+    <Name>Arcus.Scripting.DataFactory</Name>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
+    <DebugSymbols>true</DebugSymbols>
+    <DebugType>full</DebugType>
+    <Optimize>false</Optimize>
+    <OutputPath>bin\Debug\</OutputPath>
+    <DefineConstants>DEBUG;TRACE</DefineConstants>
+    <ErrorReport>prompt</ErrorReport>
+    <WarningLevel>4</WarningLevel>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
+    <DebugType>pdbonly</DebugType>
+    <Optimize>true</Optimize>
+    <OutputPath>bin\Release\</OutputPath>
+    <DefineConstants>TRACE</DefineConstants>
+    <ErrorReport>prompt</ErrorReport>
+    <WarningLevel>4</WarningLevel>
+  </PropertyGroup>
+  <ItemGroup>
+    <Folder Include="Scripts\" />
+  </ItemGroup>
+  <ItemGroup>
+    <Compile Include="Arcus.Scripting.DataFactory.psd1" />
+    <Compile Include="Arcus.Scripting.DataFactory.psm1" />
+    <Compile Include="Scripts\Set-AzDataFactoryTriggerState.ps1" />
+  </ItemGroup>
+  <Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
+  <Target Name="Build" />
+  <Import Project="$(MSBuildExtensionsPath)\PowerShell Tools for Visual Studio\PowerShellTools.targets" Condition="Exists('$(MSBuildExtensionsPath)\PowerShell Tools for Visual Studio\PowerShellTools.targets')" />
+</Project>

src/Arcus.Scripting.DataFactory/Scripts/Set-AzDataFactoryTriggerState.ps1

@@ -0,0 +1,67 @@
+param(
+    [Parameter(Mandatory=$true)][string]$Action = $(throw "Action is required [Start|Stop]"),
+    [Parameter(Mandatory=$true)][string]$ResourceGroupName = $(throw "ResourceGroup is required"),
+    [Parameter(Mandatory=$true)][string]$DataFactoryName = $(throw "The name of the data factory is required"),
+    [Parameter(Mandatory=$true)][string]$DataFactoryTriggerName = $(throw "The name of the trigger is required"),
+    [Parameter(Mandatory=$false)][switch]$FailWhenTriggerIsNotFound = $false
+)
+
+try
+{
+    $dataFactory = Get-AzDataFactoryV2 -ResourceGroupName $ResourceGroupName -Name $DataFactoryName -ErrorAction Stop
+}
+catch
+{
+    throw "Error finding data factory '$DataFactoryName' in resource group '$ResourceGroupName'"
+}
+
+try 
+{
+    $DataFactoryTrigger = Get-AzDataFactoryV2Trigger -ResourceGroupName $ResourceGroupName -DataFactoryName $DataFactoryName -Name $DataFactoryTriggerName -ErrorAction Stop
+}
+catch 
+{
+    $message = "Error retrieving trigger '$DataFactoryTriggerName' in data factory '$DataFactoryName'"
+    if($FailWhenTriggerIsNotFound)
+    {
+        throw $message
+    }
+    else 
+    {
+        Write-Host $message
+        Write-Host "Skipping the '$Action'-operation."
+        return
+    }
+}
+
+if($Action -eq "Start")
+{
+    try 
+    {
+        if($null -ne $DataFactoryTrigger)
+        {
+            $succeeded = Start-AzDataFactoryV2Trigger -ResourceGroupName $ResourceGroupName -DataFactoryName $DataFactoryName -Name $DataFactoryTriggerName -Force -ErrorAction Stop
+            Write-Host "The trigger '$DataFactoryTriggerName' has been started."
+        }
+    }
+    catch 
+    {
+        throw "Error starting trigger '$DataFactoryTriggerName' in data factory '$DataFactoryName'"
+    }
+}
+
+if($Action -eq "Stop")
+{
+    try 
+    {
+        if($null -ne $DataFactoryTrigger)
+        {
+            $succeeded = Stop-AzDataFactoryV2Trigger -ResourceGroupName $ResourceGroupName -DataFactoryName $DataFactoryName -Name $DataFactoryTriggerName -Force -ErrorAction Stop
+            Write-Host "The trigger '$DataFactoryTriggerName' has been stopped."
+        }
+    }
+    catch 
+    {
+        throw "Error stopping trigger '$DataFactoryTrigger' in data factory '$DataFactoryName'"
+    }
+}