Add-AzureBizTalkArtifactTransform
Important
Microsoft Azure BizTalk Services (MABS) is being retired, and replaced with Azure Logic Apps. If you currently use MABS, then Move from BizTalk Services to Logic Appsprovides some guidance on moving your integration solutions to Logic Apps.
If you're brand new to Logic Apps, then we suggest getting started here:
-
Create your first logic app, or quickly get started using a pre-built template
-
View all the available connectors you can use in your logic apps
The Add-AzureBizTalkArtifactTransform adds a transform to the artifact store for the service namespace you enter.
Syntax
Add-AzureBizTalkArtifactTransform –AcsNamespace <AcsNamespace> -IssuerName <IssuerName> -IssuerKey <IssuerKey> –DeploymentUri <DeploymentUri> -ArtifactPath <ArtifactPath> -FilePath <FilePath> [-Overwrite] [<CommonParameters>]
Parameters
Parameter |
Requirement |
Description |
|---|---|---|
-AcsNamespace <AcsNamespace> |
Required |
The Access Control namespace associated with BizTalk Services. |
-IssuerName <IssuerName> |
Required |
The Access Control issuer name. Specifying incorrect Access Control credentials results in an authentication error. |
-IssuerKey <IssuerKey> |
Required |
The Access Control issuer key. Specifying incorrect Access Control credentials results in an authentication error. |
-DeploymentUri <DeploymentUri> |
Required |
The deployment URI for BizTalk Services. For example, https://myDeploymentUri.biztalk.windows.net/default/. Specifying an incorrect URL will result in an ObjectNotFound error. |
-ArtifactPath <ArtifactPath> |
Required |
The complete artifact path in the artifact store. |
-FilePath <FilePath> |
Required |
The complete path to the artifact file to be uploaded. |
[-Overwrite] |
Optional |
A flag that specifies whether the existing artifacts in the artifact store must be overwritten. If an artifact already exists with the same name or at the same path, a ResourceExists error is thrown, unless the Overwrite parameter is passed. |
[CommonParameters] |
Optional |
Can be used with any cmdlet and are implemented by Windows PowerShell. Options include:
get-help about_commonparameters provides detailed information about these common parameters. about_CommonParameters is also a good resource. |
Examples
Successfully add a transform artifact
Add-AzureBizTalkArtifactTransform –AcsNamespace myACS -IssuerName owner -IssuerKey <issuer key> –DeploymentUri https://myDeploymentUri.biztalk.windows.net/default -ArtifactPath Samples/GettingStarted/map.trfm -FilePath C:\MyLocation\map.trfm
Output
Successfully added artifact ‘map.trfm’ to Artifact Store at https://myDeploymentUri.biztalk.windows.net/$Artifacts/TransformDefinition/Samples/GettingStarted/map.trfm
Error when trying to add an artifact that already exists
Add-AzureBizTalkArtifactTransform –AcsNamespace myACS -IssuerName owner -IssuerKey <issuer key> –DeploymentUri https://myDeploymentUri.biztalk.windows.net/default -ArtifactPath Samples/GettingStarted/map.trfm -FilePath C:\MyLocation\map.trfm
Output
ERROR: The specified artifact ‘map.trfm’ already exists either with the same name or the same path in the artifact store at https://myDeploymentUri.biztalk.windows.net/$Artifacts/TransformDefinition/Samples/GettingStarted/map.trfm
Error when the provided artifact type is not supported
Add-AzureBizTalkArtifactTransform –AcsNamespace myACS -IssuerName owner -IssuerKey <issuer key> –DeploymentUri https://myDeploymentUri.biztalk.windows.net/default -ArtifactPath Samples/GettingStarted/PO.xsd -FilePath C:\MyLocation\PO.xsd
Output
ERROR: Artifact of type .xsd is not supported by this cmdlet
Successfully overwriting an existing artifact
Add-AzureBizTalkArtifactTransform –AcsNamespace myACS -IssuerName owner -IssuerKey <issuer key> –DeploymentUri https://myDeploymentUri.biztalk.windows.net/default -ArtifactPath Samples/GettingStarted/map.trfm -FilePath C:\MyLocation\map.trfm -Overwrite
Output
Successfully added artifact ‘map.trfm’ to Artifact Store at https://myDeploymentUri.biztalk.windows.net/$Artifacts/TransformDefinition/Samples/GettingStarted/map.trfm