Feedback Edit

Certificate Class

  • Reference

SSL certificate for an app.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance
azure.mgmt.web.v2021_01_15.models._models_py3.Resource
Certificate

Constructor

Certificate(*, location: str, kind: Optional[str] = None, tags: Optional[Dict[str, str]] = None, password: Optional[str] = None, host_names: Optional[List[str]] = None, pfx_blob: Optional[bytearray] = None, key_vault_id: Optional[str] = None, key_vault_secret_name: Optional[str] = None, server_farm_id: Optional[str] = None, canonical_name: Optional[str] = None, domain_validation_method: Optional[str] = None, **kwargs)

Parameters

kind
str
Required

Kind of resource.

location
str
Required

Required. Resource Location.

tags
dict[str, str]
Required

A set of tags. Resource tags.

password
str
Required

Certificate password.

host_names
list[str]
Required

Host names the certificate applies to.

pfx_blob
bytearray
Required

Pfx blob.

key_vault_id
str
Required

Key Vault Csm resource Id.

key_vault_secret_name
str
Required

Key Vault secret name.

server_farm_id
str
Required

Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".

canonical_name
str
Required

CNAME of the certificate to be issued via free certificate.

domain_validation_method
str
Required

Method of domain validation for free cert.

Variables

id
str

Resource Id.

name
str

Resource Name.

type
str

Resource type.

friendly_name
str

Friendly name of the certificate.

subject_name
str

Subject name of the certificate.

site_name
str

App name.

self_link
str

Self link.

issuer
str

Certificate issuer.

issue_date
datetime

Certificate issue Date.

expiration_date
datetime

Certificate expiration date.

thumbprint
str

Certificate thumbprint.

valid
bool

Is the certificate valid?.

cer_blob
bytearray

Raw bytes of .cer file.

public_key_hash
str

Public key hash.

hosting_environment_profile
HostingEnvironmentProfile

Specification for the App Service Environment to use for the certificate.

key_vault_secret_status
str or KeyVaultSecretStatus

Status of the Key Vault secret. Possible values include: "Initialized", "WaitingOnCertificateOrder", "Succeeded", "CertificateOrderFailed", "OperationNotPermittedOnKeyVault", "AzureServiceUnauthorizedToAccessKeyVault", "KeyVaultDoesNotExist", "KeyVaultSecretDoesNotExist", "UnknownError", "ExternalPrivateKey", "Unknown".