Share via

ApiOperationPropertiesDefinition interface

Package:
@azure/arm-logic

The api operations properties

Properties

annotation

The annotation of api operation.
api

The api reference.
description

The description of the api operation.
inputsDefinition

The operation inputs definition schema.
isNotification

Indicates whether the API operation is notification or not.
isWebhook

Indicates whether the API operation is webhook or not.
pageable

Indicates whether the api operation is pageable.
responsesDefinition

The operation responses definition schemas.
summary

The summary of the api operation.
trigger

The trigger type of api operation.
triggerHint

The trigger hint for the api operation.
visibility

The visibility of the api operation.

Property Details

annotation

The annotation of api operation.

annotation?: ApiOperationAnnotation

Property Value

ApiOperationAnnotation

api

The api reference.

api?: ApiReference

Property Value

ApiReference

description

The description of the api operation.

description?: string

Property Value

string

inputsDefinition

The operation inputs definition schema.

inputsDefinition?: SwaggerSchema

Property Value

SwaggerSchema

isNotification

Indicates whether the API operation is notification or not.

isNotification?: boolean

Property Value

boolean

isWebhook

Indicates whether the API operation is webhook or not.

isWebhook?: boolean

Property Value

boolean

pageable

Indicates whether the api operation is pageable.

pageable?: boolean

Property Value

boolean

responsesDefinition

The operation responses definition schemas.

responsesDefinition?: {[propertyName: string]: SwaggerSchema}

Property Value

{[propertyName: string]: SwaggerSchema}

summary

The summary of the api operation.

summary?: string

Property Value

string

trigger

The trigger type of api operation.

trigger?: string

Property Value

string

triggerHint

The trigger hint for the api operation.

triggerHint?: string

Property Value

string

visibility

The visibility of the api operation.

visibility?: string

Property Value

string