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


ApiOperation interface

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

Методы

createOrUpdate(string, string, string, string, OperationContract, ApiOperationCreateOrUpdateOptionalParams)

Создает новую операцию в API или обновляет существующую.

delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)

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

get(string, string, string, string, ApiOperationGetOptionalParams)

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

getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)

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

listByApi(string, string, string, ApiOperationListByApiOptionalParams)

Возвращает коллекцию операций для указанного API.

update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)

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

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

createOrUpdate(string, string, string, string, OperationContract, ApiOperationCreateOrUpdateOptionalParams)

Создает новую операцию в API или обновляет существующую.

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, parameters: OperationContract, options?: ApiOperationCreateOrUpdateOptionalParams): Promise<ApiOperationCreateOrUpdateResponse>

Параметры

resourceGroupName

string

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

serviceName

string

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

apiId

string

Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. Внешняя редакция имеет суффикс ;rev=n, где n — номер редакции.

operationId

string

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

parameters
OperationContract

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

options
ApiOperationCreateOrUpdateOptionalParams

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

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

delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)

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

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

Параметры

resourceGroupName

string

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

serviceName

string

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

apiId

string

Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. Внешняя редакция имеет суффикс ;rev=n, где n — номер редакции.

operationId

string

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

ifMatch

string

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

options
ApiOperationDeleteOptionalParams

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

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

Promise<void>

get(string, string, string, string, ApiOperationGetOptionalParams)

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

function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetOptionalParams): Promise<ApiOperationGetResponse>

Параметры

resourceGroupName

string

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

serviceName

string

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

apiId

string

Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. Внешняя редакция имеет суффикс ;rev=n, где n — номер редакции.

operationId

string

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

options
ApiOperationGetOptionalParams

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

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

getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetEntityTagOptionalParams): Promise<ApiOperationGetEntityTagHeaders>

Параметры

resourceGroupName

string

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

serviceName

string

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

apiId

string

Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. Внешняя редакция имеет суффикс ;rev=n, где n — номер редакции.

operationId

string

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

options
ApiOperationGetEntityTagOptionalParams

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

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

listByApi(string, string, string, ApiOperationListByApiOptionalParams)

Возвращает коллекцию операций для указанного API.

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiOperationListByApiOptionalParams): PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>

Параметры

resourceGroupName

string

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

serviceName

string

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

apiId

string

Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. Внешняя редакция имеет суффикс ;rev=n, где n — номер редакции.

options
ApiOperationListByApiOptionalParams

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

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

update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)

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

function update(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, ifMatch: string, parameters: OperationUpdateContract, options?: ApiOperationUpdateOptionalParams): Promise<ApiOperationUpdateResponse>

Параметры

resourceGroupName

string

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

serviceName

string

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

apiId

string

Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. Внешняя редакция имеет суффикс ;rev=n, где n — номер редакции.

operationId

string

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

ifMatch

string

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

parameters
OperationUpdateContract

Параметры обновления операции API.

options
ApiOperationUpdateOptionalParams

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

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