Share via

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 server.

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

Constructor

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

Keyword-Only Parameters

Name Description
kind
str

Kind of resource.
location
str

Resource Location. Required.
tags
dict[str, str]

Resource tags.
host_names
list[str]

Host names the certificate applies to.
pfx_blob
bytes

Pfx blob.
password
str

Certificate password.
key_vault_id
str

Key Vault Csm resource Id.
key_vault_secret_name
str

Key Vault secret name.
server_farm_id
str

Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". # pylint: disable=line-too-long
canonical_name
str

CNAME of the certificate to be issued via free certificate.

Variables

Name Description
id
str

Resource Id.
name
str

Resource Name.
kind
str

Kind of resource.
location
str

Resource Location. Required.
type
str

Resource type.
tags
dict[str, str]

Resource tags.
friendly_name
str

Friendly name of the certificate.
subject_name
str

Subject name of the certificate.
host_names
list[str]

Host names the certificate applies to.
pfx_blob
bytes

Pfx blob.
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.
password
str

Certificate password.
thumbprint
str

Certificate thumbprint.
valid
bool

Is the certificate valid?.
cer_blob
bytes

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_id
str

Key Vault Csm resource Id.
key_vault_secret_name
str

Key Vault secret name.
key_vault_secret_status
str or KeyVaultSecretStatus

Status of the Key Vault secret. Known values are: "Initialized", "WaitingOnCertificateOrder", "Succeeded", "CertificateOrderFailed", "OperationNotPermittedOnKeyVault", "AzureServiceUnauthorizedToAccessKeyVault", "KeyVaultDoesNotExist", "KeyVaultSecretDoesNotExist", "UnknownError", "ExternalPrivateKey", and "Unknown".
server_farm_id
str

Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". # pylint: disable=line-too-long
canonical_name
str

CNAME of the certificate to be issued via free certificate.