ParameterContract interface

Package:

@azure/arm-apimanagement

Operation parameters details.

Properties

defaultValue	Default parameter value.
description	Parameter description.
examples	Exampled defined for the parameter.
name	Parameter name.
required	Specifies whether parameter is required or not.
schemaId	Schema identifier.
type	Parameter type.
typeName	Type name defined by the schema.
values	Parameter values.

Property Details

defaultValue

Default parameter value.

defaultValue?: string

Property Value

string

description

Parameter description.

description?: string

Property Value

string

examples

Exampled defined for the parameter.

examples?: {[propertyName: string]: ParameterExampleContract}

Property Value

{[propertyName: string]: ParameterExampleContract}

name

Parameter name.

name: string

Property Value

string

required

Specifies whether parameter is required or not.

required?: boolean

Property Value

boolean

schemaId

Schema identifier.

schemaId?: string

Property Value

string

type

Parameter type.

type: string

Property Value

string

typeName

Type name defined by the schema.

typeName?: string

Property Value

string

values

Parameter values.

values?: string[]

Property Value

string[]