Поделиться через

ApiWiki interface

  • Ссылка
Пакет:
@azure/arm-apimanagement

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

Методы

createOrUpdate(string, string, string, WikiContract, ApiWikiCreateOrUpdateOptionalParams)

Создает новый вики-сайт для API или обновляет существующий.
delete(string, string, string, string, ApiWikiDeleteOptionalParams)

Удаляет указанный вики-сайт из API.
get(string, string, string, ApiWikiGetOptionalParams)

Возвращает сведения о вики-сайте для API, указанного его идентификатором.
getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)

Возвращает версию состояния сущности (Etag) вики-сайта для API, указанного по его идентификатору.
update(string, string, string, string, WikiUpdateContract, ApiWikiUpdateOptionalParams)

Обновления сведения о вики-сайте для API, указанного по его идентификатору.

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

createOrUpdate(string, string, string, WikiContract, ApiWikiCreateOrUpdateOptionalParams)

Создает новый вики-сайт для API или обновляет существующий.

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, parameters: WikiContract, options?: ApiWikiCreateOrUpdateOptionalParams): Promise<ApiWikiCreateOrUpdateResponse>

Параметры

resourceGroupName

string

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

serviceName

string

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

apiId

string

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

parameters
WikiContract

Создайте параметры.

options
ApiWikiCreateOrUpdateOptionalParams

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

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

Promise<ApiWikiCreateOrUpdateResponse>

delete(string, string, string, string, ApiWikiDeleteOptionalParams)

Удаляет указанный вики-сайт из API.

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

Параметры

resourceGroupName

string

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

serviceName

string

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

apiId

string

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

ifMatch

string

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

options
ApiWikiDeleteOptionalParams

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

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

Promise<void>

get(string, string, string, ApiWikiGetOptionalParams)

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

function get(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiWikiGetOptionalParams): Promise<ApiWikiGetResponse>

Параметры

resourceGroupName

string

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

serviceName

string

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

apiId

string

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

options
ApiWikiGetOptionalParams

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

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

Promise<ApiWikiGetResponse>

getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiWikiGetEntityTagOptionalParams): Promise<ApiWikiGetEntityTagHeaders>

Параметры

resourceGroupName

string

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

serviceName

string

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

apiId

string

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

options
ApiWikiGetEntityTagOptionalParams

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

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

Promise<ApiWikiGetEntityTagHeaders>

update(string, string, string, string, WikiUpdateContract, ApiWikiUpdateOptionalParams)

Обновления сведения о вики-сайте для API, указанного по его идентификатору.

function update(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, parameters: WikiUpdateContract, options?: ApiWikiUpdateOptionalParams): Promise<ApiWikiUpdateResponse>

Параметры

resourceGroupName

string

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

serviceName

string

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

apiId

string

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

ifMatch

string

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

parameters
WikiUpdateContract

Параметры обновления вики-сайта.

options
ApiWikiUpdateOptionalParams

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

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

Promise<ApiWikiUpdateResponse>