Certificates interface

套件:

@azure/arm-iothub

代表憑證的介面。

方法

createOrUpdate(string, string, string, CertificateDescription, CertificatesCreateOrUpdateOptionalParams)	新增或取代現有的憑證。
delete(string, string, string, string, CertificatesDeleteOptionalParams)	刪除現有的 X509 憑證，如果沒有，則不執行任何動作。
generateVerificationCode(string, string, string, string, CertificatesGenerateVerificationCodeOptionalParams)	產生擁有權證明流程的驗證碼。 驗證碼將用來產生分葉憑證。
get(string, string, string, CertificatesGetOptionalParams)	傳回憑證。
listByIotHub(string, string, CertificatesListByIotHubOptionalParams)	傳回憑證清單。
verify(string, string, string, string, CertificateVerificationDescription, CertificatesVerifyOptionalParams)	提供驗證預先上傳憑證所簽發的分葉憑證，以驗證憑證的私密金鑰擁有權。

方法詳細資料

createOrUpdate(string, string, string, CertificateDescription, CertificatesCreateOrUpdateOptionalParams)

新增或取代現有的憑證。

function createOrUpdate(resourceGroupName: string, resourceName: string, certificateName: string, certificateDescription: CertificateDescription, options?: CertificatesCreateOrUpdateOptionalParams): Promise<CertificateDescription>

參數

resourceGroupName

string

包含 IoT 中樞的資源組名。

resourceName

string

IoT 中樞的名稱。

certificateName

string

憑證的名稱

certificateDescription

CertificateDescription

憑證主體。

options

CertificatesCreateOrUpdateOptionalParams

選項參數。

傳回

Promise<CertificateDescription>

delete(string, string, string, string, CertificatesDeleteOptionalParams)

刪除現有的 X509 憑證，如果沒有，則不執行任何動作。

function delete(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, options?: CertificatesDeleteOptionalParams): Promise<void>

參數

resourceGroupName

string

包含 IoT 中樞的資源組名。

resourceName

string

IoT 中樞的名稱。

certificateName

string

憑證的名稱

ifMatch

string

憑證的 ETag。

options

CertificatesDeleteOptionalParams

選項參數。

傳回

Promise<void>

generateVerificationCode(string, string, string, string, CertificatesGenerateVerificationCodeOptionalParams)

產生擁有權證明流程的驗證碼。 驗證碼將用來產生分葉憑證。

function generateVerificationCode(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, options?: CertificatesGenerateVerificationCodeOptionalParams): Promise<CertificateWithNonceDescription>

參數

resourceGroupName

string

包含 IoT 中樞的資源組名。

resourceName

string

IoT 中樞的名稱。

certificateName

string

憑證的名稱

ifMatch

string

憑證的 ETag。

options

CertificatesGenerateVerificationCodeOptionalParams

選項參數。

傳回

Promise<CertificateWithNonceDescription>

get(string, string, string, CertificatesGetOptionalParams)

傳回憑證。

function get(resourceGroupName: string, resourceName: string, certificateName: string, options?: CertificatesGetOptionalParams): Promise<CertificateDescription>

參數

resourceGroupName

string

包含 IoT 中樞的資源組名。

resourceName

string

IoT 中樞的名稱。

certificateName

string

憑證的名稱

options

CertificatesGetOptionalParams

選項參數。

傳回

Promise<CertificateDescription>

listByIotHub(string, string, CertificatesListByIotHubOptionalParams)

傳回憑證清單。

function listByIotHub(resourceGroupName: string, resourceName: string, options?: CertificatesListByIotHubOptionalParams): Promise<CertificateListDescription>

參數

resourceGroupName

string

包含 IoT 中樞的資源組名。

resourceName

string

IoT 中樞的名稱。

options

CertificatesListByIotHubOptionalParams

選項參數。

傳回

Promise<CertificateListDescription>

verify(string, string, string, string, CertificateVerificationDescription, CertificatesVerifyOptionalParams)

提供驗證預先上傳憑證所簽發的分葉憑證，以驗證憑證的私密金鑰擁有權。

function verify(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, certificateVerificationBody: CertificateVerificationDescription, options?: CertificatesVerifyOptionalParams): Promise<CertificateDescription>

參數

resourceGroupName

string

包含 IoT 中樞的資源組名。

resourceName

string

IoT 中樞的名稱。

certificateName

string

憑證的名稱

ifMatch

string

憑證的 ETag。

certificateVerificationBody

CertificateVerificationDescription

憑證的名稱

options

CertificatesVerifyOptionalParams

選項參數。

傳回

Promise<CertificateDescription>