16 строки
12 KiB
YAML
16 строки
12 KiB
YAML
### YamlMime:JavaPackage
|
|
uid: "com.azure.security.keyvault.certificates"
|
|
fullName: "com.azure.security.keyvault.certificates"
|
|
name: "com.azure.security.keyvault.certificates"
|
|
summary: "[Azure Key Vault][] is a cloud-based service provided by Microsoft Azure that allows users to securely store and manage cryptographic certificates used for encrypting and decrypting data.\n\n\n[Azure Key Vault]: https://learn.microsoft.com/azure/certificate-vault/general/"
|
|
classes:
|
|
- "com.azure.security.keyvault.certificates.CertificateAsyncClient"
|
|
- "com.azure.security.keyvault.certificates.CertificateClient"
|
|
- "com.azure.security.keyvault.certificates.CertificateClientBuilder"
|
|
enums:
|
|
- "com.azure.security.keyvault.certificates.CertificateServiceVersion"
|
|
desc: "[Azure Key Vault][] is a cloud-based service provided by Microsoft Azure that allows users to securely store and manage cryptographic certificates used for encrypting and decrypting data. It is a part of Azure Key Vault, which is a cloud-based service for managing cryptographic certificates, keys, and secrets.\n\nAzure Key Vault Certificates provides a centralized and highly secure location for storing certificates, which eliminates the need to store sensitive certificate material in application code or configuration files. By leveraging Azure Key Vault, you can better protect your certificates and ensure their availability when needed.\n\nKey features of the Azure Key Vault Certificates service include:\n\n * Secure storage: Certificates are stored securely within Azure Key Vault, which provides robust encryption and access control mechanisms to protect against unauthorized access.\n * Certificate lifecycle management: You can create, import, and manage certificates within Azure Key Vault. It supports common certificate formats such as X.509 and PFX.\n * Certificate management operations: Azure Key Vault provides a comprehensive set of management operations, including certificate creation, deletion, retrieval, renewal, and revocation.\n * Integration with Azure services: Key Vault Certificates can be easily integrated with other Azure services, such as Azure App Service, Azure Functions, and Azure Virtual Machines, to enable secure authentication and encryption.\n\nThe Azure Key Vault Certificates client library allows developers to securely store and manage certificates within Azure Key Vault. The library provides a set of APIs that enable developers to securely create, import, retrieve, update, and perform other certificate-related operations.\n\n**Key Concepts:**\n\nWhat is a Certificate Client?\n\nThe certificate client performs the interactions with the Azure Key Vault service for getting, setting, updating, deleting, and listing certificates and its versions. Asynchronous (CertificateAsyncClient) and synchronous (CertificateClient) clients exist in the SDK allowing for the selection of a client based on an application's use case. Once you have initialized a certificate, you can interact with the primary resource types in Azure Key Vault.\n\nWhat is an Azure Key Vault Certificate ?\n\nAzure Key Vault supports certificates with secret content types (PKCS12 and PEM). The certificate can be backed by keys in Azure Key Vault of types (EC and RSA). In addition to the certificate policy, the following attributes may be specified:.\n\n * enabled: Specifies whether the certificate is enabled and usable.\n * created: Indicates when this version of the certificate was created.\n * updated: Indicates when this version of the certificate was updated.\n\n## Getting Started ##\n\nIn order to interact with the Azure Key Vault service, you will need to create an instance of the <xref uid=\"com.azure.security.keyvault.certificates.CertificateClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.security.keyvault.certificates.CertificateClient\"></xref> or <xref uid=\"com.azure.security.keyvault.certificates.CertificateAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.security.keyvault.certificates.CertificateAsyncClient\"></xref> class, a vault url and a credential object.\n\nThe examples shown in this document use a credential object named DefaultAzureCredential for authentication, which is appropriate for most scenarios, including local development and production environments. Additionally, we recommend using a [ managed identity][managed identity] for authentication in production environments. You can find more information on different ways of authenticating and their corresponding credential types in the [ Azure Identity documentation\"][Azure Identity documentation].\n\n**Sample: Construct Synchronous Certificate Client**\n\nThe following code sample demonstrates the creation of a <xref uid=\"com.azure.security.keyvault.certificates.CertificateClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.security.keyvault.certificates.CertificateClient\"></xref>, using the <xref uid=\"com.azure.security.keyvault.certificates.CertificateClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.security.keyvault.certificates.CertificateClientBuilder\"></xref> to configure it.\n\n```java\nCertificateClient 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```\n\n**Sample: Construct Asynchronous Certificate Client**\n\nThe following code sample demonstrates the creation of a <xref uid=\"com.azure.security.keyvault.certificates.CertificateAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.security.keyvault.certificates.CertificateAsyncClient\"></xref>, using the <xref uid=\"com.azure.security.keyvault.certificates.CertificateClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.security.keyvault.certificates.CertificateClientBuilder\"></xref> to configure it.\n\n```java\nCertificateAsyncClient 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```\n\n\n--------------------\n\n## Create a Certificate ##\n\nThe <xref uid=\"com.azure.security.keyvault.certificates.CertificateClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.security.keyvault.certificates.CertificateClient\"></xref> or <xref uid=\"com.azure.security.keyvault.certificates.CertificateAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.security.keyvault.certificates.CertificateAsyncClient\"></xref> can be used to create a certificate in the key vault.\n\n**Synchronous Code Sample:**\n\nThe following code sample demonstrates how to synchronously create a certificate in the key vault, using the <xref uid=\"com.azure.security.keyvault.certificates.CertificateClient.beginCreateCertificate(java.lang.String,com.azure.security.keyvault.certificates.models.CertificatePolicy)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.security.keyvault.certificates.CertificateClient#beginCreateCertificate(java.lang.String, com.azure.security.keyvault.certificates.models.CertificatePolicy)\"></xref> API.\n\n```java\nCertificatePolicy 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```\n\n**Note:** For the asynchronous sample, refer to <xref uid=\"com.azure.security.keyvault.certificates.CertificateAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.security.keyvault.certificates.CertificateAsyncClient\"></xref>.\n\n\n--------------------\n\n## Get a Certificate ##\n\nThe <xref uid=\"com.azure.security.keyvault.certificates.CertificateClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.security.keyvault.certificates.CertificateClient\"></xref> or <xref uid=\"com.azure.security.keyvault.certificates.CertificateAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.security.keyvault.certificates.CertificateAsyncClient\"></xref> can be used to retrieve a certificate from the key vault.\n\n**Synchronous Code Sample:**\n\nThe following code sample demonstrates how to synchronously retrieve a certificate from the key vault, using the <xref uid=\"com.azure.security.keyvault.certificates.CertificateClient.getCertificate(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.security.keyvault.certificates.CertificateClient#getCertificate(java.lang.String)\"></xref>.\n\n```java\nCertificatePolicy policy = certificateClient.getCertificatePolicy(\"certificateName\");\n System.out.printf(\"Received policy with subject name %s%n\", policy.getSubject());\n```\n\n**Note:** For the asynchronous sample, refer to <xref uid=\"com.azure.security.keyvault.certificates.CertificateAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.security.keyvault.certificates.CertificateAsyncClient\"></xref>.\n\n\n--------------------\n\n## Delete a Certificate ##\n\nThe <xref uid=\"com.azure.security.keyvault.certificates.CertificateClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.security.keyvault.certificates.CertificateClient\"></xref> or <xref uid=\"com.azure.security.keyvault.certificates.CertificateAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.security.keyvault.certificates.CertificateAsyncClient\"></xref> can be used to delete a certificate from the key vault.\n\n**Synchronous Code Sample:**\n\nThe following code sample demonstrates how to synchronously delete a certificate from the key vault, using the <xref uid=\"com.azure.security.keyvault.certificates.CertificateClient.beginDeleteCertificate(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.security.keyvault.certificates.CertificateClient#beginDeleteCertificate(java.lang.String)\"></xref> API.\n\n```java\nSyncPoller<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```\n\n**Note:** For the asynchronous sample, refer to <xref uid=\"com.azure.security.keyvault.certificates.CertificateAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.security.keyvault.certificates.CertificateAsyncClient\"></xref>.\n\n\n[Azure Key Vault]: https://learn.microsoft.com/azure/certificate-vault/general/\n[managed identity]: https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/\n[Azure Identity documentation]: https://learn.microsoft.com/java/api/overview/azure/identity-readme?view=azure-java-stable"
|
|
metadata: {}
|
|
package: "com.azure.security.keyvault.certificates"
|
|
artifact: com.azure:azure-security-keyvault-certificates:4.6.6
|