SiteCertificates interface

Package:

@azure/arm-appservice

Interface representing a SiteCertificates.

Methods

createOrUpdate(string, string, string, Certificate, SiteCertificatesCreateOrUpdateOptionalParams)	Create or update a certificate under a given site.
createOrUpdateSlot(string, string, string, string, Certificate, SiteCertificatesCreateOrUpdateSlotOptionalParams)	Create or update a certificate in a given site and deployment slot.
delete(string, string, string, SiteCertificatesDeleteOptionalParams)	Delete a certificate from the site.
deleteSlot(string, string, string, string, SiteCertificatesDeleteSlotOptionalParams)	Delete a certificate for a given site and deployment slot.
get(string, string, string, SiteCertificatesGetOptionalParams)	Get a certificate belonging to a given site.
getSlot(string, string, string, string, SiteCertificatesGetSlotOptionalParams)	Get a certificate for a given site and deployment slot.
list(string, string, SiteCertificatesListOptionalParams)	Get all certificates in a resource group under a site.
listSlot(string, string, string, SiteCertificatesListSlotOptionalParams)	Get all certificates in a resource group for a given site and a deployment slot.
update(string, string, string, CertificatePatchResource, SiteCertificatesUpdateOptionalParams)	Create or update a certificate under a given site.
updateSlot(string, string, string, string, CertificatePatchResource, SiteCertificatesUpdateSlotOptionalParams)	Create or update a certificate for a site and deployment slot.

Method Details

createOrUpdate(string, string, string, Certificate, SiteCertificatesCreateOrUpdateOptionalParams)

Create or update a certificate under a given site.

function createOrUpdate(resourceGroupName: string, name: string, certificateName: string, certificateEnvelope: Certificate, options?: SiteCertificatesCreateOrUpdateOptionalParams): Promise<Certificate>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

name

string

Name of the site.

certificateName

string

Name of the certificate.

certificateEnvelope

Certificate

Details of certificate, if it exists already.

options

SiteCertificatesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Certificate>

createOrUpdateSlot(string, string, string, string, Certificate, SiteCertificatesCreateOrUpdateSlotOptionalParams)

Create or update a certificate in a given site and deployment slot.

function createOrUpdateSlot(resourceGroupName: string, name: string, slot: string, certificateName: string, certificateEnvelope: Certificate, options?: SiteCertificatesCreateOrUpdateSlotOptionalParams): Promise<Certificate>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

name

string

Name of the site.

slot

string

Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.

certificateName

string

Name of the certificate.

certificateEnvelope

Certificate

Details of certificate, if it exists already.

options

SiteCertificatesCreateOrUpdateSlotOptionalParams

The options parameters.

Returns

Promise<Certificate>

delete(string, string, string, SiteCertificatesDeleteOptionalParams)

Delete a certificate from the site.

function delete(resourceGroupName: string, name: string, certificateName: string, options?: SiteCertificatesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

name

string

Name of the site.

certificateName

string

Name of the certificate.

options

SiteCertificatesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

deleteSlot(string, string, string, string, SiteCertificatesDeleteSlotOptionalParams)

Delete a certificate for a given site and deployment slot.

function deleteSlot(resourceGroupName: string, name: string, slot: string, certificateName: string, options?: SiteCertificatesDeleteSlotOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

name

string

Name of the site.

slot

string

Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.

certificateName

string

Name of the certificate.

options

SiteCertificatesDeleteSlotOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, SiteCertificatesGetOptionalParams)

Get a certificate belonging to a given site.

function get(resourceGroupName: string, name: string, certificateName: string, options?: SiteCertificatesGetOptionalParams): Promise<Certificate>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

name

string

Name of the site.

certificateName

string

Name of the certificate.

options

SiteCertificatesGetOptionalParams

The options parameters.

Returns

Promise<Certificate>

getSlot(string, string, string, string, SiteCertificatesGetSlotOptionalParams)

Get a certificate for a given site and deployment slot.

function getSlot(resourceGroupName: string, name: string, slot: string, certificateName: string, options?: SiteCertificatesGetSlotOptionalParams): Promise<Certificate>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

name

string

Name of the site.

slot

string

Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.

certificateName

string

Name of the certificate.

options

SiteCertificatesGetSlotOptionalParams

The options parameters.

Returns

Promise<Certificate>

list(string, string, SiteCertificatesListOptionalParams)

Get all certificates in a resource group under a site.

function list(resourceGroupName: string, name: string, options?: SiteCertificatesListOptionalParams): PagedAsyncIterableIterator<Certificate, Certificate[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

name

string

Name of the site.

options

SiteCertificatesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Certificate, Certificate[], PageSettings>

listSlot(string, string, string, SiteCertificatesListSlotOptionalParams)

Get all certificates in a resource group for a given site and a deployment slot.

function listSlot(resourceGroupName: string, name: string, slot: string, options?: SiteCertificatesListSlotOptionalParams): PagedAsyncIterableIterator<Certificate, Certificate[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

name

string

Name of the site.

slot

string

Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.

options

SiteCertificatesListSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Certificate, Certificate[], PageSettings>

update(string, string, string, CertificatePatchResource, SiteCertificatesUpdateOptionalParams)

Create or update a certificate under a given site.

function update(resourceGroupName: string, name: string, certificateName: string, certificateEnvelope: CertificatePatchResource, options?: SiteCertificatesUpdateOptionalParams): Promise<Certificate>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

name

string

Name of the site.

certificateName

string

Name of the certificate.

certificateEnvelope

CertificatePatchResource

Details of certificate, if it exists already.

options

SiteCertificatesUpdateOptionalParams

The options parameters.

Returns

Promise<Certificate>

updateSlot(string, string, string, string, CertificatePatchResource, SiteCertificatesUpdateSlotOptionalParams)

Create or update a certificate for a site and deployment slot.

function updateSlot(resourceGroupName: string, name: string, slot: string, certificateName: string, certificateEnvelope: CertificatePatchResource, options?: SiteCertificatesUpdateSlotOptionalParams): Promise<Certificate>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

name

string

Name of the site.

slot

string

Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.

certificateName

string

Name of the certificate.

certificateEnvelope

CertificatePatchResource

Details of certificate, if it exists already.

options

SiteCertificatesUpdateSlotOptionalParams

The options parameters.

Returns

Promise<Certificate>