CredentialDescription.KeyVaultCertificateName Property

Definition

Namespace:

Microsoft.Identity.Abstractions

Assembly:

Microsoft.Identity.Abstractions.dll

Package:

Microsoft.Identity.Abstractions v5.3.0

When SourceType is KeyVault, use this property to specify the the name of the certificate in Key Vault in conjunction with KeyVaultUrl.

public string? KeyVaultCertificateName { get; set; }

member this.KeyVaultCertificateName : string with get, set

Public Property KeyVaultCertificateName As String

Property Value

String

Examples

The JSON fragment below describes a certificate stored in Key Vault used as a client credential in a confidential client application:

{
 "ClientCredentials": [
  {
   "SourceType": "KeyVault",
   "KeyVaultUrl": "https://msidentitywebsamples.vault.azure.net",
   "KeyVaultCertificateName": "MicrosoftIdentitySamplesCert"
  }
 ]
}

The code below describes programmatically in C#, the same certificate stored in Key Vault.

CredentialDescription credentialDescription = new CredentialDescription
{
    SourceType = CredentialSource.KeyVault,
    KeyVaultUrl = "https://msidentitywebsamples.vault.azure.net",
    KeyVaultCertificateName = "MicrosoftIdentitySamplesCert"

};