Get-AzureBizTalkArtifact

  • Article

 

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:

The Get-AzureBizTalkArtifact lists the artifacts from the artifact store deployed to a BizTalk Services subscription. This cmdlet supports wildcards as well.

Syntax

Get-AzureBizTalkArtifact –AcsNamespace <AcsNamespace> -IssuerName <IssuerName> -IssuerKey <IssuerKey> –DeploymentUri <DeploymentUri> -[ArtifactPath <ArtifactPath>] [-Recurse] [<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>]

Optional

The relative path of the node from where the artifacts must be retrieved. If you do not provide a path, the default value of “\” is assumed and all the artifacts under the deployment endpoint are retrieved.

You can also provide wildcards to specify the type of artifact (*.cer or *.trfm) to be retrieved.

[-Recurse]

Optional

If included, this parameter specifies that all the artifacts under the sub-paths of the deployment URI are retrieved as well. If this parameter is not included, only the artifacts at the parent-level, immediately under the deployment endpoint are retrieved.

[CommonParameters]

Optional

Can be used with any cmdlet and are implemented by Windows PowerShell. Options include:

  • -Verbose

  • -Debug

  • -ErrorActions

  • -ErrorVariable

  • -WarningAction

  • -WarningVariable

  • -OutBuffer

  • -OutVariable

get-help about_commonparameters provides detailed information about these common parameters. about_CommonParameters is also a good resource.

Examples

  • Get a list of deployed artifacts at the root node

    Get-AzureBizTalkArtifact –AcsNamespace myACS -IssuerName owner -IssuerKey <issuer key> –DeploymentUri https://myDeploymentUri.biztalk.windows.net/default

    Output

    TestDll.dll
TestCert.cer
TestXsd.xsd
TestTrfm.trfm

  • Get a list of all deployed schemas

    Get-AzureBizTalkArtifact –AcsNamespace myACS -IssuerName owner -IssuerKey <issuer key> –DeploymentUri https://myDeploymentUri.biztalk.windows.net/default -ArtifactPath Samples\*.xsd -Recurse

    Output

    Samples/PO.xsd
Samples/PO1.xsd
Samples/GettingStarted/PO2.xsd

  • Retrieve a single artifact

    Get-AzureBizTalkArtifact –AcsNamespace myACS -IssuerName owner -IssuerKey <issuer key> –DeploymentUri https://myDeploymentUri.biztalk.windows.net/default -ArtifactPath Samples/PO1.xsd

    Output

    Samples/PO1.xsd

See Also

PowerShell CmdLets to manage the BizTalk Service