BizTalk.Administration.psm1

#region Copyright & License

# Copyright © 2012 - 2021 François Chabot
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

#endregion

using assembly Microsoft.BizTalk.ExplorerOM
using assembly Microsoft.BizTalk.Operations

Set-StrictMode -Version Latest

<#
.SYNOPSIS
    Ensures Microsoft BizTalk Server is installed locally.
.DESCRIPTION
    This command will throw if Microsoft BizTalk Server is not installed locally and will silently complete otherwise.
.EXAMPLE
    PS> Assert-BizTalkServer
.EXAMPLE
    PS> Assert-BizTalkServer -Verbose
    When verbose, this function outputs a message confirming that Microsoft BizTalk Server is installed locally.
.NOTES
    © 2021 be.stateless.
#>

function Assert-BizTalkServerInstalled {
    [CmdletBinding()]
    [OutputType([void])]
    param()

    Resolve-ActionPreference -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState
    if (-not(Test-BizTalkServer)) { throw 'Microsoft BizTalk Server is not installed locally.' }
    Write-Verbose -Message 'Microsoft BizTalk Server is installed locally.'
}

<#
.SYNOPSIS
    Returns whether Microsoft BizTalk Server is installed locally.
.DESCRIPTION
    This command will return $true if the Microsoft BizTalk Server is installed locally.
.EXAMPLE
    PS> Test-BizTalkServer
.NOTES
    © 2021 be.stateless.
#>

function Test-BizTalkServerInstalled {
    [CmdletBinding()]
    [OutputType([bool])]
    param()

    Resolve-ActionPreference -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState
    Test-Path -Path 'HKLM:\SOFTWARE\Microsoft\BizTalk Server\3.0\*'
}

<#
 # Main
 #>


# Have BizTalk Tracking tools available on path, noticeably bm.exe
$path = Get-ItemProperty -Path 'HKLM:\SOFTWARE\Microsoft\BizTalk Server\3.0\' -ErrorAction SilentlyContinue | Select-Object -ExpandProperty InstallPath
if ($null -ne $path) {
    $env:Path += ";$(Join-Path $path Tracking)"
}

. $PSScriptRoot\Adapter\Adapter.ps1
. $PSScriptRoot\Application\Application.ps1
. $PSScriptRoot\Group\Group.ps1
. $PSScriptRoot\Handler\Handler.ps1
. $PSScriptRoot\Host\Host.ps1
. $PSScriptRoot\HostInstance\HostInstance.ps1
. $PSScriptRoot\Platform\Platform.ps1
. $PSScriptRoot\Server\Server.ps1

Import-LocalizedData -BindingVariable globalMessages -FileName BizTalk.Administration.Messages.psd1

# SIG # Begin signature block
# MIII0QYJKoZIhvcNAQcCoIIIwjCCCL4CAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUYiv7+c+pHwpPoXoV/3M7cB5C
# VKWgggVMMIIFSDCCAzCgAwIBAgIJAJkr3mJdTBkUMA0GCSqGSIb3DQEBCwUAMEEx
# PzA9BgNVBAMeNgBpAGMAcgBhAGYAdABzAG8AZgB0AHcAYQByAGUAQABzAHQAYQB0
# AGUAbABlAHMAcwAuAGIAZTAeFw0yMTA2MjUxNDEyMjNaFw00MTA2MjAxNDEyMjNa
# MEExPzA9BgNVBAMeNgBpAGMAcgBhAGYAdABzAG8AZgB0AHcAYQByAGUAQABzAHQA
# YQB0AGUAbABlAHMAcwAuAGIAZTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoC
# ggIBAOeqdUHBv7sxSeX3aj6yPKj7PAvs8izpVXjyEBl5aR8mQneVcXuF53AH7EW1
# 6E5p4+Az5pJPGUD5c3tXhiGMF7vgLhQjO6hlaVBRIqiIYHikNLwMNy6YBMc/QQYM
# rPhqHEFsZ53dkBIIj3M8e3kFcTFA09n25yDtTPDab4nd9yUhc9Qc8+nfpIzfYsoP
# 1pZ3nCzhw6hN2/44v1dkQrG3dRYwt+px65p6NPNZWEJpt4VCJjIFh+lBYJdxm9d4
# X/rAnlHIkbv7liOavWDzgHVabS3hdAWtcDmynm+7+FcZDFqPWNCl3e4SS7xe4s/R
# CKFKA0IsfKkSk9YJlLgeSQIEXUOOWXJAGaLqnRD8xWLZsc4Oi9GZg7XV1mv/S88c
# oztXnwtAN3OOlRKBh2QbomMgxeMO0GvsLE/cq5Q/YKAoz+KGr/7LcZq9jzQ8IPus
# ZvWLeDXmxPiwJjpZc1koLgfGIEX2NStQTT3QmacWr9thrWcKvI+4uBmI4exS9B4a
# R3nV91w5EY+2RoYsHqej9LWwNamO96+jMX9pxprTX+EkLUuMAikw/po8sBC9MUUn
# 5pMWmUv7DCtQOLGGBDDMMMkn4ZcjpCEEdPGHRKfqNnD27ssGtDjiNzfQrsm67toU
# bBwUF+gyJq/YckWquYJhA9ZOFWEADuIwGnsOzsoRvuQyY+p9AgMBAAGjQzBBMA4G
# A1UdDwEB/wQEAwIHgDAWBgNVHSUBAf8EDDAKBggrBgEFBQcDAzAXBgNVHREEEDAO
# ggxzdGF0ZWxlc3MuYmUwDQYJKoZIhvcNAQELBQADggIBACithYM3qckZRc9+Xbfu
# a6gWr3HwjrW+FHKgjfrcOm8ZnLVapb9xFqsqrRQqd3RXWQDINEGrtI2rSfrzyfoK
# UiTgldIfQNP1ZcGY229d++90t3hdo2mlt05hjYlbMENloJHpsEP0vQZmwOcEimCT
# ex1pymYM+P9pj3j8UD1PT1eIZot6or8fBRl63UybyDSrM7L4UOkkAOniKxWy5pW6
# 6duS8SR+SZpr3Bv44NyXPj0Nv+MIpLmsLrd7XPBFmnGxzY01ZO9vzi9KEhM2wT5i
# jPqHDNOvfPiADtAa+EyUBzdJiqy9heCz/TMZQgMWGwtfqJNxWZmsHcha2anW4Qt+
# mzrLO4GojWoVog9uVSAq+l0a+YQsd1u1kUmm4vgZCFyUA+lEp4LkI7ca2VBHkLPD
# w+u2DoDMRiqFPZjO7BCKjGc0jj9B/qGR3JVt+tqDdB621xXf2YGF2oFvxZQ/keGt
# 0ujfJ+JwN3nCulDAA4773q6KUnfykyrvAgITNbRJL6TngeRKtw9VIJBPxzqMzLpV
# 5ggXNituwLaD1CCBJ1oo9DZHpL9gplXp1wGrelJOTiJhh+pdNsPtRH7CrranWa5h
# LFLuigqin0eewQ5giJ1VaiBVEseOmiZog+27UpFIv40aDzgGL3YxB/Mu0ojwrQtp
# WLmqJCmWnR5qxOm0yK+zNWe0MYIC7zCCAusCAQEwTjBBMT8wPQYDVQQDHjYAaQBj
# AHIAYQBmAHQAcwBvAGYAdAB3AGEAcgBlAEAAcwB0AGEAdABlAGwAZQBzAHMALgBi
# AGUCCQCZK95iXUwZFDAJBgUrDgMCGgUAoHgwGAYKKwYBBAGCNwIBDDEKMAigAoAA
# oQKAADAZBgkqhkiG9w0BCQMxDAYKKwYBBAGCNwIBBDAcBgorBgEEAYI3AgELMQ4w
# DAYKKwYBBAGCNwIBFTAjBgkqhkiG9w0BCQQxFgQU1Eh420Ie6ZbybmCpFoMqGQRs
# 650wDQYJKoZIhvcNAQEBBQAEggIAV8ecnPsmrrzEBpP+EFYZcEvQBoLikkNtd6U3
# h3azMXe2+UX1e2VrEuoa3nx3ZcwqC5cjPHInSwNO0cS9BltgAhehVwcD7hfkzvXs
# QltUXGBpBLh7W8ULuz+NkR97l+vzOQMpi6zW7xXP9wKcUJlbeVQwX4TWWeI7uka6
# E2F8eABa3WvD9TLVwWFaxPyWHUYeVMXi7j2roHpBJ1mb21GLnDhZfi46M5BYd3rn
# u+tCyP+4V215pco5jcwRxBkqhGeLH5ryEs0aBKRLZw3faPiOYwobeWeId+opripl
# 46WBJKhXNQ0bW6SonnGohwBd3GfewJp3wNR9W6oqZBWbRCOzBOIHaVEDUkKL2r2Y
# 1eFtwg1IJLenjydtjk9uz0AhFpi+8WXko+oF3baPYewuzyL0lbqtntQgP5rgnFYE
# nJ8vU0rCHtocGlWcRqtLGyc0Fyf/haWuqwOpKEtgNCMdTAUnDKQ+aP2rKINrpX5Y
# bVM9F00R6S1fwDV3gfKad65/bpIT9o5angkW9D+eiBHajjnOlcsXwiZbup+URaj9
# QSmVXBfwJBarNdn4OAyUIGK3sQUhgs2vqkfuBnR/rSKwxMQF1mQ5wOQcJZBn3WRz
# zUQSWZXh/9kqHIXj2cSdqH9IjcrvJAAi7ts8DaVnpBHwbtxC7VaOSZaTNtDqfWug
# BxQLhTQ=
# SIG # End signature block