Save-AzureBizTalkArtifact

 

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 Save-AzureBizTalkArtifact saves already uploaded artifacts to another location in the artifact store deployed to a BizTalk Services subscription.

Syntax

Save-AzureBizTalkArtifact –AcsNamespace <AcsNamespace> -IssuerName <IssuerName> -IssuerKey <IssuerKey> –DeploymentUri <DeploymentUri> -ArtifactPath <ArtifactPath> -SavePath <SavePath> [-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 relative path of the node from where the artifacts to be copied must be retrieved.

-SavePath <SavePath>

Required

The absolute path where the artifact must be saved to.

[-Overwrite]

Optional

A flag that indicates whether the existing artifact at the given save path must be replaced.

In case the file name provided for the –SavePath parameter already exists then a ResouceExists error is thrown. In such cases, the existing file can we overwritten by passing the -Overwrite parameter.

[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

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

    Output

    Successfully copied the following files 
    ./Test/Samples/PO1.xsd
    

See Also

PowerShell CmdLets to manage the BizTalk Service