You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sdk/spring/azure-spring-boot-starter-keyvault-secrets/README.md
+54-1Lines changed: 54 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,26 @@ From a developer's perspective, Key Vault APIs accept and return secret values a
30
30
31
31
For highly sensitive data, clients should consider additional layers of protection for data. Encrypting data using a separate protection key prior to storage in Key Vault is one example.
32
32
33
-
Key Vault also supports a contentType field for secrets. Clients may specify the content type of a secret to assist in interpreting the secret data when it's retrieved. The maximum length of this field is 255 characters. There are no pre-defined values. The suggested usage is as a hint for interpreting the secret data. For instance, an implementation may store both passwords and certificates as secrets, then use this field to differentiate. There are no predefined values.
33
+
Key Vault also supports a contentType field for secrets. Clients may specify the content type of a secret to assist in interpreting the secret data when it's retrieved. The maximum length of this field is 255 characters. There are no pre-defined values. The suggested usage is as a hint for interpreting the secret data.
34
+
35
+
Besides, this starter provides features of supporting multiple Key Vaults, case sensitive mode of Key Vault names and using placeholder presenting Key Vault names in property file
36
+
### Multiple Key Vault support
37
+
38
+
If you want to use multiple Key Vaults you need to define names for each of the
39
+
Key Vaults you want to use and in which order the Key Vaults should be consulted.
40
+
If a property exists in multiple Key Vaults the order determine which value you
41
+
will get back.
42
+
43
+
### Case sensitive key mode
44
+
45
+
The new case sensitive mode allows you to use case sensitive Key Vault names. Note
46
+
that the Key Vault secret key still needs to honor the naming limitation as
47
+
described in the “keyvault-name” element of [About keys, secrets, and certificates](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates).
48
+
49
+
If your Spring property is using a name that does not honor the Key Vault secret
50
+
key limitation use the following technique as described by
Note if you decide to use multiple key vault support and you already have an
149
+
existing configuration, please make sure you migrate that configuration to the
150
+
multiple key vault variant. Mixing multiple key vaults with an existing single
151
+
key vault configuration is a non supported scenario.
152
+
153
+
### Case sensitive key mode
154
+
To enable case sensitive mode, you can set the following property in the `appliation.properties`:
155
+
```
156
+
azure.keyvault.case-sensitive-keys=true
157
+
```
158
+
If your Spring property is using a name that does not honor the Key Vault secret key limitation use placeholders in properties. An example of using a placeholder:
The application will take care of getting the value that is backed by the
164
+
`myCompliantKeyVaultSecret` key name and assign its value to the non compliant
165
+
`my.not.compliant.property`.
166
+
114
167
## Troubleshooting
115
168
### Enable client logging
116
169
Azure SDKs for Java offer a consistent logging story to help aid in troubleshooting application errors and expedite their resolution. The logs produced will capture the flow of an application before reaching the terminal state to help locate the root issue. View the [logging][logging] wiki for guidance about enabling logging.
0 commit comments