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


OperationContract interface

Сведения об операции API.

Extends

Свойства

description

Описание операции. Может содержать теги форматирования HTML.

displayName

Имя операции.

method

Допустимый метод операции HTTP. Типичные методы HTTP, такие как GET, PUT, POST, но не ограничиваются только ими.

policies

Политики операций

request

Сущность, содержащая сведения о запросе.

responses

Массив ответов операции.

templateParameters

Коллекция параметров шаблона URL-адреса.

urlTemplate

Шаблон относительного URL-адреса, определяющий целевой ресурс для этой операции. Может включать параметры. Пример: /customers/{cid}/orders/{oid}/?date={date}

Унаследованные свойства

id

Полный идентификатор ресурса. Например, /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ПРИМЕЧАНИЕ. Это свойство не сериализуется. Его может заполнить только сервер.

name

Имя ресурса ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его может заполнить только сервер.

type

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" ПРИМЕЧАНИЕ. Это свойство не сериализуется. Его может заполнить только сервер.

Сведения о свойстве

description

Описание операции. Может содержать теги форматирования HTML.

description?: string

Значение свойства

string

displayName

Имя операции.

displayName?: string

Значение свойства

string

method

Допустимый метод операции HTTP. Типичные методы HTTP, такие как GET, PUT, POST, но не ограничиваются только ими.

method?: string

Значение свойства

string

policies

Политики операций

policies?: string

Значение свойства

string

request

Сущность, содержащая сведения о запросе.

request?: RequestContract

Значение свойства

responses

Массив ответов операции.

responses?: ResponseContract[]

Значение свойства

templateParameters

Коллекция параметров шаблона URL-адреса.

templateParameters?: ParameterContract[]

Значение свойства

urlTemplate

Шаблон относительного URL-адреса, определяющий целевой ресурс для этой операции. Может включать параметры. Пример: /customers/{cid}/orders/{oid}/?date={date}

urlTemplate?: string

Значение свойства

string

Сведения об унаследованном свойстве

id

Полный идентификатор ресурса. Например, /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ПРИМЕЧАНИЕ. Это свойство не сериализуется. Его может заполнить только сервер.

id?: string

Значение свойства

string

Наследуется отProxyResource.id

name

Имя ресурса ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его может заполнить только сервер.

name?: string

Значение свойства

string

Наследуется отProxyResource.name

type

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" ПРИМЕЧАНИЕ. Это свойство не сериализуется. Его может заполнить только сервер.

type?: string

Значение свойства

string

Наследуется отProxyResource.type