Skip to content

Commit 1f76b19

Browse files
committed
Update README.rst with information about Azure Key Vault publishing
Signed-off-by: Daniel Münch <[email protected]>
1 parent 28adfcb commit 1f76b19

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1106,6 +1106,21 @@ Below is an example of publishing to Vault (using token auth with a local dev in
11061106
example_number 42
11071107
example_string bar
11081108
1109+
Publishing to Azure Key Vault
1110+
*******************
1111+
1112+
There are a few settings for Azure Key Vault that you can place in your destination rules. The first
1113+
is ``azure_keyvault_url``, which is required. The other one is optional:
1114+
``azure_publish_suffix``.
1115+
1116+
The Azure Key Vault publish integration uses the
1117+
`default credential chain <https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity#DefaultAzureCredential>`_
1118+
which tries several authentication methods - see "Encrypting using Azure Key Vault" for more details.
1119+
1120+
``azure_publish_suffix`` is used if you only want to publish secrets with a specific suffix
1121+
1122+
Note that Azure Secret Names get sanitzied before being put into Azure Key Vault. The following rules apply:
1123+
- Underscores `_` get replaced with dashes `-`
11091124
11101125
Important information on types
11111126
------------------------------

0 commit comments

Comments
 (0)