|
1 | 1 | {
|
2 |
| - "title": "JSON schema for Azure Functions host.json files", |
3 |
| - "$schema": "http://json-schema.org/draft-04/schema#", |
4 |
| - |
5 |
| - "type": "object", |
6 |
| - |
7 |
| - "properties": { |
8 |
| - "id": { |
9 |
| - "description": "The unique ID for this job host. Can be a lower case GUID with dashes removed", |
10 |
| - "type": "string", |
11 |
| - "minLength": 1 |
12 |
| - }, |
13 |
| - |
14 |
| - "functions": { |
15 |
| - "description": "The list of functions the host should load.", |
16 |
| - "type": "array", |
17 |
| - |
18 |
| - "items": { |
19 |
| - "type": "string", |
20 |
| - "uniqueItems": true |
21 |
| - } |
22 |
| - }, |
23 |
| - |
24 |
| - "functionTimeout": { |
25 |
| - "description": "Value indicating the timeout duration for all functions.", |
26 |
| - "oneOf": [ |
27 |
| - { |
28 |
| - "type": "string", |
29 |
| - "pattern": "^\\d\\d:\\d\\d:\\d\\d$" |
30 |
| - }, |
31 |
| - { |
32 |
| - "enum": [ null ] |
33 |
| - } |
34 |
| - ] |
35 |
| - }, |
36 |
| - |
37 |
| - "http": { |
38 |
| - "description": "Configuration settings for 'http' triggers.", |
39 |
| - "type": "object", |
40 |
| - "required": ["routePrefix"], |
41 |
| - |
42 |
| - "properties": { |
43 |
| - "routePrefix": { |
44 |
| - "description": "Defines the default route prefix that applies to all routes. Use an empty string to remove the prefix.", |
45 |
| - "type": "string", |
46 |
| - "default": "api" |
47 |
| - } |
48 |
| - } |
49 |
| - }, |
50 |
| - |
51 |
| - "watchDirectories": { |
52 |
| - "description": "Set of shared code directories that should be monitored for changes to ensure that when code in these directories is changed, it is picked up by your functions", |
53 |
| - "type": "array", |
54 |
| - |
55 |
| - "items": { |
56 |
| - "type": "string", |
57 |
| - "minLength": 1, |
58 |
| - "uniqueItems": true |
59 |
| - } |
60 |
| - }, |
61 |
| - |
62 |
| - "queues": { |
63 |
| - "description": "Configuration settings for 'queue' triggers.", |
64 |
| - "type": "object", |
65 |
| - |
66 |
| - "properties": { |
67 |
| - "maxPollingInterval": { |
68 |
| - "description": "The maximum interval in milliseconds between queue polls.", |
69 |
| - "type": "integer", |
70 |
| - "default": 1000 |
71 |
| - }, |
| 2 | + "title": "JSON schema for Azure Functions host.json files", |
| 3 | + "$schema": "http://json-schema.org/draft-04/schema#", |
| 4 | + |
| 5 | + "type": "object", |
72 | 6 |
|
73 |
| - "batchSize": { |
74 |
| - "description": "The number of queue messages to retrieve and process in parallel (per job function).", |
75 |
| - "type": "integer", |
76 |
| - "maximum": 32, |
77 |
| - "minimum": 1, |
78 |
| - "default": 16 |
| 7 | + "properties": { |
| 8 | + "id": { |
| 9 | + "description": "The unique ID for this job host. Can be a lower case GUID with dashes removed", |
| 10 | + "type": "string", |
| 11 | + "minLength": 1 |
79 | 12 | },
|
80 | 13 |
|
81 |
| - "maxDequeueCount": { |
82 |
| - "description": "The number of times to try processing a message before moving it to the poison queue", |
83 |
| - "type": "integer", |
84 |
| - "default": 5 |
| 14 | + "functions": { |
| 15 | + "description": "The list of functions the host should load.", |
| 16 | + "type": "array", |
| 17 | + |
| 18 | + "items": { |
| 19 | + "type": "string", |
| 20 | + "uniqueItems": true |
| 21 | + } |
85 | 22 | },
|
86 | 23 |
|
87 |
| - "newBatchThreshold": { |
88 |
| - "description": "The threshold at which a new batch of messages will be fetched. The default is batchSize/2.", |
89 |
| - "type": "integer" |
90 |
| - } |
91 |
| - } |
92 |
| - }, |
93 |
| - |
94 |
| - "serviceBus": { |
95 |
| - "description": "Configuration settings for 'serviceBus' triggers.", |
96 |
| - "type": "object", |
97 |
| - |
98 |
| - "properties": { |
99 |
| - "maxConcurrentCalls": { |
100 |
| - "description": "The maximum number of concurrent calls to the callback the message pump should initiate.", |
101 |
| - "type": "integer", |
102 |
| - "default": 16 |
| 24 | + "functionTimeout": { |
| 25 | + "description": "Value indicating the timeout duration for all functions.", |
| 26 | + "oneOf": [ |
| 27 | + { |
| 28 | + "type": "string", |
| 29 | + "pattern": "^\\d\\d:\\d\\d:\\d\\d$" |
| 30 | + }, |
| 31 | + { |
| 32 | + "enum": [ null ] |
| 33 | + } |
| 34 | + ] |
103 | 35 | },
|
104 | 36 |
|
105 |
| - "prefetchCount": { |
106 |
| - "description": "The default PrefetchCount that will be used by the underlying MessageReceiver.", |
107 |
| - "type": "integer" |
108 |
| - } |
109 |
| - } |
110 |
| - }, |
111 |
| - |
112 |
| - "eventHub": { |
113 |
| - "description": "Configuration settings for 'eventHub' triggers.", |
114 |
| - "type": "object", |
115 |
| - |
116 |
| - "properties": { |
117 |
| - "maxBatchSize": { |
118 |
| - "description": "The maximum event count received per receive loop.", |
119 |
| - "type": "integer", |
120 |
| - "default": 1000 |
| 37 | + "http": { |
| 38 | + "description": "Configuration settings for 'http' triggers.", |
| 39 | + "type": "object", |
| 40 | + "required": [ "routePrefix" ], |
| 41 | + |
| 42 | + "properties": { |
| 43 | + "routePrefix": { |
| 44 | + "description": "Defines the default route prefix that applies to all routes. Use an empty string to remove the prefix.", |
| 45 | + "type": "string", |
| 46 | + "default": "api" |
| 47 | + } |
| 48 | + } |
121 | 49 | },
|
122 | 50 |
|
123 |
| - "prefetchCount": { |
124 |
| - "description": "The default PrefetchCount that will be used by the underlying EventProcessorHost.", |
125 |
| - "type": "integer" |
126 |
| - } |
127 |
| - } |
128 |
| - }, |
129 |
| - |
130 |
| - "tracing": { |
131 |
| - "description": "Configuration settings for logging/tracing behavior.", |
132 |
| - "type": "object", |
133 |
| - |
134 |
| - "properties": { |
135 |
| - "consoleLevel": { |
136 |
| - "description": "The tracing level used for console logging.", |
137 |
| - "enum": [ "off", "error", "warning", "info", "verbose" ], |
138 |
| - "default": "verbose" |
| 51 | + "watchDirectories": { |
| 52 | + "description": "Set of shared code directories that should be monitored for changes to ensure that when code in these directories is changed, it is picked up by your functions", |
| 53 | + "type": "array", |
| 54 | + |
| 55 | + "items": { |
| 56 | + "type": "string", |
| 57 | + "minLength": 1, |
| 58 | + "uniqueItems": true |
| 59 | + } |
139 | 60 | },
|
140 | 61 |
|
141 |
| - "fileLoggingMode": { |
142 |
| - "description": "Value determining what level of file logging is enabled.", |
143 |
| - "enum": [ "never", "always", "debugOnly" ], |
144 |
| - "default": "debugOnly" |
145 |
| - } |
146 |
| - } |
147 |
| - }, |
148 |
| - |
149 |
| - "singleton": { |
150 |
| - "description": "Configuration settings for Singleton lock behavior.", |
151 |
| - "type": "object", |
152 |
| - |
153 |
| - "properties": { |
154 |
| - "lockPeriod": { |
155 |
| - "description": "The period that function level locks are taken for (they will auto renew).", |
156 |
| - "pattern": "^\\d\\d:\\d\\d:\\d\\d$", |
157 |
| - "default": "00:00:15" |
| 62 | + "queues": { |
| 63 | + "description": "Configuration settings for 'queue' triggers.", |
| 64 | + "type": "object", |
| 65 | + |
| 66 | + "properties": { |
| 67 | + "maxPollingInterval": { |
| 68 | + "description": "The maximum interval in milliseconds between queue polls.", |
| 69 | + "type": "integer", |
| 70 | + "default": 1000 |
| 71 | + }, |
| 72 | + |
| 73 | + "batchSize": { |
| 74 | + "description": "The number of queue messages to retrieve and process in parallel (per job function).", |
| 75 | + "type": "integer", |
| 76 | + "maximum": 32, |
| 77 | + "minimum": 1, |
| 78 | + "default": 16 |
| 79 | + }, |
| 80 | + |
| 81 | + "maxDequeueCount": { |
| 82 | + "description": "The number of times to try processing a message before moving it to the poison queue", |
| 83 | + "type": "integer", |
| 84 | + "default": 5 |
| 85 | + }, |
| 86 | + |
| 87 | + "newBatchThreshold": { |
| 88 | + "description": "The threshold at which a new batch of messages will be fetched. The default is batchSize/2.", |
| 89 | + "type": "integer" |
| 90 | + }, |
| 91 | + |
| 92 | + "visibilityTimeout": { |
| 93 | + "description": "The visibility timeout that will be applied to messages that fail processing.", |
| 94 | + "pattern": "^\\d\\d:\\d\\d:\\d\\d$", |
| 95 | + "default": "00:00:00" |
| 96 | + } |
| 97 | + } |
158 | 98 | },
|
159 | 99 |
|
160 |
| - "listenerLockPeriod": { |
161 |
| - "description": "The period that listener locks are taken for.", |
162 |
| - "pattern": "^\\d\\d:\\d\\d:\\d\\d$", |
163 |
| - "default": "00:01:00" |
| 100 | + "serviceBus": { |
| 101 | + "description": "Configuration settings for 'serviceBus' triggers.", |
| 102 | + "type": "object", |
| 103 | + |
| 104 | + "properties": { |
| 105 | + "maxConcurrentCalls": { |
| 106 | + "description": "The maximum number of concurrent calls to the callback the message pump should initiate.", |
| 107 | + "type": "integer", |
| 108 | + "default": 16 |
| 109 | + }, |
| 110 | + |
| 111 | + "prefetchCount": { |
| 112 | + "description": "The default PrefetchCount that will be used by the underlying MessageReceiver.", |
| 113 | + "type": "integer" |
| 114 | + } |
| 115 | + } |
164 | 116 | },
|
165 | 117 |
|
166 |
| - "listenerLockRecoveryPollingInterval": { |
167 |
| - "description": "The time interval used for listener lock recovery if a listener lock couldn't be acquired on startup.", |
168 |
| - "pattern": "^\\d\\d:\\d\\d:\\d\\d$", |
169 |
| - "default": "00:01:00" |
| 118 | + "eventHub": { |
| 119 | + "description": "Configuration settings for 'eventHub' triggers.", |
| 120 | + "type": "object", |
| 121 | + |
| 122 | + "properties": { |
| 123 | + "maxBatchSize": { |
| 124 | + "description": "The maximum event count received per receive loop.", |
| 125 | + "type": "integer", |
| 126 | + "default": 1000 |
| 127 | + }, |
| 128 | + |
| 129 | + "prefetchCount": { |
| 130 | + "description": "The default PrefetchCount that will be used by the underlying EventProcessorHost.", |
| 131 | + "type": "integer" |
| 132 | + } |
| 133 | + } |
170 | 134 | },
|
171 | 135 |
|
172 |
| - "lockAcquisitionTimeout": { |
173 |
| - "description": "The maximum amount of time the runtime will try to acquire a lock.", |
174 |
| - "pattern": "^\\d\\d:\\d\\d:\\d\\d$", |
175 |
| - "default": "00:01:00" |
| 136 | + "tracing": { |
| 137 | + "description": "Configuration settings for logging/tracing behavior.", |
| 138 | + "type": "object", |
| 139 | + |
| 140 | + "properties": { |
| 141 | + "consoleLevel": { |
| 142 | + "description": "The tracing level used for console logging.", |
| 143 | + "enum": [ "off", "error", "warning", "info", "verbose" ], |
| 144 | + "default": "verbose" |
| 145 | + }, |
| 146 | + |
| 147 | + "fileLoggingMode": { |
| 148 | + "description": "Value determining what level of file logging is enabled.", |
| 149 | + "enum": [ "never", "always", "debugOnly" ], |
| 150 | + "default": "debugOnly" |
| 151 | + } |
| 152 | + } |
176 | 153 | },
|
177 | 154 |
|
178 |
| - "lockAcquisitionPollingInterval": { |
179 |
| - "description": "The interval between lock acquisition attempts.", |
180 |
| - "pattern": "^\\d\\d:\\d\\d:\\d\\d$" |
| 155 | + "singleton": { |
| 156 | + "description": "Configuration settings for Singleton lock behavior.", |
| 157 | + "type": "object", |
| 158 | + |
| 159 | + "properties": { |
| 160 | + "lockPeriod": { |
| 161 | + "description": "The period that function level locks are taken for (they will auto renew).", |
| 162 | + "pattern": "^\\d\\d:\\d\\d:\\d\\d$", |
| 163 | + "default": "00:00:15" |
| 164 | + }, |
| 165 | + |
| 166 | + "listenerLockPeriod": { |
| 167 | + "description": "The period that listener locks are taken for.", |
| 168 | + "pattern": "^\\d\\d:\\d\\d:\\d\\d$", |
| 169 | + "default": "00:01:00" |
| 170 | + }, |
| 171 | + |
| 172 | + "listenerLockRecoveryPollingInterval": { |
| 173 | + "description": "The time interval used for listener lock recovery if a listener lock couldn't be acquired on startup.", |
| 174 | + "pattern": "^\\d\\d:\\d\\d:\\d\\d$", |
| 175 | + "default": "00:01:00" |
| 176 | + }, |
| 177 | + |
| 178 | + "lockAcquisitionTimeout": { |
| 179 | + "description": "The maximum amount of time the runtime will try to acquire a lock.", |
| 180 | + "pattern": "^\\d\\d:\\d\\d:\\d\\d$", |
| 181 | + "default": "00:01:00" |
| 182 | + }, |
| 183 | + |
| 184 | + "lockAcquisitionPollingInterval": { |
| 185 | + "description": "The interval between lock acquisition attempts.", |
| 186 | + "pattern": "^\\d\\d:\\d\\d:\\d\\d$" |
| 187 | + } |
| 188 | + } |
181 | 189 | }
|
182 |
| - } |
183 | 190 | }
|
184 |
| - } |
185 | 191 | }
|
0 commit comments