Skip to content

Add OpenRewrite recipes and samples for azure-security-keyvault-certificates to automate migration to v2 #46941

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Add OpenRewrite recipes and samples for azure-security-keyvault-certificates to automate migration to v2 #46941

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
88f5c3f
azure-security-keyvault-certificates samples and recipes
DoggyDoggyDoggy Oct 9, 2025
b70cf75
Added dependency
DoggyDoggyDoggy Oct 9, 2025
d855830
DefaultAzureCredentialBuilder recipe
DoggyDoggyDoggy Oct 9, 2025
3450f8b
CI setup
DoggyDoggyDoggy Oct 9, 2025
0f9f509
CI fix
DoggyDoggyDoggy Oct 9, 2025
c3cfdb6
CI fix
DoggyDoggyDoggy Oct 9, 2025
bfbed66
Update checkstyle-suppressions.xml to use the new linting extensions …
srnagar Oct 9, 2025
5c63fc4
fix checkstyle
srnagar Oct 9, 2025
c0ced63
Merge branch 'main' into azure-security-keyvault-certificates-pr
DoggyDoggyDoggy Oct 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions eng/versioning/version_client.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -546,6 +546,7 @@ io.clientcore:optional-dependency-tests;1.0.0-beta.1;1.0.0-beta.1

unreleased_com.azure.v2:azure-core;2.0.0-beta.1
unreleased_com.azure.v2:azure-identity;2.0.0-beta.1
unreleased_com.azure.v2:azure-security-keyvault-certificates;5.0.0-beta.1
unreleased_com.azure.v2:azure-data-appconfiguration;2.0.0-beta.1
unreleased_io.clientcore:http-netty4;1.0.0-beta.1

Expand Down
24 changes: 12 additions & 12 deletions sdk/keyvault-v2/azure-security-keyvault-administration/checkstyle-suppressions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@
<!-- This file is generated by the /eng/scripts/linting_suppression_generator.py script. -->

<suppressions>
<suppress files="com.azure.v2.security.keyvault.administration.implementation.KeyVaultAdministrationClientImpl.java" checks="com.azure.tools.checkstyle.checks.RawExceptionThrow" />
<suppress files="com.azure.v2.security.keyvault.administration.implementation.RoleAssignmentsImpl.java" checks="com.azure.tools.checkstyle.checks.RawExceptionThrow" />
<suppress files="com.azure.v2.security.keyvault.administration.implementation.RoleDefinitionsImpl.java" checks="com.azure.tools.checkstyle.checks.RawExceptionThrow" />
<suppress files="com.azure.v2.security.keyvault.administration.KeyVaultAccessControlClient.java" checks="com.azure.tools.checkstyle.checks.ServiceClient" />
<suppress files="com.azure.v2.security.keyvault.administration.KeyVaultBackupClient.java" checks="com.azure.tools.checkstyle.checks.ServiceClient" />
<suppress files="com.azure.v2.security.keyvault.administration.KeyVaultSettingsClient.java" checks="com.azure.tools.checkstyle.checks.ServiceClient" />
<suppress files="com.azure.v2.security.keyvault.administration.implementation.KeyVaultAdministrationClientImpl.java" checks="io.clientcore.linting.extensions.checkstyle.checks.RawExceptionThrowCheck" />
<suppress files="com.azure.v2.security.keyvault.administration.implementation.RoleAssignmentsImpl.java" checks="io.clientcore.linting.extensions.checkstyle.checks.RawExceptionThrowCheck" />
<suppress files="com.azure.v2.security.keyvault.administration.implementation.RoleDefinitionsImpl.java" checks="io.clientcore.linting.extensions.checkstyle.checks.RawExceptionThrowCheck" />
<suppress files="com.azure.v2.security.keyvault.administration.KeyVaultAccessControlClient.java" checks="io.clientcore.linting.extensions.checkstyle.checks.ServiceClientCheck" />
<suppress files="com.azure.v2.security.keyvault.administration.KeyVaultBackupClient.java" checks="io.clientcore.linting.extensions.checkstyle.checks.ServiceClientCheck" />
<suppress files="com.azure.v2.security.keyvault.administration.KeyVaultSettingsClient.java" checks="io.clientcore.linting.extensions.checkstyle.checks.ServiceClientCheck" />

<!-- Generated classes -->
<suppress files="com.azure.v2.security.keyvault.administration.implementation.KeyVaultAdministrationClientServiceImpl.java" checks="FinalClass" />
<suppress files="com.azure.v2.security.keyvault.administration.implementation.KeyVaultAdministrationClientServiceImpl.java" checks="com.azure.tools.checkstyle.checks.GoodLogging" />
<suppress files="com.azure.v2.security.keyvault.administration.implementation.KeyVaultAdministrationClientServiceImpl.java" checks="io.clientcore.linting.extensions.checkstyle.checks.GoodLoggingCheck" />
<suppress files="com.azure.v2.security.keyvault.administration.implementation.KeyVaultAdministrationClientServiceImpl.java" checks="JavadocPackage" />
<suppress files="com.azure.v2.security.keyvault.administration.implementation.KeyVaultAdministrationClientServiceImpl.java" checks="com.azure.tools.checkstyle.checks.RawExceptionThrow" />
<suppress files="com.azure.v2.security.keyvault.administration.implementation.KeyVaultAdministrationClientServiceImpl.java" checks="io.clientcore.linting.extensions.checkstyle.checks.RawExceptionThrowCheck" />
<suppress files="com.azure.v2.security.keyvault.administration.implementation.RoleAssignmentsServiceImpl.java" checks="FinalClass" />
<suppress files="com.azure.v2.security.keyvault.administration.implementation.RoleAssignmentsServiceImpl.java" checks="com.azure.tools.checkstyle.checks.GoodLogging" />
<suppress files="com.azure.v2.security.keyvault.administration.implementation.RoleAssignmentsServiceImpl.java" checks="com.azure.tools.checkstyle.checks.RawExceptionThrow" />
<suppress files="com.azure.v2.security.keyvault.administration.implementation.RoleAssignmentsServiceImpl.java" checks="io.clientcore.linting.extensions.checkstyle.checks.GoodLoggingCheck" />
<suppress files="com.azure.v2.security.keyvault.administration.implementation.RoleAssignmentsServiceImpl.java" checks="io.clientcore.linting.extensions.checkstyle.checks.RawExceptionThrowCheck" />
<suppress files="com.azure.v2.security.keyvault.administration.implementation.RoleDefinitionsServiceImpl.java" checks="FinalClass" />
<suppress files="com.azure.v2.security.keyvault.administration.implementation.RoleDefinitionsServiceImpl.java" checks="com.azure.tools.checkstyle.checks.GoodLogging" />
<suppress files="com.azure.v2.security.keyvault.administration.implementation.RoleDefinitionsServiceImpl.java" checks="com.azure.tools.checkstyle.checks.RawExceptionThrow" />
<suppress files="com.azure.v2.security.keyvault.administration.implementation.RoleDefinitionsServiceImpl.java" checks="io.clientcore.linting.extensions.checkstyle.checks.GoodLoggingCheck" />
<suppress files="com.azure.v2.security.keyvault.administration.implementation.RoleDefinitionsServiceImpl.java" checks="io.clientcore.linting.extensions.checkstyle.checks.RawExceptionThrowCheck" />
</suppressions>
6 changes: 3 additions & 3 deletions sdk/keyvault-v2/azure-security-keyvault-certificates/checkstyle-suppressions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
<suppressions>
<suppress files="com.azure.v2.security.keyvault.certificates.models.CertificateContentType.java" checks="EqualsHashCode" />
<suppress files="com.azure.v2.security.keyvault.certificates.models.CertificatePolicyAction.java" checks="EqualsHashCode" />
<suppress files="com.azure.v2.security.keyvault.certificates.implementation.CertificateClientImpl.java" checks="com.azure.tools.checkstyle.checks.RawExceptionThrow" />
<suppress files="com.azure.v2.security.keyvault.certificates.CertificateClient.java" checks="com.azure.tools.checkstyle.checks.ServiceClient" />
<suppress files="com.azure.v2.security.keyvault.certificates.implementation.CertificateClientImpl.java" checks="io.clientcore.linting.extensions.checkstyle.checks.RawExceptionThrowCheck" />
<suppress files="com.azure.v2.security.keyvault.certificates.CertificateClient.java" checks="io.clientcore.linting.extensions.checkstyle.checks.ServiceClientCheck" />

<!-- Generated classes -->
<suppress files="com.azure.v2.security.keyvault.certificates.implementation.CertificateClientServiceImpl.java" checks="FinalClass" />
<suppress files="com.azure.v2.security.keyvault.certificates.implementation.CertificateClientServiceImpl.java" checks="com.azure.tools.checkstyle.checks.GoodLogging" />
<suppress files="com.azure.v2.security.keyvault.certificates.implementation.CertificateClientServiceImpl.java" checks="io.clientcore.linting.extensions.checkstyle.checks.GoodLoggingCheck" />
<suppress files="com.azure.v2.security.keyvault.certificates.implementation.CertificateClientServiceImpl.java" checks="JavadocPackage" />
<suppress files="com.azure.v2.security.keyvault.certificates.implementation.CertificateClientServiceImpl.java" checks="com.azure.tools.checkstyle.checks.RawExceptionThrow" />
</suppressions>
18 changes: 9 additions & 9 deletions sdk/keyvault-v2/azure-security-keyvault-keys/checkstyle-suppressions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@
<!-- This file is generated by the /eng/scripts/linting_suppression_generator.py script. -->

<suppressions>
<suppress files="com.azure.v2.security.keyvault.keys.implementation.KeyClientImpl.java" checks="com.azure.tools.checkstyle.checks.RawExceptionThrow" />
<suppress files="com.azure.v2.security.keyvault.keys.implementation.SecretMinClientImpl.java" checks="com.azure.tools.checkstyle.checks.RawExceptionThrow" />
<suppress files="com.azure.v2.security.keyvault.keys.KeyClient.java" checks="com.azure.tools.checkstyle.checks.ServiceClient" />
<suppress files="com.azure.v2.security.keyvault.keys.cryptography.CryptographyClient.java" checks="com.azure.tools.checkstyle.checks.ServiceClient" />
<suppress files="com.azure.v2.security.keyvault.keys.implementation.KeyClientImpl.java" checks="io.clientcore.linting.extensions.checkstyle.checks.RawExceptionThrowCheck" />
<suppress files="com.azure.v2.security.keyvault.keys.implementation.SecretMinClientImpl.java" checks="io.clientcore.linting.extensions.checkstyle.checks.RawExceptionThrowCheck" />
<suppress files="com.azure.v2.security.keyvault.keys.KeyClient.java" checks="io.clientcore.linting.extensions.checkstyle.checks.ServiceClientCheck" />
<suppress files="com.azure.v2.security.keyvault.keys.cryptography.CryptographyClient.java" checks="io.clientcore.linting.extensions.checkstyle.checks.ServiceClientCheck" />

<!-- Generated classes -->
<suppress files="com.azure.v2.security.keyvault.keys.implementation.KeyClientServiceImpl.java" checks="FinalClass" />
<suppress files="com.azure.v2.security.keyvault.keys.implementation.KeyClientServiceImpl.java" checks="com.azure.tools.checkstyle.checks.GoodLogging" />
<suppress files="com.azure.v2.security.keyvault.keys.implementation.KeyClientServiceImpl.java" checks="JavadocPackage" />
<suppress files="com.azure.v2.security.keyvault.keys.implementation.KeyClientServiceImpl.java" checks="com.azure.tools.checkstyle.checks.RawExceptionThrow" />
<suppress files="com.azure.v2.security.keyvault.keys.implementation.KeyClientServiceImpl.java" checks="io.clientcore.linting.extensions.checkstyle.checks.GoodLoggingCheck" />
<suppress files="com.azure.v2.security.keyvault.keys.implementation.*" checks="JavadocPackage" />
<suppress files="com.azure.v2.security.keyvault.keys.implementation.KeyClientServiceImpl.java" checks="io.clientcore.linting.extensions.checkstyle.checks.RawExceptionThrowCheck" />
<suppress files="com.azure.v2.security.keyvault.keys.implementation.SecretMinClientServiceImpl.java" checks="FinalClass" />
<suppress files="com.azure.v2.security.keyvault.keys.implementation.SecretMinClientServiceImpl.java" checks="com.azure.tools.checkstyle.checks.GoodLogging" />
<suppress files="com.azure.v2.security.keyvault.keys.implementation.SecretMinClientServiceImpl.java" checks="com.azure.tools.checkstyle.checks.RawExceptionThrow" />
<suppress files="com.azure.v2.security.keyvault.keys.implementation.SecretMinClientServiceImpl.java" checks="io.clientcore.linting.extensions.checkstyle.checks.GoodLoggingCheck" />
<suppress files="com.azure.v2.security.keyvault.keys.implementation.SecretMinClientServiceImpl.java" checks="io.clientcore.linting.extensions.checkstyle.checks.RawExceptionThrowCheck" />
</suppressions>
8 changes: 4 additions & 4 deletions sdk/keyvault-v2/azure-security-keyvault-secrets/checkstyle-suppressions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
<!-- This file is generated by the /eng/scripts/linting_suppression_generator.py script. -->

<suppressions>
<suppress files="com.azure.v2.security.keyvault.secrets.implementation.SecretClientImpl.java" checks="com.azure.tools.checkstyle.checks.RawExceptionThrow" />
<suppress files="com.azure.v2.security.keyvault.secrets.SecretClient.java" checks="com.azure.tools.checkstyle.checks.ServiceClient" />
<suppress files="com.azure.v2.security.keyvault.secrets.implementation.SecretClientImpl.java" checks="io.clientcore.linting.extensions.checkstyle.checks.RawExceptionThrowCheck" />
<suppress files="com.azure.v2.security.keyvault.secrets.SecretClient.java" checks="io.clientcore.linting.extensions.checkstyle.checks.ServiceClientCheck" />

<!-- Generated classes -->
<suppress files="com.azure.v2.security.keyvault.secrets.implementation.SecretClientServiceImpl.java" checks="FinalClass" />
<suppress files="com.azure.v2.security.keyvault.secrets.implementation.SecretClientServiceImpl.java" checks="com.azure.tools.checkstyle.checks.GoodLogging" />
<suppress files="com.azure.v2.security.keyvault.secrets.implementation.SecretClientServiceImpl.java" checks="io.clientcore.linting.extensions.checkstyle.checks.GoodLoggingCheck" />
<suppress files="com.azure.v2.security.keyvault.secrets.implementation.SecretClientServiceImpl.java" checks="JavadocPackage" />
<suppress files="com.azure.v2.security.keyvault.secrets.implementation.SecretClientServiceImpl.java" checks="com.azure.tools.checkstyle.checks.RawExceptionThrow" />
<suppress files="com.azure.v2.security.keyvault.secrets.implementation.SecretClientServiceImpl.java" checks="io.clientcore.linting.extensions.checkstyle.checks.RawExceptionThrowCheck" />
</suppressions>
4 changes: 4 additions & 0 deletions sdk/tools/azure-openrewrite/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,8 @@
</dependency>
<dependency>
<groupId>com.azure.v2</groupId>
<artifactId>azure-security-keyvault-certificates</artifactId>
<version>5.0.0-beta.1</version> <!-- {x-version-update;unreleased_com.azure.v2:azure-security-keyvault-certificates;dependency} -->
<artifactId>azure-data-appconfiguration</artifactId>
<version>2.0.0-beta.1</version> <!-- {x-version-update;unreleased_com.azure.v2:azure-data-appconfiguration;dependency} -->
<scope>test</scope>
Expand Down Expand Up @@ -380,6 +382,8 @@
</dependency>
<dependency>
<groupId>com.azure.v2</groupId>
<artifactId>azure-security-keyvault-certificates</artifactId>
<version>5.0.0-beta.1</version> <!-- {x-version-update;unreleased_com.azure.v2:azure-security-keyvault-certificates;dependency} -->
<artifactId>azure-data-appconfiguration</artifactId>
<version>2.0.0-beta.1</version> <!-- {x-version-update;unreleased_com.azure.v2:azure-data-appconfiguration;dependency} -->
<scope>provided</scope>
Expand Down
13 changes: 13 additions & 0 deletions ...TA-INF/rewrite/migrationRecipes/azure-security-keyvault-certificates/LibraryMigration.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.
# --------------------------------------------------------------------
# Migration Recipes for Azure security-keyvault-keys Library
# --------------------------------------------------------------------
type: specs.openrewrite.org/v1beta/recipe
name: com.azure.openrewrite.migration.security.keyvault.certificates
displayName: Migrate from azure-security-keyvault-keys to next generation stack
description: This recipe migrates the Azure keyvault-keys library to the next generation stack.
recipeList:

- com.azure.openrewrite.recipe.azure.security.keyvault.certificates
- com.azure.openrewrite.recipe.azure.security.keyvault.certificates.models
101 changes: 101 additions & 0 deletions .../azure-security-keyvault-certificates/com.azure.security.keyvault.certificates.models.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
type: specs.openrewrite.org/v1beta/recipe
name: com.azure.openrewrite.recipe.azure.security.keyvault.certificates.models
displayName: Migrate from azure.security.keyvault.certificates.models to next generation stack
description: This recipe migrates the azure.security.keyvault.certificates.models package to the next generation stack.
recipeList:

# --------------------------------------------------------------------
# CertificateKeyCurveName
# --------------------------------------------------------------------

- org.openrewrite.java.ChangeType:
oldFullyQualifiedTypeName: com.azure.security.keyvault.certificates.models.CertificateKeyCurveName
newFullyQualifiedTypeName: com.azure.v2.security.keyvault.certificates.models.CertificateKeyCurveName

# --------------------------------------------------------------------
# CertificateIssuer
# --------------------------------------------------------------------

- org.openrewrite.java.ChangeType:
oldFullyQualifiedTypeName: com.azure.security.keyvault.certificates.models.CertificateIssuer
newFullyQualifiedTypeName: com.azure.v2.security.keyvault.certificates.models.CertificateIssuer

# --------------------------------------------------------------------
# KeyVaultCertificateWithPolicy
# --------------------------------------------------------------------

- org.openrewrite.java.ChangeType:
oldFullyQualifiedTypeName: com.azure.security.keyvault.certificates.models.KeyVaultCertificateWithPolicy
newFullyQualifiedTypeName: com.azure.v2.security.keyvault.certificates.models.KeyVaultCertificateWithPolicy

# --------------------------------------------------------------------
# CertificatePolicy
# --------------------------------------------------------------------

- org.openrewrite.java.ChangeType:
oldFullyQualifiedTypeName: com.azure.security.keyvault.certificates.models.CertificatePolicy
newFullyQualifiedTypeName: com.azure.v2.security.keyvault.certificates.models.CertificatePolicy

# --------------------------------------------------------------------
# DeletedCertificate
# --------------------------------------------------------------------

- org.openrewrite.java.ChangeType:
oldFullyQualifiedTypeName: com.azure.security.keyvault.certificates.models.DeletedCertificate
newFullyQualifiedTypeName: com.azure.v2.security.keyvault.certificates.models.DeletedCertificate

# --------------------------------------------------------------------
# SubjectAlternativeNames
# --------------------------------------------------------------------

- org.openrewrite.java.ChangeType:
oldFullyQualifiedTypeName: com.azure.security.keyvault.certificates.models.SubjectAlternativeNames
newFullyQualifiedTypeName: com.azure.v2.security.keyvault.certificates.models.SubjectAlternativeNames

# --------------------------------------------------------------------
# CertificateOperation
# --------------------------------------------------------------------

- org.openrewrite.java.ChangeType:
oldFullyQualifiedTypeName: com.azure.security.keyvault.certificates.models.CertificateOperation
newFullyQualifiedTypeName: com.azure.v2.security.keyvault.certificates.models.CertificateOperation

# --------------------------------------------------------------------
# KeyVaultCertificate
# --------------------------------------------------------------------

- org.openrewrite.java.ChangeType:
oldFullyQualifiedTypeName: com.azure.security.keyvault.certificates.models.KeyVaultCertificate
newFullyQualifiedTypeName: com.azure.v2.security.keyvault.certificates.models.KeyVaultCertificate

# --------------------------------------------------------------------
# CertificateKeyType
# --------------------------------------------------------------------

- org.openrewrite.java.ChangeType:
oldFullyQualifiedTypeName: com.azure.security.keyvault.certificates.models.CertificateKeyType
newFullyQualifiedTypeName: com.azure.v2.security.keyvault.certificates.models.CertificateKeyType

# --------------------------------------------------------------------
# CertificateContact
# --------------------------------------------------------------------

- org.openrewrite.java.ChangeType:
oldFullyQualifiedTypeName: com.azure.security.keyvault.certificates.models.CertificateContact
newFullyQualifiedTypeName: com.azure.v2.security.keyvault.certificates.models.CertificateContact

# --------------------------------------------------------------------
# CertificateProperties
# --------------------------------------------------------------------

- org.openrewrite.java.ChangeType:
oldFullyQualifiedTypeName: com.azure.security.keyvault.certificates.models.CertificateProperties
newFullyQualifiedTypeName: com.azure.v2.security.keyvault.certificates.models.CertificateProperties

# --------------------------------------------------------------------
# IssuerProperties
# --------------------------------------------------------------------

- org.openrewrite.java.ChangeType:
oldFullyQualifiedTypeName: com.azure.security.keyvault.certificates.models.IssuerProperties
newFullyQualifiedTypeName: com.azure.v2.security.keyvault.certificates.models.IssuerProperties
Loading
Loading