Partilhar via

Certificate interface

  • Referência
Pacote:
@azure/arm-apimanagement

Interface que representa um Certificado.

Métodos

createOrUpdate(string, string, string, CertificateCreateOrUpdateParameters, CertificateCreateOrUpdateOptionalParams)

Cria ou atualiza o certificado que está a ser utilizado para autenticação com o back-end.
delete(string, string, string, string, CertificateDeleteOptionalParams)

Elimina um certificado específico.
get(string, string, string, CertificateGetOptionalParams)

Obtém os detalhes do certificado especificado pelo respetivo identificador.
getEntityTag(string, string, string, CertificateGetEntityTagOptionalParams)

Obtém a versão do estado da entidade (Etag) do certificado especificado pelo respetivo identificador.
listByService(string, string, CertificateListByServiceOptionalParams)

Lista uma coleção de todos os certificados na instância de serviço especificada.
refreshSecret(string, string, string, CertificateRefreshSecretOptionalParams)

No KeyVault, atualize o certificado que está a ser utilizado para autenticação com o back-end.

Detalhes de Método

createOrUpdate(string, string, string, CertificateCreateOrUpdateParameters, CertificateCreateOrUpdateOptionalParams)

Cria ou atualiza o certificado que está a ser utilizado 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 é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

certificateId

string

Identificador da entidade de certificado. Tem de ser exclusivo na instância de serviço do Gestão de API atual.

parameters
CertificateCreateOrUpdateParameters

Criar ou Atualizar parâmetros.

options
CertificateCreateOrUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<CertificateCreateOrUpdateResponse>

delete(string, string, string, string, CertificateDeleteOptionalParams)

Elimina um 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 é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

certificateId

string

Identificador da entidade de certificado. Tem de ser exclusivo na instância de serviço do Gestão de API atual.

ifMatch

string

ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido 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 pelo respetivo 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 é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

certificateId

string

Identificador da entidade de certificado. Tem de ser exclusivo na instância de serviço do Gestão 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 pelo respetivo 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 é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

certificateId

string

Identificador da entidade de certificado. Tem de ser exclusivo na instância de serviço do Gestão de API atual.

options
CertificateGetEntityTagOptionalParams

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 é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

options
CertificateListByServiceOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<CertificateContract, CertificateContract[], PageSettings>

refreshSecret(string, string, string, CertificateRefreshSecretOptionalParams)

No KeyVault, atualize o certificado que está a ser utilizado 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 é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

certificateId

string

Identificador da entidade de certificado. Tem de ser exclusivo na instância de serviço do Gestão de API atual.

options
CertificateRefreshSecretOptionalParams

Os parâmetros de opções.

Devoluções

Promise<CertificateRefreshSecretResponse>