Certificate interface

Pakiet:

@azure/arm-apimanagement

Interfejs reprezentujący certyfikat.

Metody

createOrUpdate(string, string, string, CertificateCreateOrUpdateParameters, CertificateCreateOrUpdateOptionalParams)	Tworzy lub aktualizuje certyfikat używany do uwierzytelniania za pomocą zaplecza.
delete(string, string, string, string, CertificateDeleteOptionalParams)	Usuwa określony certyfikat.
get(string, string, string, CertificateGetOptionalParams)	Pobiera szczegóły certyfikatu określonego przez jego identyfikator.
getEntityTag(string, string, string, CertificateGetEntityTagOptionalParams)	Pobiera wersję stanu jednostki (Etag) certyfikatu określonego przez jego identyfikator.
listByService(string, string, CertificateListByServiceOptionalParams)	Wyświetla kolekcję wszystkich certyfikatów w określonym wystąpieniu usługi.
refreshSecret(string, string, string, CertificateRefreshSecretOptionalParams)	W usłudze KeyVault odśwież certyfikat używany do uwierzytelniania za pomocą zaplecza.

Szczegóły metody

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

Tworzy lub aktualizuje certyfikat używany do uwierzytelniania za pomocą zaplecza.

function createOrUpdate(resourceGroupName: string, serviceName: string, certificateId: string, parameters: CertificateCreateOrUpdateParameters, options?: CertificateCreateOrUpdateOptionalParams): Promise<CertificateCreateOrUpdateResponse>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

certificateId

string

Identyfikator jednostki certyfikatu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

parameters

CertificateCreateOrUpdateParameters

Tworzenie lub aktualizowanie parametrów.

options

CertificateCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<CertificateCreateOrUpdateResponse>

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

Usuwa określony certyfikat.

function delete(resourceGroupName: string, serviceName: string, certificateId: string, ifMatch: string, options?: CertificateDeleteOptionalParams): Promise<void>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

certificateId

string

Identyfikator jednostki certyfikatu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

ifMatch

string

ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * w przypadku aktualizacji bezwarunkowej.

options

CertificateDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

get(string, string, string, CertificateGetOptionalParams)

Pobiera szczegóły certyfikatu określonego przez jego identyfikator.

function get(resourceGroupName: string, serviceName: string, certificateId: string, options?: CertificateGetOptionalParams): Promise<CertificateGetResponse>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

certificateId

string

Identyfikator jednostki certyfikatu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

CertificateGetOptionalParams

Parametry opcji.

Zwraca

Promise<CertificateGetResponse>

getEntityTag(string, string, string, CertificateGetEntityTagOptionalParams)

Pobiera wersję stanu jednostki (Etag) certyfikatu określonego przez jego identyfikator.

function getEntityTag(resourceGroupName: string, serviceName: string, certificateId: string, options?: CertificateGetEntityTagOptionalParams): Promise<CertificateGetEntityTagHeaders>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

certificateId

string

Identyfikator jednostki certyfikatu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

CertificateGetEntityTagOptionalParams

Parametry opcji.

Zwraca

Promise<CertificateGetEntityTagHeaders>

listByService(string, string, CertificateListByServiceOptionalParams)

Wyświetla kolekcję wszystkich certyfikatów w określonym wystąpieniu usługi.

function listByService(resourceGroupName: string, serviceName: string, options?: CertificateListByServiceOptionalParams): PagedAsyncIterableIterator<CertificateContract, CertificateContract[], PageSettings>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

options

CertificateListByServiceOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<CertificateContract, CertificateContract[], PageSettings>

refreshSecret(string, string, string, CertificateRefreshSecretOptionalParams)

W usłudze KeyVault odśwież certyfikat używany do uwierzytelniania za pomocą zaplecza.

function refreshSecret(resourceGroupName: string, serviceName: string, certificateId: string, options?: CertificateRefreshSecretOptionalParams): Promise<CertificateRefreshSecretResponse>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

certificateId

string

Identyfikator jednostki certyfikatu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

CertificateRefreshSecretOptionalParams

Parametry opcji.

Zwraca

Promise<CertificateRefreshSecretResponse>