Class CertificatePolicy

java.lang.Object
com.azure.security.keyvault.certificates.models.CertificatePolicy
All Implemented Interfaces:
com.azure.json.JsonSerializable<CertificatePolicy>
public final class CertificatePolicy extends Object implements com.azure.json.JsonSerializable<CertificatePolicy>
The Certificate Management policy for the certificate.

  • Constructor Details

    • CertificatePolicy

      public CertificatePolicy(String issuerName, String subject)
      Creates certificate policy.
      Parameters:
      issuerName - The issuer name to set.
      subject - The subject name to set.

    • CertificatePolicy

      public CertificatePolicy(String issuerName, SubjectAlternativeNames subjectAlternativeNames)
      Creates certificate policy.
      Parameters:
      issuerName - The issuer name to set.
      subjectAlternativeNames - The subject alternative names to set.

    • CertificatePolicy

      public CertificatePolicy(String issuerName, String subject, SubjectAlternativeNames subjectAlternativeNames)
      Creates certificate policy.
      Parameters:
      issuerName - The issuer name to set.
      subject - The subject name to set.
      subjectAlternativeNames - The subject alternative names to set.

  • Method Details

    • getKeyUsage

      public List<CertificateKeyUsage> getKeyUsage()
      Get the key usage.
      Returns:
      the key usage

    • setKeyUsage

      public CertificatePolicy setKeyUsage(CertificateKeyUsage... keyUsage)
      Set the key usage.
      Parameters:
      keyUsage - the key usage value to set
      Returns:
      the updated CertificatePolicy object itself.

    • getEnhancedKeyUsage

      public List<String> getEnhancedKeyUsage()
      Get the enhanced key usage.
      Returns:
      the enhanced key usage

    • setEnhancedKeyUsage

      public CertificatePolicy setEnhancedKeyUsage(List<String> ekus)
      Set the enhanced key usage.
      Parameters:
      ekus - the ekus value to set
      Returns:
      the updated CertificatePolicy object itself.

    • isExportable

      public Boolean isExportable()
      Get the exportable.
      Returns:
      the exportable value

    • setExportable

      public CertificatePolicy setExportable(Boolean exportable)
      Set the exportable value.
      Parameters:
      exportable - the exportable value to set
      Returns:
      the updated CertificatePolicy object itself.

    • getKeyType

      public CertificateKeyType getKeyType()
      Get the key type.
      Returns:
      the key type value

    • setKeyType

      public CertificatePolicy setKeyType(CertificateKeyType keyType)
      Get the key type.
      Parameters:
      keyType - the key type
      Returns:
      the key type

    • getKeySize

      public Integer getKeySize()
      Get the key size.
      Returns:
      the key size

    • isKeyReusable

      public Boolean isKeyReusable()
      Get the key reuse status.
      Returns:
      the key reuse status

    • setKeyReusable

      public CertificatePolicy setKeyReusable(Boolean keyReusable)
      Set the reuse key value.
      Parameters:
      keyReusable - the reuseKey value to set
      Returns:
      the updated CertificatePolicy object itself.

    • getKeyCurveName

      public CertificateKeyCurveName getKeyCurveName()
      Get the key curve.
      Returns:
      the curve value

    • getCreatedOn

      public OffsetDateTime getCreatedOn()
      Get the the UTC time at which certificate policy was created.
      Returns:
      the created UTC time.

    • getUpdatedOn

      public OffsetDateTime getUpdatedOn()
      Get the UTC time at which certificate policy was last updated.
      Returns:
      the last updated UTC time.

    • isEnabled

      public Boolean isEnabled()
      Get the enabled status.
      Returns:
      the enabled status

    • setEnabled

      public CertificatePolicy setEnabled(Boolean enabled)
      Set the enabled status.
      Parameters:
      enabled - The enabled status to set.
      Returns:
      the updated CertificatePolicy object itself.

    • getContentType

      public CertificateContentType getContentType()
      Get the content type.
      Returns:
      the content type

    • setContentType

      public CertificatePolicy setContentType(CertificateContentType contentType)
      Set the content type.
      Parameters:
      contentType - the content type value to set
      Returns:
      the updated CertificatePolicy object itself.

    • getSubjectAlternativeNames

      public SubjectAlternativeNames getSubjectAlternativeNames()
      Get the subjectAlternativeNames.
      Returns:
      the subjectAlternativeNames.

    • setSubjectAlternativeNames

      public CertificatePolicy setSubjectAlternativeNames(SubjectAlternativeNames subjectAlternativeNames)
      Set the subjectAlternativeNames.
      Parameters:
      subjectAlternativeNames - the subjectAlternativeNames to set
      Returns:
      the updated CertificatePolicy object itself.

    • setSubject

      public CertificatePolicy setSubject(String subject)
      Set the subject Name.
      Parameters:
      subject - the subject Name to set
      Returns:
      the updated CertificatePolicy object itself.

    • setValidityInMonths

      public CertificatePolicy setValidityInMonths(Integer validityInMonths)
      Set the validity in months.
      Parameters:
      validityInMonths - the validityInMonths value to set
      Returns:
      the updated CertificatePolicy object itself.

    • setKeySize

      public CertificatePolicy setKeySize(Integer keySize)
      Set the key size.
      Parameters:
      keySize - the key size value to set
      Returns:
      the updated CertificatePolicy object itself.

    • setKeyCurveName

      public CertificatePolicy setKeyCurveName(CertificateKeyCurveName keyCurveName)
      Set the key curve.
      Parameters:
      keyCurveName - the key curve value to set
      Returns:
      the updated CertificatePolicy object itself.

    • setCertificateType

      public CertificatePolicy setCertificateType(String certificateType)
      Set the certificate type to request from the issuer.
      Parameters:
      certificateType - the certificateType to request from issuer.
      Returns:
      the updated CertificatePolicy object itself.

    • setCertificateTransparent

      public CertificatePolicy setCertificateTransparent(Boolean certificateTransparent)
      Set the certificate transparency status.
      Parameters:
      certificateTransparent - the certificateTransparency status to set
      Returns:
      the updated CertificatePolicy object itself.

    • getSubject

      public String getSubject()
      Get the subject.
      Returns:
      the subject

    • getValidityInMonths

      public Integer getValidityInMonths()
      Get the validity in months.
      Returns:
      the validity in months

    • getIssuerName

      public String getIssuerName()
      Get the issuer name.
      Returns:
      the issuer name.

    • getCertificateType

      public String getCertificateType()
      Get the certificate type.
      Returns:
      the certificate type

    • isCertificateTransparent

      public Boolean isCertificateTransparent()
      Get the certificate transparency status.
      Returns:
      the certificate transparency status

    • getPlatformManaged

      public PlatformManaged getPlatformManaged()
      Get the platform managed certificate configuration.

      Warning: this property is currently intended for internal (first-party) Key Vault use only. It is populated when the policy uses platform-managed configuration in service version 2026-04-01. Third-party callers should not rely on this property; the underlying service contract may change without notice.

      Returns:
      the platform managed certificate configuration.

    • setPlatformManaged

      public CertificatePolicy setPlatformManaged(PlatformManaged platformManaged)
      Set the platform managed certificate configuration.

      Warning: this property is currently intended for internal (first-party) Key Vault use only. It is exposed in service version 2026-04-01, but the feature is not generally available. Third-party calls that supply a PlatformManaged configuration will be rejected by the service. Do not use this setter in production code.

      Parameters:
      platformManaged - the platform managed certificate configuration.
      Returns:
      the updated CertificatePolicy object itself.

    • setLifetimeActions

      public CertificatePolicy setLifetimeActions(LifetimeAction... actions)
      Set the lifetime actions
      Parameters:
      actions - the lifetime actions to set.
      Returns:
      the updated certificate policy object itself.

    • getLifetimeActions

      public List<LifetimeAction> getLifetimeActions()
      Get the lifetime actions
      Returns:
      the lifetime actions

    • getDefault

      public static CertificatePolicy getDefault()
      Get the default certificate policy.
      Returns:
      the default certificate policy.

    • forPlatformManaged

      public static CertificatePolicy forPlatformManaged(PlatformManaged platformManaged)
      Creates a certificate policy for a platform-managed certificate. The returned policy contains only the platform-managed configuration (and optionally key properties set via subsequent calls such as setKeyType(CertificateKeyType) or setKeySize(Integer)). Issuer and X.509 certificate properties are intentionally left unset — the service rejects create requests that specify them when platformManaged is set.

      Warning: this factory is currently intended for internal (first-party) Key Vault use only. It targets service version 2026-04-01, but the feature is not generally available. Third-party calls will be rejected by the service. Do not use in production code.

      Parameters:
      platformManaged - the platform-managed certificate configuration.
      Returns:
      a CertificatePolicy suitable for creating a platform-managed certificate.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<CertificatePolicy>
      Throws:
      IOException

    • fromJson

      public static CertificatePolicy fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads a JSON stream into a CertificatePolicy.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      The CertificatePolicy that the JSON stream represented, may return null.
      Throws:
      IOException - If a CertificatePolicy fails to be read from the jsonReader.