Bugfix for error when creating a new Azure Keyvault #71

joevanwanzeeleKF · 2025-11-06T21:33:02Z

bug fix for error when creating new Azure Keyvaults
documentation updates

Release 3.1.8

Release 3.1.9

…ead property. Additional documentation.

…factor/azurekeyvault-orchestrator into create_vault_bugfix_ab#78506

Copilot

Pull Request Overview

This PR fixes a bug that occurred when creating new Azure Keyvaults by making the custom alias required instead of optional, which resolves errors related to invalid certificate names in Azure Keyvault. The changes also include documentation updates to clarify alias naming requirements.

Key Changes:

Changed CustomAliasAllowed from "Optional" to "Required" to enforce proper certificate naming in Azure Keyvault
Added documentation warning about alias naming restrictions (alphanumeric and hyphens only)
Improved null safety in job property parsing to prevent errors when creating new vaults

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
integration-manifest.json	Updated CustomAliasAllowed to "Required" to enforce alias usage
docsource/content.md	Fixed anchor link reference
docsource/akv.md	Updated terminology and added warning about alias naming requirements
README.md	Updated terminology, fixed anchor link, updated CustomAliasAllowed documentation, and added alias naming warning
CHANGELOG.md	Added version 3.1.11 release notes
AzureKeyVault/Jobs/Management.cs	Improved null safety by adding defensive checks for JobProperties before accessing dictionary values
AzureKeyVault/Jobs/AzureKeyVaultJob.cs	Changed null check to string.IsNullOrEmpty for better validation
AzureKeyVault/AzureClient.cs	Refactored resource group retrieval, added debug logging, and enhanced error handling with specific exception types

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-11T14:57:25Z

AzureKeyVault/AzureClient.cs

+                logger.LogTrace("calling getAsync on resourcegroup...");
+                await resourceGroup.GetAsync();
+                logger.LogTrace("completed getAsync on resource group...");
+
+                var s = resourceGroup.HasData.ToString();
+
+                logger.LogTrace($"resource group has data?: {s}");



This appears to be debug code that should be removed. The variable s is created but never used, and the logging statements around GetAsync() seem excessive for production code. Consider removing lines 165-171 or clarifying if this debug logging is intentional.

Suggested change

logger.LogTrace("calling getAsync on resourcegroup...");

await resourceGroup.GetAsync();

logger.LogTrace("completed getAsync on resource group...");

var s = resourceGroup.HasData.ToString();

logger.LogTrace($"resource group has data?: {s}");

Copilot · 2025-11-11T14:57:25Z

AzureKeyVault/AzureClient.cs

+                var resourceGroups = subscription.GetResourceGroups();
+                ResourceGroupResource resourceGroup = await resourceGroups.GetAsync(VaultProperties.ResourceGroupName);
+                logger.LogTrace("calling getAsync on resourcegroup...");
+                await resourceGroup.GetAsync();


Unnecessary API call: await resourceGroup.GetAsync() is called but its result is not used. The previous line already calls GetAsync() to retrieve the resource group. This redundant call should be removed to avoid unnecessary network overhead.

Suggested change

await resourceGroup.GetAsync();

Copilot · 2025-11-11T14:57:25Z

CHANGELOG.md

+- 3.1.11
+  - bug fix for error when creating new Azure Keyvaults
+  - documentation updates
+


Inconsistent whitespace: this line uses spaces for indentation while the rest of the file likely uses tabs (based on the CHANGELOG file structure). This should use tabs to be consistent with the formatting of line 5.

Suggested change

Copilot · 2025-11-11T14:57:26Z

docsource/akv.md


+> :warning:
+> The alias you provide when enrolling a certificate will be used as the certificate name in Azure Keyvault.
+> Consequently; [it must _only_ contain alphanumeric characters and hyphens](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules#microsoftkeyvault).


Inconsistent punctuation: A semicolon is used here instead of a comma. Change "Consequently;" to "Consequently," for proper grammar.

Suggested change

> Consequently; [it must _only_ contain alphanumeric characters and hyphens](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules#microsoftkeyvault).

> Consequently, [it must _only_ contain alphanumeric characters and hyphens](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules#microsoftkeyvault).

Copilot · 2025-11-11T14:57:26Z

README.md


+> :warning:
+> The alias you provide when enrolling a certificate will be used as the certificate name in Azure Keyvault.
+> Consequently; [it must _only_ contain alphanumeric characters and hyphens](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules#microsoftkeyvault).


Inconsistent punctuation: A semicolon is used here instead of a comma. Change "Consequently;" to "Consequently," for proper grammar.

Suggested change

> Consequently; [it must _only_ contain alphanumeric characters and hyphens](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules#microsoftkeyvault).

> Consequently, [it must _only_ contain alphanumeric characters and hyphens](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules#microsoftkeyvault).

Copilot · 2025-11-11T14:57:26Z

AzureKeyVault/Jobs/Management.cs

+                config.JobProperties.TryGetValue(EntryParameters.TAGS, out object tagsJSONObj);
+                config.JobProperties.TryGetValue(EntryParameters.PRESERVE_TAGS, out object preserveTagsObj);
+                tagsJSON = tagsJSONObj == null ? string.Empty : tagsJSONObj.ToString();
+                preserveTags = preserveTagsObj == null ? false : Boolean.Parse(preserveTagsObj.ToString());


The expression 'A ? false : B' can be simplified to '!A && B'.

Suggested change

preserveTags = preserveTagsObj == null ? false : Boolean.Parse(preserveTagsObj.ToString());

preserveTags = preserveTagsObj != null && Boolean.Parse(preserveTagsObj.ToString());

…b#78506 # Conflicts: # CHANGELOG.md # README.md

Merge 3.1.10 to main

…b#78506

…factor/azurekeyvault-orchestrator into create_vault_bugfix_ab#78506

doebrowsk and others added 10 commits December 11, 2024 15:23

merge Release 3.1.6 to main

5c381cf

Merge release 3.1.7

615394a

Merge pull request #61 from Keyfactor/release-3.1

3641e96

Release 3.1.8

Merge pull request #67 from Keyfactor/release-3.1

89b7265

Release 3.1.9

adding additional logging to troubleshoot authentication errors.

c8670d2

removed logging line that was causing an error

7ef127b

Now checking for existance of entry parameters before attempting to r…

e5c57c6

…ead property. Additional documentation.

Update generated docs

32765c0

CHANGELOG

40dd646

Merge branch 'create_vault_bugfix_ab#78506' of https://github.com/Key…

ec08d59

…factor/azurekeyvault-orchestrator into create_vault_bugfix_ab#78506

spbsoluble requested a review from Copilot November 11, 2025 14:54

Copilot started reviewing on behalf of spbsoluble November 11, 2025 14:54 View session

Copilot finished reviewing on behalf of spbsoluble November 11, 2025 14:56

Copilot AI reviewed Nov 11, 2025

View reviewed changes

Merge remote-tracking branch 'origin/main' into create_vault_bugfix_a…

080ccce

…b#78506 # Conflicts: # CHANGELOG.md # README.md

spbsoluble force-pushed the create_vault_bugfix_ab#78506 branch from ddf79c1 to 080ccce Compare November 11, 2025 16:32

spbsoluble and others added 8 commits November 11, 2025 08:32

Merge pull request #69 from Keyfactor/release-3.1

f4fc68c

Merge 3.1.10 to main

Merge remote-tracking branch 'origin/main' into create_vault_bugfix_a…

ec5a460

…b#78506

moved evaluation of pageable response to try catch block

05a0634

Merge branch 'create_vault_bugfix_ab#78506' of https://github.com/Key…

5ca0b5d

…factor/azurekeyvault-orchestrator into create_vault_bugfix_ab#78506

Update generated docs

448ba2f

Update generated docs

f2e00c1

chore(ci): Update build workflow to v4 and add dependabot.yml

60cf657

Update generated docs

f463305

spbsoluble merged commit 578318c into release-3.1 Nov 20, 2025

spbsoluble deleted the create_vault_bugfix_ab#78506 branch November 20, 2025 20:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bugfix for error when creating a new Azure Keyvault #71

Bugfix for error when creating a new Azure Keyvault #71

Uh oh!

joevanwanzeeleKF commented Nov 6, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Nov 11, 2025

Uh oh!

Copilot AI Nov 11, 2025

Uh oh!

Copilot AI Nov 11, 2025

Uh oh!

Copilot AI Nov 11, 2025

Uh oh!

Copilot AI Nov 11, 2025

Uh oh!

Copilot AI Nov 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	> Consequently; [it must _only_ contain alphanumeric characters and hyphens](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules#microsoftkeyvault).
	> Consequently, [it must _only_ contain alphanumeric characters and hyphens](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules#microsoftkeyvault).

	preserveTags = preserveTagsObj == null ? false : Boolean.Parse(preserveTagsObj.ToString());
	preserveTags = preserveTagsObj != null && Boolean.Parse(preserveTagsObj.ToString());

Bugfix for error when creating a new Azure Keyvault #71

Bugfix for error when creating a new Azure Keyvault #71

Uh oh!

Conversation

joevanwanzeeleKF commented Nov 6, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Nov 11, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 11, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 11, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 11, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 11, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 11, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants