Add-AzureBizTalkArtifactCertificate

 

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:

• What are logic apps

• 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-AzureBizTalkArtifactCertificate adds a certificate to the artifact store for the service namespace you enter.

Syntax

Add-AzureBizTalkArtifactCertificate –AcsNamespace <AcsNamespace> -IssuerName <IssuerName> -IssuerKey <IssuerKey> –DeploymentUri <DeploymentUri> -ArtifactPath <ArtifactPath> -FilePath <FilePath> -CertificatePassword <CertificatePassword> -certificateStore <Certificatetore> [-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.
- CertificatePassword <CertificatePassword>	Required	The password of the certificate to be uploaded.
-certificateStore <CertificateStore>	Optional	The certificate store to where the certificates must be uploaded. By default this value is “My”.
[-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: -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

• Successfully add a certificate

  Add-AzureBizTalkArtifactCertificate –AcsNamespace myACS -IssuerName owner -IssuerKey <issuer key> –DeploymentUri https://myDeploymentUri.biztalk.windows.net/default -ArtifactPath Samples/GettingStarted/TestCert.cer -FilePath C:\MyLocation\TestCert.cer –CertificatePassword passw@rd

  Output

  Successfully added artifact ‘TestCert.cer’ to Artifact Store at https://myDeploymentUri.biztalk.windows.net/$Artifacts/$Certificate/Samples/GettingStarted/TestCert.cer

• Error when trying to add an artifact that already exists

  Add-AzureBizTalkArtifactCertificate –AcsNamespace myACS -IssuerName owner -IssuerKey <issuer key> –DeploymentUri https://myDeploymentUri.biztalk.windows.net/default -ArtifactPath Samples/GettingStarted/TestCert.cer -FilePath C:\MyLocation\TestCert.cer –CertificatePassword passw@rd

  Output

  ERROR: The specified artifact ‘TestCert.cer’ already exists either with the same name or the same path in the artifact store at https://myDeploymentUri.biztalk.windows.net/default/$Artifacts/$Certificate/Samples/GettingStarted/TestCert.cer

• Error when the provided artifact type is not supported

  Add-AzureBizTalkArtifactCertificate –AcsNamespace myACS -IssuerName owner -IssuerKey <issuer key> –DeploymentUri https://myDeploymentUri.biztalk.windows.net/default -ArtifactPath Samples/GettingStarted/PO.trfm -FilePath C:\MyLocation\PO.trfm –CertificatePassword passw@rd

  Output

  ERROR: Artifact of type .trfm is not supported by this cmdlet

• Successfully overwriting an existing artifact

  Add-AzureBizTalkArtifactCertificate –AcsNamespace myACS -IssuerName owner -IssuerKey <issuer key> –DeploymentUri https://myDeploymentUri.biztalk.windows.net/default -ArtifactPath Samples/GettingStarted/TestCert.cer -FilePath C:\MyLocation\TestCert.cer –CertificatePassword passw@rd

  Output

  Successfully added artifact ‘TestCert.cer’ to Artifact Store at https://myDeploymentUri.biztalk.windows.net/$Artifacts/$Certificate/Samples/GettingStarted/TestCert.cer

See Also

PowerShell CmdLets to manage the BizTalk Service