Certificate interface

Пакет:

@azure/arm-apimanagement

Интерфейс, представляющий сертификат.

Методы

createOrUpdate(string, string, string, CertificateCreateOrUpdateParameters, CertificateCreateOrUpdateOptionalParams)	Создает или обновляет сертификат, используемый для проверки подлинности в серверном компоненте.
delete(string, string, string, string, CertificateDeleteOptionalParams)	Удаляет конкретный сертификат.
get(string, string, string, CertificateGetOptionalParams)	Возвращает сведения о сертификате, заданном его идентификатором.
getEntityTag(string, string, string, CertificateGetEntityTagOptionalParams)	Возвращает версию состояния сущности (Etag) сертификата, указанного его идентификатором.
listByService(string, string, CertificateListByServiceOptionalParams)	Возвращает коллекцию всех сертификатов в указанном экземпляре службы.
refreshSecret(string, string, string, CertificateRefreshSecretOptionalParams)	В KeyVault обновите сертификат, используемый для проверки подлинности с серверной частью.

Сведения о методе

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

Создает или обновляет сертификат, используемый для проверки подлинности в серверном компоненте.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

certificateId

string

Идентификатор сущности сертификата. Должен быть уникальным в текущем экземпляре службы Управление API.

parameters

CertificateCreateOrUpdateParameters

Создание или обновление параметров.

options

CertificateCreateOrUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<CertificateCreateOrUpdateResponse>

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

Удаляет конкретный сертификат.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

certificateId

string

Идентификатор сущности сертификата. Должен быть уникальным в текущем экземпляре службы Управление API.

ifMatch

string

ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.

options

CertificateDeleteOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<void>

get(string, string, string, CertificateGetOptionalParams)

Возвращает сведения о сертификате, заданном его идентификатором.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

certificateId

string

Идентификатор сущности сертификата. Должен быть уникальным в текущем экземпляре службы Управление API.

options

CertificateGetOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<CertificateGetResponse>

getEntityTag(string, string, string, CertificateGetEntityTagOptionalParams)

Возвращает версию состояния сущности (Etag) сертификата, указанного его идентификатором.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

certificateId

string

Идентификатор сущности сертификата. Должен быть уникальным в текущем экземпляре службы Управление API.

options

CertificateGetEntityTagOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<CertificateGetEntityTagHeaders>

listByService(string, string, CertificateListByServiceOptionalParams)

Возвращает коллекцию всех сертификатов в указанном экземпляре службы.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

options

CertificateListByServiceOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<CertificateContract, CertificateContract[], PageSettings>

refreshSecret(string, string, string, CertificateRefreshSecretOptionalParams)

В KeyVault обновите сертификат, используемый для проверки подлинности с серверной частью.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

certificateId

string

Идентификатор сущности сертификата. Должен быть уникальным в текущем экземпляре службы Управление API.

options

CertificateRefreshSecretOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<CertificateRefreshSecretResponse>