Skip to content

Commit 34964dc

Browse files
Merge branch 'non_exportable_flag_79155' of https://github.com/Keyfactor/azurekeyvault-orchestrator into non_exportable_flag_79155
2 parents 2cea4cb + 1df1f59 commit 34964dc

File tree

1 file changed

+62
-4
lines changed

1 file changed

+62
-4
lines changed

README.md

Lines changed: 62 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -658,32 +658,90 @@ the Keyfactor Command Portal
658658

659659
![AKV Custom Fields Tab](docsource/images/AKV-custom-fields-store-type-dialog.png)
660660

661+
662+
###### Tenant Id
663+
The ID of the primary Azure Tenant where the KeyVaults are hosted
664+
665+
![AKV Custom Field - TenantId](docsource/images/AKV-custom-field-TenantId-dialog.png)
666+
667+
668+
669+
###### SKU Type
670+
The SKU type for newly created KeyVaults (only needed if needing to create new KeyVaults in your Azure subscription via Command)
671+
672+
![AKV Custom Field - SkuType](docsource/images/AKV-custom-field-SkuType-dialog.png)
673+
674+
675+
676+
###### Vault Region
677+
The Azure Region to put newly created KeyVaults (only needed if needing to create new KeyVaults in your Azure subscription via Command)
678+
679+
![AKV Custom Field - VaultRegion](docsource/images/AKV-custom-field-VaultRegion-dialog.png)
680+
681+
682+
683+
###### Azure Cloud
684+
The Azure Cloud where the KeyVaults are located (only necessary if not using the standard Azure Public cloud)
685+
686+
![AKV Custom Field - AzureCloud](docsource/images/AKV-custom-field-AzureCloud-dialog.png)
687+
688+
689+
690+
###### Private KeyVault Endpoint
691+
The private endpoint of your vault instance (if a private endpoint is configured in Azure)
692+
693+
![AKV Custom Field - PrivateEndpoint](docsource/images/AKV-custom-field-PrivateEndpoint-dialog.png)
694+
695+
696+
697+
698+
661699
##### Entry Parameters Tab
662700

663701
| Name | Display Name | Description | Type | Default Value | Entry has a private key | Adding an entry | Removing an entry | Reenrolling an entry |
664702
| ---- | ------------ | ---- | ------------- | ----------------------- | ---------------- | ----------------- | ------------------- | ----------- |
665703
| CertificateTags | Certificate Tags | If desired, tags can be applied to the KeyVault entries. Provide them as a JSON string of key-value pairs ie: '{'tag-name': 'tag-content', 'other-tag-name': 'other-tag-content'}' | string | | 🔲 Unchecked | 🔲 Unchecked | 🔲 Unchecked | 🔲 Unchecked |
666704
| PreserveExistingTags | Preserve Existing Tags | If true, this will perform a union of any tags provided with enrollment with the tags on the existing cert with the same alias and apply the result to the new certificate. | Bool | False | 🔲 Unchecked | 🔲 Unchecked | 🔲 Unchecked | 🔲 Unchecked |
705+
| NonExportable | Non Exportable | If true, this will mark the certificate as 'non-exportable' when importing into Azure KeyVault | Bool | False | 🔲 Unchecked | 🔲 Unchecked | 🔲 Unchecked | 🔲 Unchecked |
667706

668707
The Entry Parameters tab should look like this:
669708

670709
![AKV Entry Parameters Tab](docsource/images/AKV-entry-parameters-store-type-dialog.png)
671710

711+
712+
##### Certificate Tags
713+
If desired, tags can be applied to the KeyVault entries. Provide them as a JSON string of key-value pairs ie: '{'tag-name': 'tag-content', 'other-tag-name': 'other-tag-content'}'
714+
715+
![AKV Entry Parameter - CertificateTags](docsource/images/AKV-entry-parameters-store-type-dialog-CertificateTags.png)
716+
717+
718+
##### Preserve Existing Tags
719+
If true, this will perform a union of any tags provided with enrollment with the tags on the existing cert with the same alias and apply the result to the new certificate.
720+
721+
![AKV Entry Parameter - PreserveExistingTags](docsource/images/AKV-entry-parameters-store-type-dialog-PreserveExistingTags.png)
722+
723+
724+
##### Non Exportable
725+
If true, this will mark the certificate as 'non-exportable' when importing into Azure KeyVault
726+
727+
![AKV Entry Parameter - NonExportable](docsource/images/AKV-entry-parameters-store-type-dialog-NonExportable.png)
728+
729+
730+
672731
</details>
673732

674733
## Installation
675734

676735
1. **Download the latest Azure Key Vault Universal Orchestrator extension from GitHub.**
677736

678-
Navigate to the [Azure Key Vault Universal Orchestrator extension GitHub version page](https://github.com/Keyfactor/azurekeyvault-orchestrator/releases/latest). Refer to the compatibility matrix below to determine whether the `net6.0` or `net8.0` asset should be downloaded. Then, click the corresponding asset to download the zip archive.
737+
Navigate to the [Azure Key Vault Universal Orchestrator extension GitHub version page](https://github.com/Keyfactor/azurekeyvault-orchestrator/releases/latest). Refer to the compatibility matrix below to determine the asset should be downloaded. Then, click the corresponding asset to download the zip archive.
679738

680739
| Universal Orchestrator Version | Latest .NET version installed on the Universal Orchestrator server | `rollForward` condition in `Orchestrator.runtimeconfig.json` | `azurekeyvault-orchestrator` .NET version to download |
681740
| --------- | ----------- | ----------- | ----------- |
682741
| Older than `11.0.0` | | | `net6.0` |
683742
| Between `11.0.0` and `11.5.1` (inclusive) | `net6.0` | | `net6.0` |
684-
| Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `Disable` | `net6.0` |
685-
| Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `LatestMajor` | `net8.0` |
686-
| `11.6` _and_ newer | `net8.0` | | `net8.0` |
743+
| Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `Disable` | `net6.0` || Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `LatestMajor` | `net8.0` |
744+
| `11.6` _and_ newer | `net8.0` | | `net8.0` |
687745

688746
Unzip the archive containing extension assemblies to a known location.
689747

0 commit comments

Comments
 (0)