Certificates interface
証明書を表すインターフェイス。
メソッド
| create |
新しい証明書を追加するか、既存の証明書を置き換えます。 |
| delete(string, string, string, string, Certificates |
既存の X509 証明書を削除するか、存在しない場合は何も行いません。 |
| generate |
所有フローの証明用の検証コードを生成します。 検証コードは、リーフ証明書の生成に使用されます。 |
| get(string, string, string, Certificates |
証明書を返します。 |
| list |
証明書の一覧を返します。 |
| verify(string, string, string, string, Certificate |
事前にアップロードされた証明書の検証によって発行されたリーフ証明書を指定して、証明書の秘密キーの所有を確認します。 |
メソッドの詳細
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 パラメーター。
戻り値
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
options パラメーター。
戻り値
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 パラメーター。
戻り値
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
options パラメーター。
戻り値
Promise<CertificateDescription>
listByIotHub(string, string, CertificatesListByIotHubOptionalParams)
証明書の一覧を返します。
function listByIotHub(resourceGroupName: string, resourceName: string, options?: CertificatesListByIotHubOptionalParams): Promise<CertificateListDescription>パラメーター
- resourceGroupName
-
string
IoT ハブを含むリソース グループの名前。
- resourceName
-
string
IoT ハブの名前。
options パラメーター。
戻り値
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
options パラメーター。
戻り値
Promise<CertificateDescription>