public/Publish-AdfV2FromJson.ps1
|
<# .SYNOPSIS Publishes all ADF objects from JSON files into target ADF service. .DESCRIPTION Publishes all ADF objects from JSON files into target ADF service. Creates a data factory with the specified resource group name and location, if that doesn't exist. Takes care of creating ADF, appropriate order of deployment, deleting objects not in the source anymore, replacing properties environment-related based on CSV config file, and more. .PARAMETER RootFolder Source folder where all ADF objects are kept. The folder should contain subfolders like pipeline, linkedservice, etc. .PARAMETER ResourceGroupName Resource Group Name of target instance of ADF .PARAMETER DataFactoryName Name of target ADF instance .PARAMETER Stage Optional parameter. When defined, process will replace all properties defined in (csv) configuration file. The parameter can be either full path to csv file (must ends with .csv) or just stage name. When you provide parameter value 'UAT' the process will try open config file located .\deployment\config-UAT.csv .PARAMETER Location Azure Region for target ADF. Used only for create new ADF instance. .PARAMETER Option This objects allows to define certain behaviour of deployment process. Use cmdlet "New-AdfPublishOption" to create new instance of objects and set required properties. .PARAMETER Method Optional parameter. Currently this cmdlet contains two method of publishing: AzDataFactory, AzResource (default). AzResource method has been introduced due to bugs in Az.DataFactory PS module. .PARAMETER DryRun Optional switch parameter. When provided, process will not make any changes to target data factory but instead return the ADF object that would be used in deployment. .EXAMPLE # Publish entire ADF $ResourceGroupName = 'rg-devops-factory' $DataFactoryName = "SQLPlayerDemo" $Location = "NorthEurope" $RootFolder = "c:\GitHub\AdfName\" Publish-AdfV2FromJson -RootFolder "$RootFolder" -ResourceGroupName "$ResourceGroupName" -DataFactoryName "$DataFactoryName" -Location "$Location" .EXAMPLE # Publish entire ADF with specified properties (different environment stage name provided) Publish-AdfV2FromJson -RootFolder "$RootFolder" -ResourceGroupName "$ResourceGroupName" -DataFactoryName "$DataFactoryName" -Location "$Location" -Stage "UAT" .EXAMPLE # Publish entire ADF with specified properties (different environment config full path file provided) $configCsvFile = 'c:\myCode\myadf\deployment\config-UAT.csv' Publish-AdfV2FromJson -RootFolder "$RootFolder" -ResourceGroupName "$ResourceGroupName" -DataFactoryName "$DataFactoryName" -Location "$Location" -Stage "$configCsvFile" .EXAMPLE # Including objects by type and name pattern $opt = New-AdfPublishOption $opt.Includes.Add("pipeline.Copy*", "") $opt.DeleteNotInSource = $false Publish-AdfV2FromJson -RootFolder "$RootFolder" -ResourceGroupName "$ResourceGroupName" -DataFactoryName "$DataFactoryName" -Location "$Location" -Stage "UAT" -Option $opt .EXAMPLE # Including only one object to deployment and do not stop/start triggers $opt = New-AdfPublishOption $opt.Includes.Add("pipeline.Wait1", "") $opt.StopStartTriggers = $false Publish-AdfV2FromJson -RootFolder "$RootFolder" -ResourceGroupName "$ResourceGroupName" -DataFactoryName "$DataFactoryName" -Location "$Location" -Stage "UAT" -Option $opt .EXAMPLE # Publish entire ADF via Az.DataFactory module instead of Az.Resources Publish-AdfV2FromJson -RootFolder "$RootFolder" -ResourceGroupName "$ResourceGroupName" -DataFactoryName "$DataFactoryName" -Location "$Location" -Method "AzDataFactory" .EXAMPLE # Execute dry run of intended publishing changes Publish-AdfV2FromJson -RootFolder "$RootFolder" -ResourceGroupName "$ResourceGroupName" -DataFactoryName "$DataFactoryName" -Location "$Location" -Stage "UAT" -DryRun .LINK Online version: https://github.com/SQLPlayer/azure.datafactory.tools/ #> function Publish-AdfV2FromJson { [CmdletBinding()] param ( [parameter(Mandatory = $true)] [String] $RootFolder, [parameter(Mandatory = $true)] [String] $ResourceGroupName, [parameter(Mandatory = $true)] [String] $DataFactoryName, [parameter(Mandatory = $false)] [String] $Stage = $null, [parameter(Mandatory = $false)] [String] $Location, [parameter(Mandatory = $false)] [AdfPublishOption] $Option, [parameter(Mandatory = $false)] [ValidateSet('AzDataFactory', 'AzResource')] [String]$Method = 'AzResource', [parameter(Mandatory = $false)] [switch]$DryRun ) $m = Get-Module -Name "azure.datafactory.tools" $verStr = $m.Version.ToString(2) + "." + $m.Version.Build.ToString("000"); Write-Host "======================================================================================"; Write-Host "### azure.datafactory.tools Version $verStr ###"; Write-Host "======================================================================================"; Write-Host "Invoking Publish-AdfV2FromJson (https://github.com/SQLPlayer/azure.datafactory.tools)"; Write-Host "with the following parameters:"; Write-Host "======================================================================================"; Write-Host "RootFolder: $RootFolder"; Write-Host "ResourceGroupName: $ResourceGroupName"; Write-Host "DataFactoryName: $DataFactoryName"; Write-Host "Location: $Location"; Write-Host "Stage: $Stage"; Write-Host "Options provided: $($null -ne $Option)"; Write-Host "Publishing method: $Method"; Write-Host "Is Dry Run?: $($DryRun.IsPresent)"; Write-Host "======================================================================================"; if ($null -ne $Option) { Write-Host "Options:" $Option | Format-List | Out-Host Write-Host "======================================================================================"; } $script:StartTime = Get-Date $script:PublishMethod = $Method $script:ds = [AdfDeploymentState]::new($verStr) if ($null -ne $Option) { Write-Host "Publish options are provided." $opt = $Option } else { Write-Host "Publish options are not provided." $opt = New-AdfPublishOption } if (!$DryRun.IsPresent) { Write-Host "STEP: Verifying whether ADF exists..." $targetAdf = Get-AzDataFactoryV2 -ResourceGroupName "$ResourceGroupName" -Name "$DataFactoryName" -ErrorAction:Ignore if ($targetAdf) { Write-Host "Azure Data Factory exists." if ($opt.IncrementalDeployment -and !$DryRun.IsPresent) { Write-Host "Loading Deployment State from ADF..." $ds.GetStateFromService($targetAdf) | Out-Null } } else { $msg = "Azure Data Factory instance does not exist." if ($opt.CreateNewInstance) { Write-Host "$msg" Write-Host "Creating a new instance of Azure Data Factory..." $targetAdf = Set-AzDataFactoryV2 -ResourceGroupName "$ResourceGroupName" -Name "$DataFactoryName" -Location "$Location" $targetAdf | Format-List | Out-String } else { Write-Host "Creation operation skipped as publish option 'CreateNewInstance' = false" Write-Error "ADFT0027: $msg" } } if ($null -eq $targetAdf) { Write-Host "The process is exiting the function. Do fix the issue and run again." return } } else { Write-Host "DRY RUN: Skipping ADF existence verification..." } Write-Host "==================================================================================="; Write-Host "STEP: Reading Azure Data Factory from JSON files..." $adf = Import-AdfFromFolder -FactoryName $DataFactoryName -RootFolder "$RootFolder" $adf.ResourceGroupName = "$ResourceGroupName"; $adf.Region = "$Location"; $adf.PublishOptions = $opt Write-Debug ($adf | Format-List | Out-String) Write-Host "==================================================================================="; Write-Host "STEP: Pre-deployment" if ($opt.IncrementalDeployment -and $opt.DeployGlobalParams) { Write-Host "Incremental Deployment Mode: Preparing..." Write-Debug "Incremental Deployment Mode: Checking whether factory file exist..." if ($adf.Factories.Count -eq 0) { Write-Debug "Creating empty factory file..." $EmptyFactoryFileBody = '{ "name": "'+ $adf.Name +'", "properties": { "globalParameters": {} } }' $o = New-Object -TypeName "AdfObject" $o.Adf = $Adf $o.Name = $DataFactoryName $o.Type = 'factory' $o.Body = $EmptyFactoryFileBody | ConvertFrom-Json $o.FileName = Save-AdfObjectAsFile -obj $o $adf.GlobalFactory.FilePath = $o.FileName $adf.GlobalFactory.body = $EmptyFactoryFileBody $adf.GlobalFactory.GlobalParameters = $o.Body.Properties.globalParameters $adf.Factories.Add($o) | Out-Null Write-Host ("Factories: 1 object created.") } Write-Host "Incremental Deployment Mode: Preparation Done" } Write-Host "==================================================================================="; Write-Host "STEP: Replacing all properties environment-related..." if (![string]::IsNullOrEmpty($Stage)) { Update-PropertiesFromFile -adf $adf -stage $Stage } else { Write-Host "Stage parameter was not provided - action skipped." } Write-Host "==================================================================================="; Write-Host "STEP: Determining the objects to be deployed..." # Apply Deployment Options if applicable if ($null -ne $Option) { ApplyExclusionOptions -adf $adf } Write-Verbose "Incremental Deployment = $($opt.IncrementalDeployment)" if ($opt.IncrementalDeployment) { Write-Verbose "The following objects will not be deployed as they have no changes since last deployment:" $unchanged_count = 0 $adf.AllObjects() | ForEach-Object { $fullName = $_.FullName() $newHash = $_.GetHash() $isUnchanged = $ds.Deployed.ContainsKey($fullName) -and $ds.Deployed[$fullName] -eq $newHash Write-Debug "- $fullName ( $newHash ) = Unchanged: $isUnchanged" if ($isUnchanged) { Write-Verbose "- $fullName" $_.ToBeDeployed = $false $unchanged_count++ } } Write-Host "Found $unchanged_count unchanged object(s)." } ToBeDeployedStat -adf $adf if ($DryRun.IsPresent) { Write-Host "DRY RUN: Terminating script pre-deployment - inspect returned object to review planned changes." Write-Host "==================================================================================="; return $adf } Write-Host "==================================================================================="; Write-Host "STEP: Stopping triggers..." if ($opt.StopStartTriggers -eq $true) { Stop-Triggers -adf $adf } else { Write-Host "Operation skipped as publish option 'StopStartTriggers' = false" } Write-Host "==================================================================================="; Write-Host "STEP: Deployment of all ADF objects..." if ($opt.DeployGlobalParams -eq $false) { Write-Host "Deployment of Global Parameters will be skipped as publish option 'DeployGlobalParams' = false" if ($adf.Factories.Count -gt 0) { $adf.Factories[0].ToBeDeployed = $false } } $adf.AllObjects() | ForEach-Object { Deploy-AdfObject -obj $_ } Write-Host "==================================================================================="; Write-Host "STEP: Updating (incremental) deployment state..." if ($opt.IncrementalDeployment) { if ($opt.DeployGlobalParams -eq $false) { Write-Warning "Incremental Deployment State will not be saved as publish option 'DeployGlobalParams' = false" } else { Write-Debug "Deployment State -> SetStateFromAdf..." $ds.SetStateFromAdf($adf) $dsjson = ConvertTo-Json $ds -Depth 5 Write-Verbose "--- Deployment State: ---`r`n $dsjson" $gp = [AdfGlobalParam]::new($ds) $report = new-object PsObject -Property @{ Updated = 0 Added = 0 Removed = 0 } Update-PropertiesForObject -o $adf.Factories[0] -action 'add' -path 'globalParameters.adftools_deployment_state' -value $gp -name 'type' -type 'factory' -report $report Write-Verbose "Redeploying Global Parameters..." $adf.Factories[0].Deployed = $false #$adf.Factories[0].ToBeDeployed = $true Deploy-AdfObject -obj $adf.Factories[0] } } else { Write-Host "Incremental Deployment State will not be saved as publish option 'IncrementalDeployment' = false" Write-Host "Try this new feature to speed up the deployment process. Check out more in documentation." } Write-Host "==================================================================================="; Write-Host "STEP: Deleting objects not in source ..." if ($opt.DeleteNotInSource -eq $true) { $adfIns = Get-AdfFromService -FactoryName "$DataFactoryName" -ResourceGroupName "$ResourceGroupName" $adfIns.AllObjects() | ForEach-Object { Remove-AdfObjectIfNotInSource -adfSource $adf -adfTargetObj $_ -adfInstance $adfIns } Write-Host "Deleted $($adf.DeletedObjectNames.Count) objects from ADF service." } else { Write-Host "Operation skipped as publish option 'DeleteNotInSource' = false" } Write-Host "==================================================================================="; Write-Host "STEP: Starting triggers..." if ($opt.StopStartTriggers -eq $true) { Start-Triggers -adf $adf } else { Write-Host "Operation skipped as publish option 'StopStartTriggers' = false" } $elapsedTime = new-timespan $script:StartTime $(get-date) Write-Host "=============================================================================="; Write-Host " ***** Azure Data Factory files have been deployed successfully. *****`n"; Write-Host "Data Factory name: $DataFactoryName"; Write-Host "Region (Location): $location"; Write-Host ([string]::Format(" Elapsed time: {0:d1}:{1:d2}:{2:d2}.{3:d3}`n", $elapsedTime.Hours, $elapsedTime.Minutes, $elapsedTime.Seconds, $elapsedTime.Milliseconds)) Write-Host "=============================================================================="; return $adf } |