CertificatePolicy Class
Management policy for a certificate.
- Inheritance
-
builtins.objectCertificatePolicy
Constructor
CertificatePolicy(issuer_name: str | None = None, **kwargs: Any)
Parameters
Name | Description |
---|---|
issuer_name
|
Default value: None
|
Keyword-Only Parameters
Name | Description |
---|---|
subject
|
The subject name of the certificate. Should be a valid X509 distinguished name. Either subject or one of the subject alternative name parameters are required for creating a certificate. This will be ignored when importing a certificate; the subject will be parsed from the imported certificate. |
san_emails
|
Subject alternative emails of the X509 object. Either subject or one of the subject alternative name parameters are required for creating a certificate. |
san_dns_names
|
Subject alternative DNS names of the X509 object. Either subject or one of the subject alternative name parameters are required for creating a certificate. |
san_user_principal_names
|
Subject alternative user principal names of the X509 object. Either subject or one of the subject alternative name parameters are required for creating a certificate. |
exportable
|
Indicates if the private key can be exported. For valid values, see KeyType. |
key_type
|
The type of key pair to be used for the certificate. |
key_size
|
The key size in bits. For example: 2048, 3072, or 4096 for RSA. |
reuse_key
|
Indicates if the same key pair will be used on certificate renewal. |
key_curve_name
|
Elliptic curve name. For valid values, see KeyCurveName. |
enhanced_key_usage
|
The extended ways the key of the certificate can be used. |
key_usage
|
List of key usages. |
content_type
|
The media type (MIME type) of the secret backing the certificate. If not specified, pkcs12 is assumed. |
validity_in_months
|
The duration that the certificate is valid in months. |
lifetime_actions
|
Actions that will be performed by Key Vault over the lifetime of a certificate. |
certificate_type
|
Type of certificate to be requested from the issuer provider. |
certificate_transparency
|
Indicates if the certificates generated under this policy should be published to certificate transparency logs. |
Methods
get_default |
get_default
get_default() -> CertificatePolicy
Attributes
certificate_transparency
Whether the certificates generated under this policy should be published to certificate transparency logs.
Returns
Type | Description |
---|---|
bool,
|
True if the certificates should be published to transparency logs; False otherwise. |
certificate_type
Type of certificate requested from the issuer provider.
Returns
Type | Description |
---|---|
str,
|
Type of certificate requested from the issuer provider. |
content_type
The media type (MIME type).
Returns
Type | Description |
---|---|
The media type (MIME type). |
created_on
The datetime when the certificate is created.
Returns
Type | Description |
---|---|
The datetime when the certificate is created. |
enabled
Whether the certificate is enabled or not.
Returns
Type | Description |
---|---|
bool,
|
True if the certificate is enabled; False otherwise. |
enhanced_key_usage
exportable
Whether the private key can be exported.
Returns
Type | Description |
---|---|
bool,
|
True if the private key can be exported; False otherwise. |
issuer_name
Name of the referenced issuer object or reserved names for the issuer of the certificate.
Returns
Type | Description |
---|---|
str,
|
Name of the referenced issuer object or reserved names for the issuer of the certificate. |
key_curve_name
key_size
key_type
The type of key pair to be used for the certificate.
Returns
Type | Description |
---|---|
The type of key pair to be used for the certificate. |
key_usage
lifetime_actions
Actions and their triggers that will be performed by Key Vault over the lifetime of the certificate.
Returns
Type | Description |
---|---|
Actions and their triggers that will be performed by Key Vault over the lifetime of the certificate. |
reuse_key
Whether the same key pair will be used on certificate renewal.
Returns
Type | Description |
---|---|
bool,
|
True if the same key pair will be used on certificate renewal; False otherwise. |
san_dns_names
The subject alternative domain names.
Returns
Type | Description |
---|---|
The subject alternative domain names, as a list. |
san_emails
The subject alternative email addresses.
Returns
Type | Description |
---|---|
The subject alternative email addresses, as a list. |
san_user_principal_names
The subject alternative user principal names.
Returns
Type | Description |
---|---|
The subject alternative user principal names, as a list. |
subject
The subject name of the certificate.
Returns
Type | Description |
---|---|
str,
|
The subject name of the certificate. |
updated_on
The datetime when the certificate was last updated.
Returns
Type | Description |
---|---|
The datetime when the certificate was last updated. |
validity_in_months
Azure SDK for Python