Certificate interface
Interface que representa um Certificado.
Métodos
| create |
Cria ou atualiza o certificado que está sendo usado para autenticação com o back-end. |
| delete(string, string, string, string, Certificate |
Exclui certificado específico. |
| get(string, string, string, Certificate |
Obtém os detalhes do certificado especificado por seu identificador. |
| get |
Obtém a versão do estado da entidade (Etag) do certificado especificado por seu identificador. |
| list |
Lista uma coleção de todos os certificados na instância de serviço especificada. |
| refresh |
No KeyVault, atualize o certificado que está sendo usado para autenticação com o back-end. |
Detalhes de Método
createOrUpdate(string, string, string, CertificateCreateOrUpdateParameters, CertificateCreateOrUpdateOptionalParams)
Cria ou atualiza o certificado que está sendo usado para autenticação com o back-end.
function createOrUpdate(resourceGroupName: string, serviceName: string, certificateId: string, parameters: CertificateCreateOrUpdateParameters, options?: CertificateCreateOrUpdateOptionalParams): Promise<CertificateCreateOrUpdateResponse>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- certificateId
-
string
Identificador da entidade certificadora. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- parameters
- CertificateCreateOrUpdateParameters
Criar ou atualizar parâmetros.
Os parâmetros de opções.
Devoluções
Promise<CertificateCreateOrUpdateResponse>
delete(string, string, string, string, CertificateDeleteOptionalParams)
Exclui certificado específico.
function delete(resourceGroupName: string, serviceName: string, certificateId: string, ifMatch: string, options?: CertificateDeleteOptionalParams): Promise<void>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- certificateId
-
string
Identificador da entidade certificadora. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado atual da entidade a partir da resposta do cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
- options
- CertificateDeleteOptionalParams
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, CertificateGetOptionalParams)
Obtém os detalhes do certificado especificado por seu identificador.
function get(resourceGroupName: string, serviceName: string, certificateId: string, options?: CertificateGetOptionalParams): Promise<CertificateGetResponse>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- certificateId
-
string
Identificador da entidade certificadora. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- options
- CertificateGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<CertificateGetResponse>
getEntityTag(string, string, string, CertificateGetEntityTagOptionalParams)
Obtém a versão do estado da entidade (Etag) do certificado especificado por seu identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, certificateId: string, options?: CertificateGetEntityTagOptionalParams): Promise<CertificateGetEntityTagHeaders>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- certificateId
-
string
Identificador da entidade certificadora. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
Os parâmetros de opções.
Devoluções
Promise<CertificateGetEntityTagHeaders>
listByService(string, string, CertificateListByServiceOptionalParams)
Lista uma coleção de todos os certificados na instância de serviço especificada.
function listByService(resourceGroupName: string, serviceName: string, options?: CertificateListByServiceOptionalParams): PagedAsyncIterableIterator<CertificateContract, CertificateContract[], PageSettings>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
Os parâmetros de opções.
Devoluções
refreshSecret(string, string, string, CertificateRefreshSecretOptionalParams)
No KeyVault, atualize o certificado que está sendo usado para autenticação com o back-end.
function refreshSecret(resourceGroupName: string, serviceName: string, certificateId: string, options?: CertificateRefreshSecretOptionalParams): Promise<CertificateRefreshSecretResponse>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- certificateId
-
string
Identificador da entidade certificadora. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
Os parâmetros de opções.
Devoluções
Promise<CertificateRefreshSecretResponse>