Documentation interface

Пакет:

@azure/arm-apimanagement

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

Методы

createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)	Создает новую документацию или обновляет существующую.
delete(string, string, string, string, DocumentationDeleteOptionalParams)	Удаляет указанную документацию из API.
get(string, string, string, DocumentationGetOptionalParams)	Возвращает сведения о документации, указанной ее идентификатором.
getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)	Возвращает версию состояния сущности (Etag) документации по ее идентификатору.
listByService(string, string, DocumentationListByServiceOptionalParams)	Список всех документаций по экземпляру службы Управление API.
update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)	Обновления сведения в документации по API, указанной по его идентификатору.

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

createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)

Создает новую документацию или обновляет существующую.

function createOrUpdate(resourceGroupName: string, serviceName: string, documentationId: string, parameters: DocumentationContract, options?: DocumentationCreateOrUpdateOptionalParams): Promise<DocumentationCreateOrUpdateResponse>

Параметры

resourceGroupName

string

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

serviceName

string

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

documentationId

string

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

parameters

DocumentationContract

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

options

DocumentationCreateOrUpdateOptionalParams

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

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

Promise<DocumentationCreateOrUpdateResponse>

delete(string, string, string, string, DocumentationDeleteOptionalParams)

Удаляет указанную документацию из API.

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

Параметры

resourceGroupName

string

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

serviceName

string

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

documentationId

string

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

ifMatch

string

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

options

DocumentationDeleteOptionalParams

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

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

Promise<void>

get(string, string, string, DocumentationGetOptionalParams)

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

function get(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetOptionalParams): Promise<DocumentationGetResponse>

Параметры

resourceGroupName

string

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

serviceName

string

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

documentationId

string

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

options

DocumentationGetOptionalParams

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

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

Promise<DocumentationGetResponse>

getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetEntityTagOptionalParams): Promise<DocumentationGetEntityTagHeaders>

Параметры

resourceGroupName

string

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

serviceName

string

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

documentationId

string

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

options

DocumentationGetEntityTagOptionalParams

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

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

Promise<DocumentationGetEntityTagHeaders>

listByService(string, string, DocumentationListByServiceOptionalParams)

Список всех документаций по экземпляру службы Управление API.

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

Параметры

resourceGroupName

string

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

serviceName

string

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

options

DocumentationListByServiceOptionalParams

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

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

PagedAsyncIterableIterator<DocumentationContract, DocumentationContract[], PageSettings>

update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)

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

function update(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, parameters: DocumentationUpdateContract, options?: DocumentationUpdateOptionalParams): Promise<DocumentationUpdateResponse>

Параметры

resourceGroupName

string

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

serviceName

string

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

documentationId

string

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

ifMatch

string

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

parameters

DocumentationUpdateContract

Документация. Обновление параметров.

options

DocumentationUpdateOptionalParams

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

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

Promise<DocumentationUpdateResponse>