Certificates interface
Interface que representa um Certificados.
Métodos
| create |
Adiciona um novo ou substitui o certificado existente. |
| delete(string, string, string, string, Certificates |
Exclui um certificado X509 existente ou não faz nada se ele não existir. |
| generate |
Gera o código de verificação para o fluxo de prova de posse. O código de verificação será usado para gerar um certificado folha. |
| get(string, string, string, Certificates |
Retorna o certificado. |
| list |
Retorna a lista de certificados. |
| verify(string, string, string, string, Certificate |
Verifica a posse de chave privada do certificado fornecendo o certificado folha emitido pelo certificado pré-carregado de verificação. |
Detalhes do método
createOrUpdate(string, string, string, CertificateDescription, CertificatesCreateOrUpdateOptionalParams)
Adiciona um novo ou substitui o certificado existente.
function createOrUpdate(resourceGroupName: string, resourceName: string, certificateName: string, certificateDescription: CertificateDescription, options?: CertificatesCreateOrUpdateOptionalParams): Promise<CertificateDescription>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do hub IoT.
- certificateName
-
string
O nome do certificado
- certificateDescription
- CertificateDescription
O corpo do certificado.
Os parâmetros de opções.
Retornos
Promise<CertificateDescription>
delete(string, string, string, string, CertificatesDeleteOptionalParams)
Exclui um certificado X509 existente ou não faz nada se ele não existir.
function delete(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, options?: CertificatesDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do hub IoT.
- certificateName
-
string
O nome do certificado
- ifMatch
-
string
ETag do Certificado.
- options
- CertificatesDeleteOptionalParams
Os parâmetros de opções.
Retornos
Promise<void>
generateVerificationCode(string, string, string, string, CertificatesGenerateVerificationCodeOptionalParams)
Gera o código de verificação para o fluxo de prova de posse. O código de verificação será usado para gerar um certificado folha.
function generateVerificationCode(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, options?: CertificatesGenerateVerificationCodeOptionalParams): Promise<CertificateWithNonceDescription>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do hub IoT.
- certificateName
-
string
O nome do certificado
- ifMatch
-
string
ETag do Certificado.
Os parâmetros de opções.
Retornos
Promise<CertificateWithNonceDescription>
get(string, string, string, CertificatesGetOptionalParams)
Retorna o certificado.
function get(resourceGroupName: string, resourceName: string, certificateName: string, options?: CertificatesGetOptionalParams): Promise<CertificateDescription>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do hub IoT.
- certificateName
-
string
O nome do certificado
- options
- CertificatesGetOptionalParams
Os parâmetros de opções.
Retornos
Promise<CertificateDescription>
listByIotHub(string, string, CertificatesListByIotHubOptionalParams)
Retorna a lista de certificados.
function listByIotHub(resourceGroupName: string, resourceName: string, options?: CertificatesListByIotHubOptionalParams): Promise<CertificateListDescription>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do hub IoT.
Os parâmetros de opções.
Retornos
Promise<CertificateListDescription>
verify(string, string, string, string, CertificateVerificationDescription, CertificatesVerifyOptionalParams)
Verifica a posse de chave privada do certificado fornecendo o certificado folha emitido pelo certificado pré-carregado de verificação.
function verify(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, certificateVerificationBody: CertificateVerificationDescription, options?: CertificatesVerifyOptionalParams): Promise<CertificateDescription>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do hub IoT.
- certificateName
-
string
O nome do certificado
- ifMatch
-
string
ETag do Certificado.
- certificateVerificationBody
- CertificateVerificationDescription
O nome do certificado
- options
- CertificatesVerifyOptionalParams
Os parâmetros de opções.
Retornos
Promise<CertificateDescription>