Share via

CertificatePatchResource interface

  • Reference
Package:
@azure/arm-appservice

ARM resource for a certificate.

Extends
ProxyOnlyResource

Properties

canonicalName

CNAME of the certificate to be issued via free certificate
cerBlob

Raw bytes of .cer file NOTE: This property will not be serialized. It can only be populated by the server.
domainValidationMethod

Method of domain validation for free cert
expirationDate

Certificate expiration date. NOTE: This property will not be serialized. It can only be populated by the server.
friendlyName

Friendly name of the certificate. NOTE: This property will not be serialized. It can only be populated by the server.
hostingEnvironmentProfile

Specification for the App Service Environment to use for the certificate. NOTE: This property will not be serialized. It can only be populated by the server.
hostNames

Host names the certificate applies to.
issueDate

Certificate issue Date. NOTE: This property will not be serialized. It can only be populated by the server.
issuer

Certificate issuer. NOTE: This property will not be serialized. It can only be populated by the server.
keyVaultId

Key Vault Csm resource Id.
keyVaultSecretName

Key Vault secret name.
keyVaultSecretStatus

Status of the Key Vault secret. NOTE: This property will not be serialized. It can only be populated by the server.
password

Certificate password.
pfxBlob

Pfx blob.
publicKeyHash

Public key hash. NOTE: This property will not be serialized. It can only be populated by the server.
selfLink

Self link. NOTE: This property will not be serialized. It can only be populated by the server.
serverFarmId

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

App name. NOTE: This property will not be serialized. It can only be populated by the server.
subjectName

Subject name of the certificate. NOTE: This property will not be serialized. It can only be populated by the server.
thumbprint

Certificate thumbprint. NOTE: This property will not be serialized. It can only be populated by the server.
valid

Is the certificate valid?. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.
kind

Kind of resource.
name

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.
type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

canonicalName

CNAME of the certificate to be issued via free certificate

canonicalName?: string

Property Value

string

cerBlob

Raw bytes of .cer file NOTE: This property will not be serialized. It can only be populated by the server.

cerBlob?: Uint8Array

Property Value

Uint8Array

domainValidationMethod

Method of domain validation for free cert

domainValidationMethod?: string

Property Value

string

expirationDate

Certificate expiration date. NOTE: This property will not be serialized. It can only be populated by the server.

expirationDate?: Date

Property Value

Date

friendlyName

Friendly name of the certificate. NOTE: This property will not be serialized. It can only be populated by the server.

friendlyName?: string

Property Value

string

hostingEnvironmentProfile

Specification for the App Service Environment to use for the certificate. NOTE: This property will not be serialized. It can only be populated by the server.

hostingEnvironmentProfile?: HostingEnvironmentProfile

Property Value

HostingEnvironmentProfile

hostNames

Host names the certificate applies to.

hostNames?: string[]

Property Value

string[]

issueDate

Certificate issue Date. NOTE: This property will not be serialized. It can only be populated by the server.

issueDate?: Date

Property Value

Date

issuer

Certificate issuer. NOTE: This property will not be serialized. It can only be populated by the server.

issuer?: string

Property Value

string

keyVaultId

Key Vault Csm resource Id.

keyVaultId?: string

Property Value

string

keyVaultSecretName

Key Vault secret name.

keyVaultSecretName?: string

Property Value

string

keyVaultSecretStatus

Status of the Key Vault secret. NOTE: This property will not be serialized. It can only be populated by the server.

keyVaultSecretStatus?: KeyVaultSecretStatus

Property Value

KeyVaultSecretStatus

password

Certificate password.

password?: string

Property Value

string

pfxBlob

Pfx blob.

pfxBlob?: Uint8Array

Property Value

Uint8Array

publicKeyHash

Public key hash. NOTE: This property will not be serialized. It can only be populated by the server.

publicKeyHash?: string

Property Value

string

Self link. NOTE: This property will not be serialized. It can only be populated by the server.

selfLink?: string

Property Value

string

serverFarmId

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

serverFarmId?: string

Property Value

string

siteName

App name. NOTE: This property will not be serialized. It can only be populated by the server.

siteName?: string

Property Value

string

subjectName

Subject name of the certificate. NOTE: This property will not be serialized. It can only be populated by the server.

subjectName?: string

Property Value

string

thumbprint

Certificate thumbprint. NOTE: This property will not be serialized. It can only be populated by the server.

thumbprint?: string

Property Value

string

valid

Is the certificate valid?. NOTE: This property will not be serialized. It can only be populated by the server.

valid?: boolean

Property Value

boolean

Inherited Property Details

id

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyOnlyResource.id

kind

Kind of resource.

kind?: string

Property Value

string

Inherited From ProxyOnlyResource.kind

name

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyOnlyResource.name

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyOnlyResource.type