Certificates interface
Interface representing a Certificates.
Methods
create |
Create or update a certificate. |
delete(string, string, Certificates |
Delete a certificate. |
get(string, string, Certificates |
Get a certificate. |
list(Certificates |
Get all certificates for a subscription. |
list |
Get all certificates in a resource group. |
update(string, string, Certificate |
Create or update a certificate. |
Method Details
createOrUpdate(string, string, Certificate, CertificatesCreateOrUpdateOptionalParams)
Create or update a certificate.
function createOrUpdate(resourceGroupName: string, name: string, certificateEnvelope: Certificate, options?: CertificatesCreateOrUpdateOptionalParams): Promise<Certificate>
Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the certificate.
- certificateEnvelope
- Certificate
Details of certificate, if it exists already.
The options parameters.
Returns
Promise<Certificate>
delete(string, string, CertificatesDeleteOptionalParams)
Delete a certificate.
function delete(resourceGroupName: string, name: string, options?: CertificatesDeleteOptionalParams): Promise<void>
Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the certificate.
- options
- CertificatesDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, CertificatesGetOptionalParams)
Get a certificate.
function get(resourceGroupName: string, name: string, options?: CertificatesGetOptionalParams): Promise<Certificate>
Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the certificate.
- options
- CertificatesGetOptionalParams
The options parameters.
Returns
Promise<Certificate>
list(CertificatesListOptionalParams)
Get all certificates for a subscription.
function list(options?: CertificatesListOptionalParams): PagedAsyncIterableIterator<Certificate, Certificate[], PageSettings>
Parameters
- options
- CertificatesListOptionalParams
The options parameters.
Returns
listByResourceGroup(string, CertificatesListByResourceGroupOptionalParams)
Get all certificates in a resource group.
function listByResourceGroup(resourceGroupName: string, options?: CertificatesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Certificate, Certificate[], PageSettings>
Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
The options parameters.
Returns
update(string, string, CertificatePatchResource, CertificatesUpdateOptionalParams)
Create or update a certificate.
function update(resourceGroupName: string, name: string, certificateEnvelope: CertificatePatchResource, options?: CertificatesUpdateOptionalParams): Promise<Certificate>
Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the certificate.
- certificateEnvelope
- CertificatePatchResource
Details of certificate, if it exists already.
- options
- CertificatesUpdateOptionalParams
The options parameters.
Returns
Promise<Certificate>