BeyondERP.Newsletter
Menu

Setup page · System administration

Key Vault parameters

A setup page that links the system to an Azure Key Vault and lists the certificates and secrets stored there.

Used by
Information technology manager
Business process
Administer system features
Menu item
KeyVaultParameters
Main table
KeyVaultParameters
Setup steps
1 on this page
Show what matters for
PAGE GUIDEWhat the page does and how to use it8 sections. Choose a role to highlight what matters to you.
Everyone

1What it is and why

What it isA setup page that links the system to an Azure Key Vault and lists the certificates and secrets stored there.
What you do hereUse this page to refer to certificates and secrets kept in Key Vault instead of using them directly.
ExampleFor example, each legal entity that connects to an external tax solution provider needs its own Key Vault parameters record.
Key Vault parameters page in Dynamics 365
The page in Dynamics 365. page title tab to open what to set or check
Functional consultant · Solution architect

2Where it fits

End user · Functional consultant

3How to do it

About the examples: Examples and screenshots in this guide use BEAT, a demo company in a Dynamics 365 test environment. Use your own company's codes and values instead of copying them.

Setup steps on this page

Set up Key Vault parameters

Use this page to refer to certificates and secrets kept in Key Vault instead of using them directly.

Steps from Microsoft

  1. Go to System administration > Setup > Key Vault parameters.
  2. Select New and enter a name and description.
  3. On the General tab, enter the Key Vault URL, Key Vault client and Key Vault secret key.
  4. On the Certificates tab, select Add and enter a name, description and the Key Vault certificate secret reference.
  5. Select Validate to check the reference and the certificate.

Source: Microsoft Learn

Fields on the page

FieldWhat it meansTable column
Key Vault URLThe default address of the key vault.Microsoft Learn Url
Key Vault clientThe client ID of the Microsoft Entra application used to sign in to the key vault.Microsoft Learn AppClientId
Key Vault secret keyThe secret of that Microsoft Entra application.Microsoft Learn
Key Vault certificate secretA reference to the certificate in the vault, in the form vault:///<SecretName>.Microsoft Learn

Common errors and fixes

MessageWhat to do
Validate reports that the certificate reference or the certificate isn't validCheck the Key Vault certificate secret format vault://<KeyVaultName>/<SecretName>/<SecretVersion> (only <SecretName> is required, so vault:///<SecretName> works when the Key Vault URL is set on the record), then check the Key Vault client and secret key of the Microsoft Entra application and select Validate again. Microsoft Learn
Certificates stored in Key Vault aren't used at allSet Use advanced certificate store to Yes on the General tab of System parameters. With No, the system uses local certificate storage; Key Vault storage is the only option for a production environment in the Azure cloud. Microsoft Learn

Test checklist

  1. Create a Key Vault record with Key Vault URL, Key Vault client and Key Vault secret key.
  2. On the Secrets tab, add a secret in the form vault:///<SecretName>.
  3. Check the app registration has Get and List secret permissions in the key vault access policy.
  4. Select the secret in the consuming setup (for example the tax feature setup) and run a call that uses it.

Source: Microsoft Learn

Functional consultant

4Setup decisions

Setup stepRecommended value and whyDecision, common mistake and test
Set up Key Vault parametersOne Key Vault parameters record per Key Vault storage, with each certificate referenced as vault:///<SecretName>/<SecretVersion> and checked with ValidateLearn asks for a separate record for each Key Vault storage you use. Because certificates are cached, Learn recommends naming the secret version in the reference; without a version the system takes the active certificate with the latest expiration date.Should certificate references name a secret version?Typing the secret reference in the wrong format or forgetting Validate: the reference must start with vault:// and name at least the secret, and only Validate shows that the reference and the certificate are good.Test: Key Vault certificate reference validates

Feature management and licence

Licence or add-inOn this system the page opens for Information technology manager. Key Vault storage is used when Use advanced certificate store is Yes on System parameters. No Feature management feature needs to be turned on for this page.

Microsoft Learn

Solution architect

5Design impact

Shared or per companyPer company: each legal entity has its own records. Microsoft data model
Can it be undoneReversible: Key Vault records and secret references can be edited at any time. A secret reference without a version picks up the active secret with the latest expiration date, so a renewed secret is used without changes here. Microsoft Learn
If you change it laterIf no secret version is given, the system uses the active certificate with the latest expiration date, so a renewed certificate is picked up automatically. Microsoft Learn
Technical architect

6Technical

Menu itemKeyVaultParameters Checked in Dynamics 365
FormKeyVaultParameters Checked in Dynamics 365
TableKeyVaultParametersShown as “Key Vault parameters” in Record infoChecked in Dynamics 365
Who can open itPrivilegesMaintain KeyVault parameters KeyVaultParametersMaintainDutiesMaintain system settings SysServerSettingsMaintain
1 security roleInformation technology manager SysServerITManager
Checked in Dynamics 365
Roles to set it up and use itTo set it up or change itInformation technology manager SysServerITManagerGive people one of these roles. On this system, 1 role can open this page.Checked in Dynamics 365
Actions on the pageOptions: Personalize, Page options, ShareChecked in Dynamics 365
Developer

7Developer

Open it by URLhttps://<your-environment>/?mi=KeyVaultParameters
Data migrationLoad order: Key Vault parameters has no data entity in Data management, so it can't be loaded from a file or a configuration template. Enter the Key Vault URL, Key Vault client, Key Vault secret key and certificate references by hand in each legal entity that needs them, then select Validate on each certificate.Checked in Dynamics 365
Table definitionKeyVaultParameters columns and relations Microsoft data model
Everyone

8Sources