/
InputDescriptor.yml
188 lines (188 loc) · 5.86 KB
/
InputDescriptor.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
### YamlMime:TSType
name: InputDescriptor
uid: azure-devops-extension-api.InputDescriptor
package: azure-devops-extension-api
summary: Describes an input for subscriptions.
fullName: InputDescriptor
remarks: ''
isDeprecated: false
type: interface
properties:
- name: dependencyInputIds
uid: azure-devops-extension-api.InputDescriptor.dependencyInputIds
package: azure-devops-extension-api
summary: The ids of all inputs that the value of this input is dependent on.
fullName: dependencyInputIds
remarks: ''
isDeprecated: false
syntax:
content: 'dependencyInputIds: string[]'
return:
description: ''
type: string[]
- name: description
uid: azure-devops-extension-api.InputDescriptor.description
package: azure-devops-extension-api
summary: Description of what this input is used for
fullName: description
remarks: ''
isDeprecated: false
syntax:
content: 'description: string'
return:
description: ''
type: string
- name: groupName
uid: azure-devops-extension-api.InputDescriptor.groupName
package: azure-devops-extension-api
summary: >-
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.
fullName: groupName
remarks: ''
isDeprecated: false
syntax:
content: 'groupName: string'
return:
description: ''
type: string
- name: hasDynamicValueInformation
uid: azure-devops-extension-api.InputDescriptor.hasDynamicValueInformation
package: azure-devops-extension-api
summary: >-
If true, the value information for this input is dynamic and should be
fetched when the value of dependency inputs change.
fullName: hasDynamicValueInformation
remarks: ''
isDeprecated: false
syntax:
content: 'hasDynamicValueInformation: boolean'
return:
description: ''
type: boolean
- name: id
uid: azure-devops-extension-api.InputDescriptor.id
package: azure-devops-extension-api
summary: Identifier for the subscription input
fullName: id
remarks: ''
isDeprecated: false
syntax:
content: 'id: string'
return:
description: ''
type: string
- name: inputMode
uid: azure-devops-extension-api.InputDescriptor.inputMode
package: azure-devops-extension-api
summary: Mode in which the value of this input should be entered
fullName: inputMode
remarks: ''
isDeprecated: false
syntax:
content: 'inputMode: InputMode'
return:
description: ''
type: <xref uid="azure-devops-extension-api.InputMode" />
- name: isConfidential
uid: azure-devops-extension-api.InputDescriptor.isConfidential
package: azure-devops-extension-api
summary: >-
Gets whether this input is confidential, such as for a password or
application key
fullName: isConfidential
remarks: ''
isDeprecated: false
syntax:
content: 'isConfidential: boolean'
return:
description: ''
type: boolean
- name: name
uid: azure-devops-extension-api.InputDescriptor.name
package: azure-devops-extension-api
summary: Localized name which can be shown as a label for the subscription input
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name: string'
return:
description: ''
type: string
- name: properties
uid: azure-devops-extension-api.InputDescriptor.properties
package: azure-devops-extension-api
summary: Custom properties for the input which can be used by the service provider
fullName: properties
remarks: ''
isDeprecated: false
syntax:
content: 'properties: {[key: string]: any}'
return:
description: ''
type: '{[key: string]: any}'
- name: type
uid: azure-devops-extension-api.InputDescriptor.type
package: azure-devops-extension-api
summary: >-
Underlying data type for the input value. When this value is specified,
InputMode, Validation and Values are optional.
fullName: type
remarks: ''
isDeprecated: false
syntax:
content: 'type: string'
return:
description: ''
type: string
- name: useInDefaultDescription
uid: azure-devops-extension-api.InputDescriptor.useInDefaultDescription
package: azure-devops-extension-api
summary: >-
Gets whether this input is included in the default generated action
description.
fullName: useInDefaultDescription
remarks: ''
isDeprecated: false
syntax:
content: 'useInDefaultDescription: boolean'
return:
description: ''
type: boolean
- name: validation
uid: azure-devops-extension-api.InputDescriptor.validation
package: azure-devops-extension-api
summary: Information to use to validate this input's value
fullName: validation
remarks: ''
isDeprecated: false
syntax:
content: 'validation: InputValidation'
return:
description: ''
type: <xref uid="azure-devops-extension-api.InputValidation" />
- name: valueHint
uid: azure-devops-extension-api.InputDescriptor.valueHint
package: azure-devops-extension-api
summary: A hint for input value. It can be used in the UI as the input placeholder.
fullName: valueHint
remarks: ''
isDeprecated: false
syntax:
content: 'valueHint: string'
return:
description: ''
type: string
- name: values
uid: azure-devops-extension-api.InputDescriptor.values
package: azure-devops-extension-api
summary: Information about possible values for this input
fullName: values
remarks: ''
isDeprecated: false
syntax:
content: 'values: InputValues'
return:
description: ''
type: <xref uid="azure-devops-extension-api.InputValues" />