azure.mgmt.web.v2023_12_01.models.Certificate.yml

### YamlMime:PythonClass
uid: azure.mgmt.web.v2023_12_01.models.Certificate
name: Certificate
fullName: azure.mgmt.web.v2023_12_01.models.Certificate
module: azure.mgmt.web.v2023_12_01.models
inheritances:
- azure.mgmt.web.v2023_12_01.models._models_py3.Resource
summary: '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.'
constructor:
  syntax: 'Certificate(*, location: str, kind: str | None = None, tags: Dict[str,
    str] | None = None, password: str | None = None, host_names: List[str] | None
    = None, pfx_blob: bytes | 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, domain_validation_method: str | None = None, **kwargs: Any)'
  keywordOnlyParameters:
  - name: kind
    description: Kind of resource.
    types:
    - <xref:str>
  - name: location
    description: Resource Location. Required.
    types:
    - <xref:str>
  - name: tags
    description: Resource tags.
    types:
    - <xref:dict>[<xref:str>, <xref:str>]
  - name: password
    description: Certificate password.
    types:
    - <xref:str>
  - name: host_names
    description: Host names the certificate applies to.
    types:
    - <xref:list>[<xref:str>]
  - name: pfx_blob
    description: Pfx blob.
    types:
    - <xref:bytes>
  - name: key_vault_id
    description: Key Vault Csm resource Id.
    types:
    - <xref:str>
  - name: key_vault_secret_name
    description: Key Vault secret name.
    types:
    - <xref:str>
  - name: server_farm_id
    description: 'Resource ID of the associated App Service plan, formatted as:

      "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".  #
      pylint: disable=line-too-long'
    types:
    - <xref:str>
  - name: canonical_name
    description: CNAME of the certificate to be issued via free certificate.
    types:
    - <xref:str>
  - name: domain_validation_method
    description: Method of domain validation for free cert.
    types:
    - <xref:str>
variables:
- description: Resource Id.
  name: id
  types:
  - <xref:str>
- description: Resource Name.
  name: name
  types:
  - <xref:str>
- description: Kind of resource.
  name: kind
  types:
  - <xref:str>
- description: Resource Location. Required.
  name: location
  types:
  - <xref:str>
- description: Resource type.
  name: type
  types:
  - <xref:str>
- description: Resource tags.
  name: tags
  types:
  - <xref:dict>[<xref:str>, <xref:str>]
- description: Certificate password.
  name: password
  types:
  - <xref:str>
- description: Friendly name of the certificate.
  name: friendly_name
  types:
  - <xref:str>
- description: Subject name of the certificate.
  name: subject_name
  types:
  - <xref:str>
- description: Host names the certificate applies to.
  name: host_names
  types:
  - <xref:list>[<xref:str>]
- description: Pfx blob.
  name: pfx_blob
  types:
  - <xref:bytes>
- description: App name.
  name: site_name
  types:
  - <xref:str>
- description: Self link.
  name: self_link
  types:
  - <xref:str>
- description: Certificate issuer.
  name: issuer
  types:
  - <xref:str>
- description: Certificate issue Date.
  name: issue_date
  types:
  - <xref:datetime.datetime>
- description: Certificate expiration date.
  name: expiration_date
  types:
  - <xref:datetime.datetime>
- description: Certificate thumbprint.
  name: thumbprint
  types:
  - <xref:str>
- description: Is the certificate valid?.
  name: valid
  types:
  - <xref:bool>
- description: Raw bytes of .cer file.
  name: cer_blob
  types:
  - <xref:bytes>
- description: Public key hash.
  name: public_key_hash
  types:
  - <xref:str>
- description: 'Specification for the App Service Environment to use for the

    certificate.'
  name: hosting_environment_profile
  types:
  - <xref:azure.mgmt.web.v2023_12_01.models.HostingEnvironmentProfile>
- description: Key Vault Csm resource Id.
  name: key_vault_id
  types:
  - <xref:str>
- description: Key Vault secret name.
  name: key_vault_secret_name
  types:
  - <xref:str>
- description: 'Status of the Key Vault secret. Known values are: "Initialized",

    "WaitingOnCertificateOrder", "Succeeded", "CertificateOrderFailed",

    "OperationNotPermittedOnKeyVault", "AzureServiceUnauthorizedToAccessKeyVault",

    "KeyVaultDoesNotExist", "KeyVaultSecretDoesNotExist", "UnknownError", "ExternalPrivateKey",
    and

    "Unknown".'
  name: key_vault_secret_status
  types:
  - <xref:str>
  - <xref:azure.mgmt.web.v2023_12_01.models.KeyVaultSecretStatus>
- description: 'Resource ID of the associated App Service plan, formatted as:

    "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".  #
    pylint: disable=line-too-long'
  name: server_farm_id
  types:
  - <xref:str>
- description: CNAME of the certificate to be issued via free certificate.
  name: canonical_name
  types:
  - <xref:str>
- description: Method of domain validation for free cert.
  name: domain_validation_method
  types:
  - <xref:str>