OperationContract interface

Package:

@azure/arm-apimanagement

API Operation details.

Extends

ProxyResource

Properties

description	Description of the operation. May include HTML formatting tags.
displayName	Operation Name.
method	A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
policies	Operation Policies
request	An entity containing request details.
responses	Array of Operation responses.
templateParameters	Collection of URL template parameters.
urlTemplate	Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

description

Description of the operation. May include HTML formatting tags.

description?: string

Property Value

string

displayName

Operation Name.

displayName?: string

Property Value

string

method

A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.

method?: string

Property Value

string

policies

Operation Policies

policies?: string

Property Value

string

request

An entity containing request details.

request?: RequestContract

Property Value

RequestContract

responses

Array of Operation responses.

responses?: ResponseContract[]

Property Value

ResponseContract[]

templateParameters

Collection of URL template parameters.

templateParameters?: ParameterContract[]

Property Value

ParameterContract[]

urlTemplate

Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}

urlTemplate?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type