Remove-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:
-
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 Remove-AzureBizTalkArtifact deletes artifacts from the artifact store deployed to a BizTalk Services subscription. Depending on the relative address at which you perform the delete operation, you get different responses:
If you perform a delete operation against any occupied node, it deletes only that specific artifact.
If you perform a delete operation against any unoccupied node or a non-existing artifact, the operation is ignored and returns success. This does not return an HTTP 404 error.
If you perform a delete operation against the root node, it results in an error.
Syntax
Remove-AzureBizTalkArtifact –AcsNamespace <AcsNamespace> -IssuerName <IssuerName> -IssuerKey <IssuerKey> –DeploymentUri <DeploymentUri> -ArtifactPath <ArtifactPath> [<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 artifact node that must be deleted. |
[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 delete an artifact
Remove-AzureBizTalkArtifact –AcsNamespace myACS -IssuerName owner -IssuerKey <issuer key> –DeploymentUri https://myDeploymentUri.biztalk.windows.net/default -ArtifactPath Samples/PO1.xsd
Output
The Artifact ‘https://myDeploymentUri.biztalk.windows.net/$Artifacts/XmlSchemaDefinition/Samples/PO1.xsd’ was successfully removed.
Error when the artifact to be deleted does not exist
Remove-AzureBizTalkArtifact –AcsNamespace myACS -IssuerName owner -IssuerKey <issuer key> –DeploymentUri https://myDeploymentUri.biztalk.windows.net/default -ArtifactPath Samples/PO2.xsd
Output
The Artifact ‘https://myDeploymentUri.biztalk.windows.net/$Artifacts/XmlSchemaDefinition/Samples/PO2.xsd’ doesn’t exist.
Error when root node is provided instead of a specific artifact
Remove-AzureBizTalkArtifact –AcsNamespace myACS -IssuerName owner -IssuerKey <issuer key> –DeploymentUri https://myDeploymentUri.biztalk.windows.net/default -ArtifactPath Samples/
Output
ERROR: Please provide specific artifact to be removed and not the root node