InputDescriptor interface

Package:

azure-devops-extension-api

Describes an input for subscriptions.

Properties

dependencyInputIds	The ids of all inputs that the value of this input is dependent on.
description	Description of what this input is used for
groupName	The group localized name to which this input belongs and can be shown as a header for the container that will include all the inputs in the group.
hasDynamicValueInformation	If true, the value information for this input is dynamic and should be fetched when the value of dependency inputs change.
id	Identifier for the subscription input
inputMode	Mode in which the value of this input should be entered
isConfidential	Gets whether this input is confidential, such as for a password or application key
name	Localized name which can be shown as a label for the subscription input
properties	Custom properties for the input which can be used by the service provider
type	Underlying data type for the input value. When this value is specified, InputMode, Validation and Values are optional.
useInDefaultDescription	Gets whether this input is included in the default generated action description.
validation	Information to use to validate this input's value
valueHint	A hint for input value. It can be used in the UI as the input placeholder.
values	Information about possible values for this input

Property Details

dependencyInputIds

The ids of all inputs that the value of this input is dependent on.

dependencyInputIds: string[]

Property Value

string[]

description

Description of what this input is used for

description: string

Property Value

string

groupName

The group localized name to which this input belongs and can be shown as a header for the container that will include all the inputs in the group.

groupName: string

Property Value

string

hasDynamicValueInformation

If true, the value information for this input is dynamic and should be fetched when the value of dependency inputs change.

hasDynamicValueInformation: boolean

Property Value

boolean

id

Identifier for the subscription input

id: string

Property Value

string

inputMode

Mode in which the value of this input should be entered

inputMode: InputMode

Property Value

InputMode

isConfidential

Gets whether this input is confidential, such as for a password or application key

isConfidential: boolean

Property Value

boolean

name

Localized name which can be shown as a label for the subscription input

name: string

Property Value

string

properties

Custom properties for the input which can be used by the service provider

properties: {[key: string]: any}

Property Value

{[key: string]: any}

type

Underlying data type for the input value. When this value is specified, InputMode, Validation and Values are optional.

type: string

Property Value

string

useInDefaultDescription

Gets whether this input is included in the default generated action description.

useInDefaultDescription: boolean

Property Value

boolean

validation

Information to use to validate this input's value

validation: InputValidation

Property Value

InputValidation

valueHint

A hint for input value. It can be used in the UI as the input placeholder.

valueHint: string

Property Value

string

values

Information about possible values for this input

values: InputValues

Property Value

InputValues