Preface
This document describes the functionality provided by the BizTalk plugin.
Refer to Deployit Reference Manual for background information on Deployit and deployment concepts.
Overview
The BizTalk plugin is a Deployit plugin that adds the capability to perform BizTalk configuration and deployment tasks.
Features
- Creates and destroys BizTalk applications in the BizTalk database.
- Starts and stops BizTalk applications as necessary.
- Adds and remove BizTalk and plain assemblies to/from the BizTalk database.
- Imports BizTalk bindings files into the BizTalk database.
- Imports BizTalk Business Rule Engine (BRE) vocabularies into the BizTalk database.
- Imports, deploys and undeploys BRE rules into the BizTalk database.
- Installs BizTalk and plain assemblies in the Global Assembly Cache (GAC) on every BizTalk server (host).
Requirements
Deployit requirements:
- Deployit version 3.8.4 or higher.
Infrastructural requirements for the target machine:
- Administrative access (with elevated privileges) is required to run the PowerShell provider for BizTalk.
- N.B.: When the machine that runs the PowerShell provider for BizTalk is accessed over WinRM and is then used to connect to a third machine, an error such as
Login failed for user 'NT AUTHORITY\ANONYMOUS LOGON'may appear. Either install the PowerShell provider for BizTalk on all machines that run the BizTalk database, or install it on the machine the runs Deployit and use anoverthere.LocalHostto access it.
- N.B.: When the machine that runs the PowerShell provider for BizTalk is accessed over WinRM and is then used to connect to a third machine, an error such as
- PowerShell 2.0 must be installed.
- The 32-bit version of the PowerShell executable must be configured to run with .NET 4.0 (see below).
- The BizTalkFactory PowerShell Provider for BizTalk Server 2010 must be installed.
- Administrative access (with elevated privileges) is required to run the PowerShell provider for BizTalk.
Configure the 32-bit version of PowerShell to run with .NET 4.0
On the machine that runs the PowerShell provider for BizTalk, create the file C:\Windows\SysWOW64\WindowsPowerShell\v1.0\powershell.exe.config with the following content:
<?xml version="1.0"?>
<configuration>
<startup useLegacyV2RuntimeActivationPolicy="true">
<supportedRuntime version="v4.0.30319"/>
<supportedRuntime version="v2.0.50727"/>
</startup>
</configuration>
Release Notes
3.9.0
- Bugs fixed:
- DEPLOYITPB-4297 - Retrieving full assembly name from the assembly file when removing the assembly.
3.8.0
- Initial release of BizTalk plugin for BizTalk Server 2010.
Usage in deployment packages
The plugin works with the standard deployment package DAR format. Please see the Packaging Manual for more details about the DAR format and the ways to compose one. The following is a sample MANIFEST.MF file that includes a few of the deployables provided by the BizTalk plugin:
Manifest-Version: 1.0
Deployit-Package-Format-Version: 1.3
CI-Application: BizTalkApp1
CI-Version: 1.0
Name: BizTalkApp1
CI-Type: biztalk.ApplicationSpec
Name: BizTalkApp1.Schemas.dll
CI-Type: biztalk.BizTalkAssemblyFile
CI-applicationName: BizTalkApp1
CI-destinationPath: {{ASSEMBLY_DESTINATION_DIR}}\BizTalkApp1.Sche
mas.dll
Name: BizTalkApp1.dll
CI-Type: biztalk.BizTalkAssemblyFile
CI-applicationName: BizTalkApp1
CI-destinationPath: {{ASSEMBLY_DESTINATION_DIR}}\BizTalkApp1.dll
Name: BizTalkApp1.BindingInfo.xml
CI-Type: biztalk.BindingsFile
CI-applicationName: BizTalkApp1
Name: BizTalkApp1.1.0.Vocabulary.xml
CI-Type: biztalk.VocabularyFile
CI-applicationName: All policies
Name: BizTalkApp1.Rule.1.0.xml
CI-Type: biztalk.RulesFile
CI-applicationName: All policies
Using the deployables and deployeds
Deployable vs. Container table
The following table describes which deployable/container combinations are possible:
| Deployable | Container | Generated deployed |
|---|---|---|
| biztalk.ApplicationSpec | biztalk.Database | biztalk.Application |
| biztalk.AssemblyFile | biztalk.Database | biztalk.Assembly |
| biztalk.AssemblyFile | biztalk.Server | biztalk.InstalledAssembly |
| biztalk.BindingsFile | biztalk.Database | biztalk.Bindings |
| biztalk.BizTalkAssemblyFile | biztalk.Database | biztalk.BizTalkAssembly |
| biztalk.BizTalkAssemblyFile | biztalk.Server | biztalk.InstalledAssembly |
| biztalk.RulesFile | biztalk.Database | biztalk.Rules |
| biztalk.VocabularyFile | biztalk.Database | biztalk.Vocabulary |
Deployed Actions Table
The following table describes the effect a deployed has on its container:
| Deployed | Actions performed for operations | |||
|---|---|---|---|---|
| Create | Destroy | Modify | ||
| biztalk.Application |
|
|
|
|
| biztalk.Assembly |
|
|
|
|
| biztalk.Bidings |
|
|
||
| biztalk.BizTalkAssembly |
|
|
|
|
| biztalk.InstalledAssembly |
|
|
||
| biztalk.Rules |
|
|
|
|
| biztalk.Vocabulary |
|
|
||
Extending the BizTalk plugin
The BizTalk plugin has been written upon the foundations provided by the PowerShell plugin, which is a standard part of the Deployit server distribution. Please refer to the documentation of the PowerShell plugin for details on how to extend PowerShell-based plugins.
CI Reference
Configuration Item Overview
Deployables
| CI | Description |
|---|---|
| biztalk.ApplicationSpec | Specification for a BizTalk application |
| biztalk.AssemblyFile | Assembly file (DLL) |
| biztalk.BaseAssemblyFile | Base class for (BizTalk) assembly file (DLL) |
| biztalk.BindingsFile | BizTalk bindings file (XML) |
| biztalk.BizTalkAssemblyFile | BizTalk assembly file (DLL) |
| biztalk.RulesFile | BizTalk BRE rules file (XML) |
| biztalk.VocabularyFile | BizTalk BRE vocabulary file (XML) |
Deployeds
| CI | Description |
|---|---|
| biztalk.Application | BizTalk application |
| biztalk.Assembly | Registered assembly |
| biztalk.BaseAssembly | Base class for registered (BizTalk) assembly |
| biztalk.Bindings | BizTalk bindings |
| biztalk.BizTalkAssembly | Registered BizTalk assembly |
| biztalk.InstalledAssembly | Installed (BizTalk) assembly |
| biztalk.Rules | BizTalk BRE rules |
| biztalk.Vocabulary | BizTalk BRE vocabulary |
Containers
| CI | Description |
|---|---|
| biztalk.Database | BizTalk database |
| biztalk.Server | BizTalk server |
Other Configuration Items
| CI | Description |
|---|---|
| biztalk.Application | BizTalk application |
| biztalk.ApplicationSpec | Specification for a BizTalk application |
| biztalk.Assembly | Registered assembly |
| biztalk.AssemblyFile | Assembly file (DLL) |
| biztalk.BaseAssembly | Base class for registered (BizTalk) assembly |
| biztalk.BaseAssemblyFile | Base class for (BizTalk) assembly file (DLL) |
| biztalk.Bindings | BizTalk bindings |
| biztalk.BindingsFile | BizTalk bindings file (XML) |
| biztalk.BizTalkAssembly | Registered BizTalk assembly |
| biztalk.BizTalkAssemblyFile | BizTalk assembly file (DLL) |
| biztalk.Database | BizTalk database |
| biztalk.InstalledAssembly | Installed (BizTalk) assembly |
| biztalk.Rules | BizTalk BRE rules |
| biztalk.RulesFile | BizTalk BRE rules file (XML) |
| biztalk.Server | BizTalk server |
| biztalk.Vocabulary | BizTalk BRE vocabulary |
| biztalk.VocabularyFile | BizTalk BRE vocabulary file (XML) |
Configuration Item Details
biztalk.Application
| Type Hierarchy | powershell.ExtensiblePowerShellDeployed >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
BizTalk application
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
applicationName
:
STRING
|
|
Name of this application. Defaults to the name of the deployed if not specified
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
stopStartOnNoop
:
BOOLEAN
= false
|
|
If set to true, this application is stopped and started when another component in the same package is deployed
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
createOrder
:
INTEGER
= 56
|
|
Order at which the create step will be executed.
|
||
|
|
|
createScript
:
STRING
= biztalk/create-application.ps1
|
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
|
createVerb
:
STRING
= Create
|
|
Verb that is used to prefix the description for the create step.
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [none]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
destroyOrder
:
INTEGER
= 44
|
|
Order at which the destroy step will be executed.
|
||
|
|
|
destroyScript
:
STRING
= biztalk/destroy-application.ps1
|
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
Order at which the discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
modifyOrder
:
INTEGER
= 60
|
|
Order at which the modify step will be executed.
|
||
|
|
|
modifyVerb
:
STRING
= Modify
|
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [none]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
noopOrder
:
INTEGER
= 50
|
|
Order at which the noop step will be executed.
|
||
|
|
|
noopVerb
:
STRING
= Noop
|
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
|
startOptions
:
SET_OF_STRING
= [none]
|
|
Options for the start step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
startOrder
:
INTEGER
= 90
|
|
Order at which the start step will be executed.
|
||
|
|
|
startScript
:
STRING
= biztalk/start-application.ps1
|
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
|
startVerb
:
STRING
= Start
|
|
Verb that is used to prefix the description for the start step.
|
||
|
|
|
stopOptions
:
SET_OF_STRING
= [none]
|
|
Options for the stop step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
stopOrder
:
INTEGER
= 10
|
|
Order at which the stop script will be executed.
|
||
|
|
|
stopScript
:
STRING
= biztalk/stop-application.ps1
|
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
||
|
|
|
stopVerb
:
STRING
= Stop
|
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
|
discoverScript
:
STRING
|
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to append to the the step script.
|
||
|
|
|
modifyScript
:
STRING
|
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
|
noopScript
:
STRING
|
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
biztalk.ApplicationSpec
| Type Hierarchy | powershell.BasePowerShellDeployable >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem |
Specification for a BizTalk application
| Public Properties | ||
|---|---|---|
|
|
|
applicationName
:
STRING
|
|
Name of this application. Defaults to the name of the deployed if not specified (string)
|
||
|
|
|
stopStartOnNoop
:
STRING
|
|
If set to true, this application is stopped and started when another component in the same package is deployed (boolean)
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
biztalk.Assembly
| Type Hierarchy | biztalk.BaseAssembly >> powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact |
Registered assembly
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
applicationName
:
STRING
|
|
Application Name
|
||
|
|
|
destinationPath
:
STRING
|
|
Destination Path
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
gacOnAdd
:
BOOLEAN
|
|
Add to the global assembly cache on add resource (gacutil)
|
||
|
|
|
gacOnImport
:
BOOLEAN
|
|
Add to the global assembly cache on MSI file import (gacutil)
|
||
|
|
|
gacOnInstall
:
BOOLEAN
|
|
Add to the global assembly cache on MSI file install (gacutil)
|
||
|
|
|
overwrite
:
BOOLEAN
|
|
Overwrite
|
||
|
|
|
placeholders
:
MAP_STRING_STRING
|
|
A Map containing all the placeholders mapped to their values. Special values are
|
||
|
|
|
regAsm
:
BOOLEAN
|
|
Make visible to COM components (regasm)
|
||
|
|
|
regSvcs
:
BOOLEAN
|
|
Register serviced components (regsvcs)
|
||
|
|
|
sourcePath
:
STRING
|
|
Source Path
|
| Hidden Properties | ||
|---|---|---|
|
|
|
assemblyType
:
STRING
= System.BizTalk:Assembly
|
|
Assembly Type
|
||
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
createOrder
:
INTEGER
= 58
|
|
Order at which the create step will be executed.
|
||
|
|
|
createScript
:
STRING
= biztalk/add-assembly.ps1
|
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
|
createVerb
:
STRING
= Add
|
|
Verb that is used to prefix the description for the create step.
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
destroyOrder
:
INTEGER
= 42
|
|
Order at which the destroy step will be executed.
|
||
|
|
|
destroyScript
:
STRING
= biztalk/remove-assembly.ps1
|
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
|
destroyVerb
:
STRING
= Remove
|
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
Order at which the discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
modifyOrder
:
INTEGER
= 60
|
|
Order at which the modify step will be executed.
|
||
|
|
|
modifyVerb
:
STRING
= Modify
|
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [none]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
noopOrder
:
INTEGER
= 50
|
|
Order at which the noop step will be executed.
|
||
|
|
|
noopVerb
:
STRING
= Noop
|
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
|
startOptions
:
SET_OF_STRING
= [none]
|
|
Options for the start step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
startOrder
:
INTEGER
= 90
|
|
Order at which the start step will be executed.
|
||
|
|
|
startVerb
:
STRING
= Start
|
|
Verb that is used to prefix the description for the start step.
|
||
|
|
|
stopOptions
:
SET_OF_STRING
= [none]
|
|
Options for the stop step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
stopOrder
:
INTEGER
= 10
|
|
Order at which the stop script will be executed.
|
||
|
|
|
stopVerb
:
STRING
= Stop
|
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
|
discoverScript
:
STRING
|
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to append to the the step script.
|
||
|
|
|
modifyScript
:
STRING
|
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
|
noopScript
:
STRING
|
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
||
|
|
|
startScript
:
STRING
|
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
|
stopScript
:
STRING
|
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
||
|
|
|
stopStartOnNoop
:
BOOLEAN
= false
|
|
If set to true, the stop and start scripts will be executed even if this deployable was not changed.
|
biztalk.AssemblyFile
| Type Hierarchy | biztalk.BaseAssemblyFile >> powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact |
Assembly file (DLL)
| Public Properties | ||
|---|---|---|
|
|
|
applicationName
:
STRING
|
|
Application Name (string)
|
||
|
|
|
checksum
:
STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by Deployit.
|
||
|
|
|
destinationPath
:
STRING
|
|
Destination Path (string)
|
||
|
|
|
excludeFileNamesRegex
:
STRING
|
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
|
gacOnAdd
:
STRING
|
|
Add to the global assembly cache on add resource (gacutil) (boolean)
|
||
|
|
|
gacOnImport
:
STRING
|
|
Add to the global assembly cache on MSI file import (gacutil) (boolean)
|
||
|
|
|
gacOnInstall
:
STRING
|
|
Add to the global assembly cache on MSI file install (gacutil) (boolean)
|
||
|
|
|
overwrite
:
STRING
|
|
Overwrite (boolean)
|
||
|
|
|
placeholders
:
SET_OF_STRING
|
|
Placeholders detected in this artifact
|
||
|
|
|
regAsm
:
STRING
|
|
Make visible to COM components (regasm) (boolean)
|
||
|
|
|
regSvcs
:
STRING
|
|
Register serviced components (regsvcs) (boolean)
|
||
|
|
|
scanPlaceholders
:
BOOLEAN
= true
|
|
Whether to scan this artifact for placeholders when it is imported
|
||
|
|
|
sourcePath
:
STRING
|
|
Source Path (string)
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
| Hidden Properties | ||
|---|---|---|
|
|
|
textFileNamesRegex
:
STRING
= .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|
|
Regular expression that matches file names of text files
|
||
|
|
|
delimiters
:
STRING
= {{ }}
|
|
The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|
biztalk.BaseAssembly
| Virtual Type | |
|---|---|
| Type Hierarchy | powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
| Interfaces | udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact |
Base class for registered (BizTalk) assembly
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
applicationName
:
STRING
|
|
Application Name
|
||
|
|
|
destinationPath
:
STRING
|
|
Destination Path
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
gacOnAdd
:
BOOLEAN
|
|
Add to the global assembly cache on add resource (gacutil)
|
||
|
|
|
gacOnImport
:
BOOLEAN
|
|
Add to the global assembly cache on MSI file import (gacutil)
|
||
|
|
|
gacOnInstall
:
BOOLEAN
|
|
Add to the global assembly cache on MSI file install (gacutil)
|
||
|
|
|
overwrite
:
BOOLEAN
|
|
Overwrite
|
||
|
|
|
placeholders
:
MAP_STRING_STRING
|
|
A Map containing all the placeholders mapped to their values. Special values are
|
||
|
|
|
sourcePath
:
STRING
|
|
Source Path
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
createOrder
:
INTEGER
= 58
|
|
Order at which the create step will be executed.
|
||
|
|
|
createScript
:
STRING
= biztalk/add-assembly.ps1
|
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
|
createVerb
:
STRING
= Add
|
|
Verb that is used to prefix the description for the create step.
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
destroyOrder
:
INTEGER
= 42
|
|
Order at which the destroy step will be executed.
|
||
|
|
|
destroyScript
:
STRING
= biztalk/remove-assembly.ps1
|
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
|
destroyVerb
:
STRING
= Remove
|
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
Order at which the discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
modifyOrder
:
INTEGER
= 60
|
|
Order at which the modify step will be executed.
|
||
|
|
|
modifyVerb
:
STRING
= Modify
|
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [none]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
noopOrder
:
INTEGER
= 50
|
|
Order at which the noop step will be executed.
|
||
|
|
|
noopVerb
:
STRING
= Noop
|
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
|
startOptions
:
SET_OF_STRING
= [none]
|
|
Options for the start step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
startOrder
:
INTEGER
= 90
|
|
Order at which the start step will be executed.
|
||
|
|
|
startVerb
:
STRING
= Start
|
|
Verb that is used to prefix the description for the start step.
|
||
|
|
|
stopOptions
:
SET_OF_STRING
= [none]
|
|
Options for the stop step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
stopOrder
:
INTEGER
= 10
|
|
Order at which the stop script will be executed.
|
||
|
|
|
stopVerb
:
STRING
= Stop
|
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
|
discoverScript
:
STRING
|
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to append to the the step script.
|
||
|
|
|
modifyScript
:
STRING
|
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
|
noopScript
:
STRING
|
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
||
|
|
|
startScript
:
STRING
|
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
|
stopScript
:
STRING
|
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
||
|
|
|
stopStartOnNoop
:
BOOLEAN
= false
|
|
If set to true, the stop and start scripts will be executed even if this deployable was not changed.
|
biztalk.BaseAssemblyFile
| Type Hierarchy | powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact |
Base class for (BizTalk) assembly file (DLL)
| Public Properties | ||
|---|---|---|
|
|
|
applicationName
:
STRING
|
|
Application Name (string)
|
||
|
|
|
checksum
:
STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by Deployit.
|
||
|
|
|
destinationPath
:
STRING
|
|
Destination Path (string)
|
||
|
|
|
excludeFileNamesRegex
:
STRING
|
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
|
gacOnAdd
:
STRING
|
|
Add to the global assembly cache on add resource (gacutil) (boolean)
|
||
|
|
|
gacOnImport
:
STRING
|
|
Add to the global assembly cache on MSI file import (gacutil) (boolean)
|
||
|
|
|
gacOnInstall
:
STRING
|
|
Add to the global assembly cache on MSI file install (gacutil) (boolean)
|
||
|
|
|
overwrite
:
STRING
|
|
Overwrite (boolean)
|
||
|
|
|
placeholders
:
SET_OF_STRING
|
|
Placeholders detected in this artifact
|
||
|
|
|
scanPlaceholders
:
BOOLEAN
= true
|
|
Whether to scan this artifact for placeholders when it is imported
|
||
|
|
|
sourcePath
:
STRING
|
|
Source Path (string)
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
| Hidden Properties | ||
|---|---|---|
|
|
|
textFileNamesRegex
:
STRING
= .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|
|
Regular expression that matches file names of text files
|
||
|
|
|
delimiters
:
STRING
= {{ }}
|
|
The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|
biztalk.Bindings
| Type Hierarchy | powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact |
BizTalk bindings
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
applicationName
:
STRING
|
|
Application Name
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
placeholders
:
MAP_STRING_STRING
|
|
A Map containing all the placeholders mapped to their values. Special values are
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
createOrder
:
INTEGER
= 60
|
|
Order at which the create step will be executed.
|
||
|
|
|
createScript
:
STRING
= biztalk/import-bindings.ps1
|
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
|
createVerb
:
STRING
= Import
|
|
Verb that is used to prefix the description for the create step.
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [none]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
Order at which the destroy step will be executed.
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
Order at which the discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
modifyOrder
:
INTEGER
= 60
|
|
Order at which the modify step will be executed.
|
||
|
|
|
modifyVerb
:
STRING
= Modify
|
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [none]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
noopOrder
:
INTEGER
= 50
|
|
Order at which the noop step will be executed.
|
||
|
|
|
noopVerb
:
STRING
= Noop
|
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
|
startOptions
:
SET_OF_STRING
= [none]
|
|
Options for the start step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
startOrder
:
INTEGER
= 90
|
|
Order at which the start step will be executed.
|
||
|
|
|
startVerb
:
STRING
= Start
|
|
Verb that is used to prefix the description for the start step.
|
||
|
|
|
stopOptions
:
SET_OF_STRING
= [none]
|
|
Options for the stop step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
stopOrder
:
INTEGER
= 10
|
|
Order at which the stop script will be executed.
|
||
|
|
|
stopVerb
:
STRING
= Stop
|
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
|
destroyScript
:
STRING
|
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
|
discoverScript
:
STRING
|
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to append to the the step script.
|
||
|
|
|
modifyScript
:
STRING
|
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
|
noopScript
:
STRING
|
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
||
|
|
|
startScript
:
STRING
|
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
|
stopScript
:
STRING
|
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
||
|
|
|
stopStartOnNoop
:
BOOLEAN
= false
|
|
If set to true, the stop and start scripts will be executed even if this deployable was not changed.
|
biztalk.BindingsFile
| Type Hierarchy | powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact |
BizTalk bindings file (XML)
| Public Properties | ||
|---|---|---|
|
|
|
applicationName
:
STRING
|
|
Application Name (string)
|
||
|
|
|
checksum
:
STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by Deployit.
|
||
|
|
|
excludeFileNamesRegex
:
STRING
|
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
|
placeholders
:
SET_OF_STRING
|
|
Placeholders detected in this artifact
|
||
|
|
|
scanPlaceholders
:
BOOLEAN
= true
|
|
Whether to scan this artifact for placeholders when it is imported
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
| Hidden Properties | ||
|---|---|---|
|
|
|
textFileNamesRegex
:
STRING
= .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|
|
Regular expression that matches file names of text files
|
||
|
|
|
delimiters
:
STRING
= {{ }}
|
|
The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|
biztalk.BizTalkAssembly
| Type Hierarchy | biztalk.BaseAssembly >> powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact |
Registered BizTalk assembly
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
applicationName
:
STRING
|
|
Application Name
|
||
|
|
|
destinationPath
:
STRING
|
|
Destination Path
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
gacOnAdd
:
BOOLEAN
|
|
Add to the global assembly cache on add resource (gacutil)
|
||
|
|
|
gacOnImport
:
BOOLEAN
|
|
Add to the global assembly cache on MSI file import (gacutil)
|
||
|
|
|
gacOnInstall
:
BOOLEAN
|
|
Add to the global assembly cache on MSI file install (gacutil)
|
||
|
|
|
overwrite
:
BOOLEAN
|
|
Overwrite
|
||
|
|
|
placeholders
:
MAP_STRING_STRING
|
|
A Map containing all the placeholders mapped to their values. Special values are
|
||
|
|
|
sourcePath
:
STRING
|
|
Source Path
|
| Hidden Properties | ||
|---|---|---|
|
|
|
assemblyType
:
STRING
= System.BizTalk:BizTalkAssembly
|
|
Assembly Type
|
||
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
createOrder
:
INTEGER
= 58
|
|
Order at which the create step will be executed.
|
||
|
|
|
createScript
:
STRING
= biztalk/add-assembly.ps1
|
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
|
createVerb
:
STRING
= Add
|
|
Verb that is used to prefix the description for the create step.
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
destroyOrder
:
INTEGER
= 42
|
|
Order at which the destroy step will be executed.
|
||
|
|
|
destroyScript
:
STRING
= biztalk/remove-assembly.ps1
|
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
|
destroyVerb
:
STRING
= Remove
|
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
Order at which the discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
modifyOrder
:
INTEGER
= 60
|
|
Order at which the modify step will be executed.
|
||
|
|
|
modifyVerb
:
STRING
= Modify
|
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [none]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
noopOrder
:
INTEGER
= 50
|
|
Order at which the noop step will be executed.
|
||
|
|
|
noopVerb
:
STRING
= Noop
|
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
|
startOptions
:
SET_OF_STRING
= [none]
|
|
Options for the start step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
startOrder
:
INTEGER
= 90
|
|
Order at which the start step will be executed.
|
||
|
|
|
startVerb
:
STRING
= Start
|
|
Verb that is used to prefix the description for the start step.
|
||
|
|
|
stopOptions
:
SET_OF_STRING
= [none]
|
|
Options for the stop step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
stopOrder
:
INTEGER
= 10
|
|
Order at which the stop script will be executed.
|
||
|
|
|
stopVerb
:
STRING
= Stop
|
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
|
discoverScript
:
STRING
|
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to append to the the step script.
|
||
|
|
|
modifyScript
:
STRING
|
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
|
noopScript
:
STRING
|
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
||
|
|
|
startScript
:
STRING
|
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
|
stopScript
:
STRING
|
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
||
|
|
|
stopStartOnNoop
:
BOOLEAN
= false
|
|
If set to true, the stop and start scripts will be executed even if this deployable was not changed.
|
biztalk.BizTalkAssemblyFile
| Type Hierarchy | biztalk.BaseAssemblyFile >> powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact |
BizTalk assembly file (DLL)
| Public Properties | ||
|---|---|---|
|
|
|
applicationName
:
STRING
|
|
Application Name (string)
|
||
|
|
|
checksum
:
STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by Deployit.
|
||
|
|
|
destinationPath
:
STRING
|
|
Destination Path (string)
|
||
|
|
|
excludeFileNamesRegex
:
STRING
|
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
|
gacOnAdd
:
STRING
|
|
Add to the global assembly cache on add resource (gacutil) (boolean)
|
||
|
|
|
gacOnImport
:
STRING
|
|
Add to the global assembly cache on MSI file import (gacutil) (boolean)
|
||
|
|
|
gacOnInstall
:
STRING
|
|
Add to the global assembly cache on MSI file install (gacutil) (boolean)
|
||
|
|
|
overwrite
:
STRING
|
|
Overwrite (boolean)
|
||
|
|
|
placeholders
:
SET_OF_STRING
|
|
Placeholders detected in this artifact
|
||
|
|
|
scanPlaceholders
:
BOOLEAN
= true
|
|
Whether to scan this artifact for placeholders when it is imported
|
||
|
|
|
sourcePath
:
STRING
|
|
Source Path (string)
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
| Hidden Properties | ||
|---|---|---|
|
|
|
textFileNamesRegex
:
STRING
= .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|
|
Regular expression that matches file names of text files
|
||
|
|
|
delimiters
:
STRING
= {{ }}
|
|
The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|
biztalk.Database
| Type Hierarchy | powershell.BasePowerShellContainer >> udm.BaseContainer >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Taggable, powershell.PowerShellContainer, udm.ConfigurationItem, udm.Container, overthere.HostContainer |
BizTalk database
| Parent | ||
|---|---|---|
|
|
|
host
:
CI<overthere.Host>
|
|
Host upon which the container resides
|
| Public Properties | ||
|---|---|---|
|
|
|
databaseName
:
STRING
= BizTalkMgmtDb
|
|
Database Name
|
||
|
|
|
instanceName
:
STRING
|
|
Instance Name
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, only deployables with the same tag will be automatically mapped to this container.
|
| Hidden Properties | ||
|---|---|---|
|
|
|
discoverOrder
:
INTEGER
= 0
|
|
Order at which the discover step will be executed.
|
||
|
|
|
powerShellPath
:
STRING
= C:\Windows\SysWOW64\WindowsPowerShell\v1.0\powershell.exe
|
|
Power Shell Path
|
||
|
|
|
runtimePath
:
STRING
= biztalk/runtime
|
|
Runtime Path
|
||
|
|
|
deployedsToDiscover
:
SET_OF_STRING
|
|
Deployeds To Discover
|
||
|
|
|
discoverScript
:
STRING
|
|
Script invoked to inspect this container and discover deployeds on it.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
= [powershell/runtime/base.ps1]
|
|
List of scripts to append to the the step script.
|
biztalk.InstalledAssembly
| Type Hierarchy | powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact |
Installed (BizTalk) assembly
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
placeholders
:
MAP_STRING_STRING
|
|
A Map containing all the placeholders mapped to their values. Special values are
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
createOrder
:
INTEGER
= 59
|
|
Order at which the create step will be executed.
|
||
|
|
|
createScript
:
STRING
= biztalk/install-assembly.ps1
|
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
|
createVerb
:
STRING
= Install
|
|
Verb that is used to prefix the description for the create step.
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [none]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
Order at which the destroy step will be executed.
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
Order at which the discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
modifyOrder
:
INTEGER
= 60
|
|
Order at which the modify step will be executed.
|
||
|
|
|
modifyVerb
:
STRING
= Modify
|
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [none]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
noopOrder
:
INTEGER
= 50
|
|
Order at which the noop step will be executed.
|
||
|
|
|
noopVerb
:
STRING
= Noop
|
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
|
startOptions
:
SET_OF_STRING
= [none]
|
|
Options for the start step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
startOrder
:
INTEGER
= 90
|
|
Order at which the start step will be executed.
|
||
|
|
|
startVerb
:
STRING
= Start
|
|
Verb that is used to prefix the description for the start step.
|
||
|
|
|
stopOptions
:
SET_OF_STRING
= [none]
|
|
Options for the stop step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
stopOrder
:
INTEGER
= 10
|
|
Order at which the stop script will be executed.
|
||
|
|
|
stopVerb
:
STRING
= Stop
|
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
|
destroyScript
:
STRING
|
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
|
discoverScript
:
STRING
|
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to append to the the step script.
|
||
|
|
|
modifyScript
:
STRING
|
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
|
noopScript
:
STRING
|
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
||
|
|
|
startScript
:
STRING
|
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
|
stopScript
:
STRING
|
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
||
|
|
|
stopStartOnNoop
:
BOOLEAN
= false
|
|
If set to true, the stop and start scripts will be executed even if this deployable was not changed.
|
biztalk.Rules
| Type Hierarchy | powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact |
BizTalk BRE rules
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
applicationName
:
STRING
|
|
Application Name
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
placeholders
:
MAP_STRING_STRING
|
|
A Map containing all the placeholders mapped to their values. Special values are
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
createOrder
:
INTEGER
= 60
|
|
Order at which the create step will be executed.
|
||
|
|
|
createScript
:
STRING
= biztalk/import-and-deploy-rules.ps1
|
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
|
createVerb
:
STRING
= Import and deploy
|
|
Verb that is used to prefix the description for the create step.
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [none]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
Order at which the destroy step will be executed.
|
||
|
|
|
destroyScript
:
STRING
= biztalk/undeploy-rules.ps1
|
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
|
destroyVerb
:
STRING
= Undeploy
|
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
Order at which the discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
modifyOrder
:
INTEGER
= 60
|
|
Order at which the modify step will be executed.
|
||
|
|
|
modifyVerb
:
STRING
= Modify
|
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [none]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
noopOrder
:
INTEGER
= 50
|
|
Order at which the noop step will be executed.
|
||
|
|
|
noopVerb
:
STRING
= Noop
|
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
|
startOptions
:
SET_OF_STRING
= [none]
|
|
Options for the start step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
startOrder
:
INTEGER
= 90
|
|
Order at which the start step will be executed.
|
||
|
|
|
startVerb
:
STRING
= Start
|
|
Verb that is used to prefix the description for the start step.
|
||
|
|
|
stopOptions
:
SET_OF_STRING
= [none]
|
|
Options for the stop step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
stopOrder
:
INTEGER
= 10
|
|
Order at which the stop script will be executed.
|
||
|
|
|
stopVerb
:
STRING
= Stop
|
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
|
discoverScript
:
STRING
|
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to append to the the step script.
|
||
|
|
|
modifyScript
:
STRING
|
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
|
noopScript
:
STRING
|
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
||
|
|
|
startScript
:
STRING
|
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
|
stopScript
:
STRING
|
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
||
|
|
|
stopStartOnNoop
:
BOOLEAN
= false
|
|
If set to true, the stop and start scripts will be executed even if this deployable was not changed.
|
biztalk.RulesFile
| Type Hierarchy | powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact |
BizTalk BRE rules file (XML)
| Public Properties | ||
|---|---|---|
|
|
|
applicationName
:
STRING
|
|
Application Name (string)
|
||
|
|
|
checksum
:
STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by Deployit.
|
||
|
|
|
excludeFileNamesRegex
:
STRING
|
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
|
placeholders
:
SET_OF_STRING
|
|
Placeholders detected in this artifact
|
||
|
|
|
scanPlaceholders
:
BOOLEAN
= true
|
|
Whether to scan this artifact for placeholders when it is imported
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
| Hidden Properties | ||
|---|---|---|
|
|
|
textFileNamesRegex
:
STRING
= .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|
|
Regular expression that matches file names of text files
|
||
|
|
|
delimiters
:
STRING
= {{ }}
|
|
The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|
biztalk.Server
| Type Hierarchy | powershell.BasePowerShellContainer >> udm.BaseContainer >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Taggable, powershell.PowerShellContainer, udm.ConfigurationItem, udm.Container, overthere.HostContainer |
BizTalk server
| Parent | ||
|---|---|---|
|
|
|
host
:
CI<overthere.Host>
|
|
Host upon which the container resides
|
| Public Properties | ||
|---|---|---|
|
|
|
tags
:
SET_OF_STRING
|
|
If set, only deployables with the same tag will be automatically mapped to this container.
|
| Hidden Properties | ||
|---|---|---|
|
|
|
discoverOrder
:
INTEGER
= 0
|
|
Order at which the discover step will be executed.
|
||
|
|
|
powerShellPath
:
STRING
= C:\Windows\SysWOW64\WindowsPowerShell\v1.0\powershell.exe
|
|
Power Shell Path
|
||
|
|
|
deployedsToDiscover
:
SET_OF_STRING
|
|
Deployeds To Discover
|
||
|
|
|
discoverScript
:
STRING
|
|
Script invoked to inspect this container and discover deployeds on it.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
= [powershell/runtime/base.ps1]
|
|
List of scripts to append to the the step script.
|
biztalk.Vocabulary
| Type Hierarchy | powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact |
BizTalk BRE vocabulary
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
applicationName
:
STRING
|
|
Application Name
|
||
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
placeholders
:
MAP_STRING_STRING
|
|
A Map containing all the placeholders mapped to their values. Special values are
|
| Hidden Properties | ||
|---|---|---|
|
|
|
createOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
createOrder
:
INTEGER
= 58
|
|
Order at which the create step will be executed.
|
||
|
|
|
createScript
:
STRING
= biztalk/import-vocabulary.ps1
|
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
|
createVerb
:
STRING
= Import
|
|
Verb that is used to prefix the description for the create step.
|
||
|
|
|
destroyOptions
:
SET_OF_STRING
= [none]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
destroyOrder
:
INTEGER
= 40
|
|
Order at which the destroy step will be executed.
|
||
|
|
|
destroyVerb
:
STRING
= Destroy
|
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
|
discoverOrder
:
INTEGER
= 50
|
|
Order at which the discover step will be executed.
|
||
|
|
|
modifyOptions
:
SET_OF_STRING
= [uploadArtifactData]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
modifyOrder
:
INTEGER
= 60
|
|
Order at which the modify step will be executed.
|
||
|
|
|
modifyVerb
:
STRING
= Modify
|
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
|
noopOptions
:
SET_OF_STRING
= [none]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
noopOrder
:
INTEGER
= 50
|
|
Order at which the noop step will be executed.
|
||
|
|
|
noopVerb
:
STRING
= Noop
|
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
|
startOptions
:
SET_OF_STRING
= [none]
|
|
Options for the start step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
startOrder
:
INTEGER
= 90
|
|
Order at which the start step will be executed.
|
||
|
|
|
startVerb
:
STRING
= Start
|
|
Verb that is used to prefix the description for the start step.
|
||
|
|
|
stopOptions
:
SET_OF_STRING
= [none]
|
|
Options for the stop step (1 or more of: none,uploadArtifactData,exposePreviousDeployed,exposeDeployedApplication).
|
||
|
|
|
stopOrder
:
INTEGER
= 10
|
|
Order at which the stop script will be executed.
|
||
|
|
|
stopVerb
:
STRING
= Stop
|
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
|
destroyScript
:
STRING
|
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
|
discoverScript
:
STRING
|
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
|
libraryScripts
:
LIST_OF_STRING
|
|
List of scripts to append to the the step script.
|
||
|
|
|
modifyScript
:
STRING
|
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
|
noopScript
:
STRING
|
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
||
|
|
|
startScript
:
STRING
|
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
|
stopScript
:
STRING
|
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
||
|
|
|
stopStartOnNoop
:
BOOLEAN
= false
|
|
If set to true, the stop and start scripts will be executed even if this deployable was not changed.
|
biztalk.VocabularyFile
| Type Hierarchy | powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact |
BizTalk BRE vocabulary file (XML)
| Public Properties | ||
|---|---|---|
|
|
|
applicationName
:
STRING
|
|
Application Name (string)
|
||
|
|
|
checksum
:
STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by Deployit.
|
||
|
|
|
excludeFileNamesRegex
:
STRING
|
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
|
placeholders
:
SET_OF_STRING
|
|
Placeholders detected in this artifact
|
||
|
|
|
scanPlaceholders
:
BOOLEAN
= true
|
|
Whether to scan this artifact for placeholders when it is imported
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
| Hidden Properties | ||
|---|---|---|
|
|
|
textFileNamesRegex
:
STRING
= .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|
|
Regular expression that matches file names of text files
|
||
|
|
|
delimiters
:
STRING
= {{ }}
|
|
The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|
