ParameterContract interface

Balíček:

@azure/arm-apimanagement

Podrobnosti parametrů operace.

Vlastnosti

defaultValue	Výchozí hodnota parametru
description	Popis parametru
examples	Příklad definovaný pro parametr.
name	Název parametru
required	Určuje, jestli je parametr povinný nebo ne.
schemaId	Identifikátor schématu.
type	Typ parametru.
typeName	Název typu definovaný schématem
values	Hodnoty parametrů.

Podrobnosti vlastnosti

defaultValue

Výchozí hodnota parametru

defaultValue?: string

Hodnota vlastnosti

string

description

Popis parametru

description?: string

Hodnota vlastnosti

string

examples

Příklad definovaný pro parametr.

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

Hodnota vlastnosti

{[propertyName: string]: ParameterExampleContract}

name

Název parametru

name: string

Hodnota vlastnosti

string

required

Určuje, jestli je parametr povinný nebo ne.

required?: boolean

Hodnota vlastnosti

boolean

schemaId

Identifikátor schématu.

schemaId?: string

Hodnota vlastnosti

string

type

Typ parametru.

type: string

Hodnota vlastnosti

string

typeName

Název typu definovaný schématem

typeName?: string

Hodnota vlastnosti

string

values

Hodnoty parametrů.

values?: string[]

Hodnota vlastnosti

string[]