ParameterContract interface

Pacote:

@azure/arm-apimanagement

Detalhes dos parâmetros de operação.

Propriedades

defaultValue	Valor de parâmetro padrão.
description	Descrição do parâmetro.
examples	Exemplo definido para o parâmetro.
name	Nome do parâmetro.
required	Especifica se o parâmetro é necessário ou não.
schemaId	Identificador de esquema.
type	Tipo de parâmetro.
typeName	Nome do tipo definido pelo esquema.
values	Valores de parâmetro.

Detalhes da propriedade

defaultValue

Valor de parâmetro padrão.

defaultValue?: string

Valor da propriedade

string

description

Descrição do parâmetro.

description?: string

Valor da propriedade

string

examples

Exemplo definido para o parâmetro.

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

Valor da propriedade

{[propertyName: string]: ParameterExampleContract}

name

Nome do parâmetro.

name: string

Valor da propriedade

string

required

Especifica se o parâmetro é necessário ou não.

required?: boolean

Valor da propriedade

boolean

schemaId

Identificador de esquema.

schemaId?: string

Valor da propriedade

string

type

Tipo de parâmetro.

type: string

Valor da propriedade

string

typeName

Nome do tipo definido pelo esquema.

typeName?: string

Valor da propriedade

string

values

Valores de parâmetro.

values?: string[]

Valor da propriedade

string[]