in sdk/keyvault/azure-security-keyvault-certificates/swagger/src/main/java/CertificatesCustomizations.java [141:359]
private static void customizePackageInfos(Editor editor) {
editor.replaceFile("src/main/java/com/azure/security/keyvault/certificates/package-info.java",
"// Copyright (c) Microsoft Corporation. All rights reserved.\n"
+ "// Licensed under the MIT License.\n"
+ "\n"
+ "/**\n"
+ " * <!-- @formatter:off -->\n"
+ " * <p><a href=\"https://learn.microsoft.com/azure/certificate-vault/general/\">Azure Key Vault</a> is a cloud-based service\n"
+ " * provided by Microsoft Azure that allows users to securely store and manage cryptographic certificates used for encrypting\n"
+ " * and decrypting data. It is a part of Azure Key Vault, which is a cloud-based service for managing cryptographic certificates,\n"
+ " * keys, and secrets.</p>\n"
+ " *\n"
+ " * <p>Azure Key Vault Certificates provides a centralized and highly secure location for storing certificates, which\n"
+ " * eliminates the need to store sensitive certificate material in application code or configuration files.\n"
+ " * By leveraging Azure Key Vault, you can better protect your certificates and ensure their availability\n"
+ " * when needed.</p>\n"
+ " *\n"
+ " * <p>Key features of the Azure Key Vault Certificates service include:</p>\n"
+ " *\n"
+ " * <ul>\n"
+ " * <li>Secure storage: Certificates are stored securely within Azure Key Vault, which provides robust encryption\n"
+ " * and access control mechanisms to protect against unauthorized access.</li>\n"
+ " * <li>Certificate lifecycle management: You can create, import, and manage certificates within Azure Key Vault.\n"
+ " * It supports common certificate formats such as X.509 and PFX.</li>\n"
+ " * <li>Certificate management operations: Azure Key Vault provides a comprehensive set of management operations,\n"
+ " * including certificate creation, deletion, retrieval, renewal, and revocation.</li>\n"
+ " * <li>Integration with Azure services: Key Vault Certificates can be easily integrated with other Azure services,\n"
+ " * such as Azure App Service, Azure Functions, and Azure Virtual Machines, to enable secure authentication\n"
+ " * and encryption.</li>\n"
+ " * </ul>\n"
+ " *\n"
+ " * <p>The Azure Key Vault Certificates client library allows developers to securely store and manage certificates\n"
+ " * within Azure Key Vault. The library provides a set of APIs that enable developers to securely create, import,\n"
+ " * retrieve, update, and perform other certificate-related operations.</p>\n"
+ " *\n"
+ " * <p><strong>Key Concepts:</strong></p>\n"
+ " *\n"
+ " * <p>What is a Certificate Client?</p>\n"
+ " *\n"
+ " * <p>The certificate client performs the interactions with the Azure Key Vault service for getting, setting, updating,\n"
+ " * deleting, and listing certificates and its versions. Asynchronous (CertificateAsyncClient) and synchronous (CertificateClient) clients\n"
+ " * exist in the SDK allowing for the selection of a client based on an application's use case. Once you have\n"
+ " * initialized a certificate, you can interact with the primary resource types in Azure Key Vault.</p>\n"
+ " *\n"
+ " * <p>What is an Azure Key Vault Certificate ?</p>\n"
+ " *\n"
+ " * <p>Azure Key Vault supports certificates with secret content types (PKCS12 and PEM). The certificate can be\n"
+ " * backed by keys in Azure Key Vault of types (EC and RSA). In addition to the certificate policy, the following\n"
+ " * attributes may be specified:.</p>\n"
+ " *\n"
+ " * <ul>\n"
+ " * <li>enabled: Specifies whether the certificate is enabled and usable.</li>\n"
+ " * <li>created: Indicates when this version of the certificate was created.</li>\n"
+ " * <li>updated: Indicates when this version of the certificate was updated.</li>\n"
+ " * </ul>\n"
+ " *\n"
+ " * <h2>Getting Started</h2>\n"
+ " *\n"
+ " * <p>In order to interact with the Azure Key Vault service, you will need to create an instance of the\n"
+ " * {@link com.azure.security.keyvault.certificates.CertificateClient} or {@link com.azure.security.keyvault.certificates.CertificateAsyncClient} class, a vault url and a credential object.</p>\n"
+ " *\n"
+ " * <p>The examples shown in this document use a credential object named DefaultAzureCredential for authentication,\n"
+ " * which is appropriate for most scenarios, including local development and production environments. Additionally,\n"
+ " * we recommend using a\n"
+ " * <a href=\"https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/\">\n"
+ " * managed identity</a> for authentication in production environments.\n"
+ " * You can find more information on different ways of authenticating and their corresponding credential types in the\n"
+ " * <a href=\"https://learn.microsoft.com/java/api/overview/azure/identity-readme?view=azure-java-stable\">\n"
+ " * Azure Identity documentation\"</a>.</p>\n"
+ " *\n"
+ " * <p><strong>Sample: Construct Synchronous Certificate Client</strong></p>\n"
+ " *\n"
+ " * <p>The following code sample demonstrates the creation of a {@link com.azure.security.keyvault.certificates.CertificateClient},\n"
+ " * using the {@link com.azure.security.keyvault.certificates.CertificateClientBuilder} to configure it.</p>\n"
+ " *\n"
+ " * <!-- src_embed com.azure.security.keyvault.certificates.CertificateClient.instantiation -->\n"
+ " * <pre>\n"
+ " * CertificateClient certificateClient = new CertificateClientBuilder()\n"
+ " * .credential(new DefaultAzureCredentialBuilder().build())\n"
+ " * .vaultUrl("<your-key-vault-url>")\n"
+ " * .httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS))\n"
+ " * .buildClient();\n"
+ " * </pre>\n"
+ " * <!-- end com.azure.security.keyvault.certificates.CertificateClient.instantiation -->\n"
+ " *\n"
+ " * <p><strong>Sample: Construct Asynchronous Certificate Client</strong></p>\n"
+ " *\n"
+ " * <p>The following code sample demonstrates the creation of a\n"
+ " * {@link com.azure.security.keyvault.certificates.CertificateAsyncClient}, using the\n"
+ " * {@link com.azure.security.keyvault.certificates.CertificateClientBuilder} to configure it.</p>\n"
+ " *\n"
+ " * <!-- src_embed com.azure.security.keyvault.certificates.CertificateAsyncClient.instantiation -->\n"
+ " * <pre>\n"
+ " * CertificateAsyncClient certificateAsyncClient = new CertificateClientBuilder()\n"
+ " * .credential(new DefaultAzureCredentialBuilder().build())\n"
+ " * .vaultUrl("<your-key-vault-url>")\n"
+ " * .httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS))\n"
+ " * .buildAsyncClient();\n"
+ " * </pre>\n"
+ " * <!-- end com.azure.security.keyvault.certificates.CertificateAsyncClient.instantiation -->\n"
+ " *\n"
+ " * <br/>\n"
+ " *\n"
+ " * <hr/>\n"
+ " *\n"
+ " * <h2>Create a Certificate</h2>\n"
+ " * The {@link com.azure.security.keyvault.certificates.CertificateClient} or\n"
+ " * {@link com.azure.security.keyvault.certificates.CertificateAsyncClient} can be used to create a certificate in\n"
+ " * the key vault.\n"
+ " *\n"
+ " * <p><strong>Synchronous Code Sample:</strong></p>\n"
+ " * <p>The following code sample demonstrates how to synchronously create a certificate in the key vault,\n"
+ " * using the {@link com.azure.security.keyvault.certificates.CertificateClient#beginCreateCertificate(java.lang.String, com.azure.security.keyvault.certificates.models.CertificatePolicy)} API.</p>\n"
+ " *\n"
+ " * <!-- src_embed com.azure.security.keyvault.certificates.CertificateClient.beginCreateCertificate#String-CertificatePolicy -->\n"
+ " * <pre>\n"
+ " * CertificatePolicy certPolicy = new CertificatePolicy("Self",\n"
+ " * "CN=SelfSignedJavaPkcs12");\n"
+ " * SyncPoller<CertificateOperation, KeyVaultCertificateWithPolicy> certPoller = certificateClient\n"
+ " * .beginCreateCertificate("certificateName", certPolicy);\n"
+ " * certPoller.waitUntil(LongRunningOperationStatus.SUCCESSFULLY_COMPLETED);\n"
+ " * KeyVaultCertificate cert = certPoller.getFinalResult();\n"
+ " * System.out.printf("Certificate created with name %s%n", cert.getName());\n"
+ " * </pre>\n"
+ " * <!-- end com.azure.security.keyvault.certificates.CertificateClient.beginCreateCertificate#String-CertificatePolicy -->\n"
+ " *\n"
+ " * <p><strong>Note:</strong> For the asynchronous sample, refer to\n"
+ " * {@link com.azure.security.keyvault.certificates.CertificateAsyncClient}.</p>\n"
+ " *\n"
+ " * <br/>\n"
+ " *\n"
+ " * <hr/>\n"
+ " *\n"
+ " * <h2>Get a Certificate</h2>\n"
+ " * The {@link com.azure.security.keyvault.certificates.CertificateClient} or\n"
+ " * {@link com.azure.security.keyvault.certificates.CertificateAsyncClient} can be used to retrieve a certificate from the\n"
+ " * key vault.\n"
+ " *\n"
+ " * <p><strong>Synchronous Code Sample:</strong></p>\n"
+ " * <p>The following code sample demonstrates how to synchronously retrieve a certificate from the key vault, using\n"
+ " * the {@link com.azure.security.keyvault.certificates.CertificateClient#getCertificate(java.lang.String)}.</p>\n"
+ " *\n"
+ " * <!-- src_embed com.azure.security.keyvault.certificates.CertificateClient.getCertificatePolicy#string -->\n"
+ " * <pre>\n"
+ " * CertificatePolicy policy = certificateClient.getCertificatePolicy("certificateName");\n"
+ " * System.out.printf("Received policy with subject name %s%n", policy.getSubject());\n"
+ " * </pre>\n"
+ " * <!-- end com.azure.security.keyvault.certificates.CertificateClient.getCertificatePolicy#string -->\n"
+ " *\n"
+ " * <p><strong>Note:</strong> For the asynchronous sample, refer to\n"
+ " * {@link com.azure.security.keyvault.certificates.CertificateAsyncClient}.</p>\n"
+ " *\n"
+ " * <br/>\n"
+ " *\n"
+ " * <hr/>\n"
+ " *\n"
+ " * <h2>Delete a Certificate</h2>\n"
+ " * The {@link com.azure.security.keyvault.certificates.CertificateClient} or\n"
+ " * {@link com.azure.security.keyvault.certificates.CertificateAsyncClient} can be used to delete a certificate from\n"
+ " * the key vault.\n"
+ " *\n"
+ " * <p><strong>Synchronous Code Sample:</strong></p>\n"
+ " * <p>The following code sample demonstrates how to synchronously delete a certificate from the\n"
+ " * key vault, using the {@link com.azure.security.keyvault.certificates.CertificateClient#beginDeleteCertificate(java.lang.String)} API.</p>\n"
+ " *\n"
+ " * <!-- src_embed com.azure.security.keyvault.certificates.CertificateClient.beginDeleteCertificate#String -->\n"
+ " * <pre>\n"
+ " * SyncPoller<DeletedCertificate, Void> deleteCertPoller =\n"
+ " * certificateClient.beginDeleteCertificate("certificateName");\n"
+ " * // Deleted Certificate is accessible as soon as polling beings.\n"
+ " * PollResponse<DeletedCertificate> deleteCertPollResponse = deleteCertPoller.poll();\n"
+ " * System.out.printf("Deleted certificate with name %s and recovery id %s%n",\n"
+ " * deleteCertPollResponse.getValue().getName(), deleteCertPollResponse.getValue().getRecoveryId());\n"
+ " * deleteCertPoller.waitForCompletion();\n"
+ " * </pre>\n"
+ " * <!-- end com.azure.security.keyvault.certificates.CertificateClient.beginDeleteCertificate#String -->\n"
+ " *\n"
+ " * <p><strong>Note:</strong> For the asynchronous sample, refer to\n"
+ " * {@link com.azure.security.keyvault.certificates.CertificateAsyncClient}.</p>\n"
+ " *\n"
+ " * @see com.azure.security.keyvault.certificates.CertificateClient\n"
+ " * @see com.azure.security.keyvault.certificates.CertificateAsyncClient\n"
+ " * @see com.azure.security.keyvault.certificates.CertificateClientBuilder\n"
+ " */\n"
+ "package com.azure.security.keyvault.certificates;\n");
editor.replaceFile("src/main/java/com/azure/security/keyvault/certificates/models/package-info.java",
"// Copyright (c) Microsoft Corporation. All rights reserved.\n"
+ "// Licensed under the MIT License.\n"
+ "\n"
+ "/**\n"
+ " * <!-- @formatter:off -->\n"
+ " * Package containing the data models for Certificates clients. The key vault client performs cryptographic key and\n"
+ " * vault operations against the Key Vault service.\n"
+ " */\n"
+ "package com.azure.security.keyvault.certificates.models;\n");
editor.replaceFile("src/main/java/com/azure/security/keyvault/certificates/implementation/package-info.java",
"// Copyright (c) Microsoft Corporation. All rights reserved.\n"
+ "// Licensed under the MIT License.\n"
+ "\n"
+ "/**\n"
+ " * <!-- @formatter:off -->\n"
+ " * Package containing the implementations for Certificates clients. The key vault client performs cryptographic key\n"
+ " * operations and vault operations against the Key Vault service.\n"
+ " */\n"
+ "package com.azure.security.keyvault.certificates.implementation;\n");
editor.replaceFile("src/main/java/com/azure/security/keyvault/certificates/implementation/models/package-info.java",
"// Copyright (c) Microsoft Corporation. All rights reserved.\n"
+ "// Licensed under the MIT License.\n"
+ "\n"
+ "/**\n"
+ " * <!-- @formatter:off -->\n"
+ " * Package containing the implementation data models for Certificates clients. The key vault client performs\n"
+ " * cryptographic key operations and vault operations against the Key Vault service.\n"
+ " */\n"
+ "package com.azure.security.keyvault.certificates.implementation.models;\n");
}