-
Notifications
You must be signed in to change notification settings - Fork 465
/
connection.yml
383 lines (382 loc) · 15.4 KB
/
connection.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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
### YamlMime:AzureCLIGroup
uid: az_webapp_connection
name: az webapp connection
importantNote: >-
> [!NOTE]
> This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions.
summary: |-
Commands to manage webapp connections.
status: GA
sourceType: Core and Extension
directCommands:
- uid: az_webapp_connection_delete
name: az webapp connection delete
summary: |-
Delete a webapp connection.
status: GA
sourceType: Core
syntax: >-
az webapp connection delete [--connection]
[--id]
[--name]
[--no-wait]
[--resource-group]
[--slot]
[--yes]
examples:
- summary: |-
Delete a webapp connection interactively
syntax: az webapp connection delete
- summary: |-
Delete a webapp connection by connection name
syntax: az webapp connection delete -g WebAppRG -n MyWebApp --connection MyConnection
- summary: |-
Delete a webapp connection by connection id
syntax: az webapp connection delete --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker}
optionalParameters:
- name: --connection
summary: |-
Name of the webapp connection.
- name: --id
summary: |-
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
- name: --name -n
summary: |-
Name of the webapp. Required if '--id' is not specified.None.
- name: --no-wait
defaultValue: "False"
summary: |-
Do not wait for the long-running operation to finish.
- name: --resource-group -g
summary: |-
The resource group which contains the webapp. Required if '--id' is not specified.None.
- name: --slot
summary: |-
The name of the slot. Default to the production slot if not specified.
- name: --yes -y
defaultValue: "False"
summary: |-
Do not prompt for confirmation.
- uid: az_webapp_connection_list
name: az webapp connection list
summary: |-
List connections of a webapp.
status: GA
sourceType: Core
syntax: >-
az webapp connection list [--name]
[--resource-group]
[--slot]
[--source-id]
examples:
- summary: |-
List webapp connections interactively
syntax: az webapp connection list
- summary: |-
List webapp connections by source resource name
syntax: az webapp connection list -g WebAppRG -n MyWebApp
- summary: |-
List webapp connections by source resource id
syntax: az webapp connection list --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}
optionalParameters:
- name: --name -n
summary: |-
Name of the webapp. Required if '--source-id' is not specified.None.
- name: --resource-group -g
summary: |-
The resource group which contains the webapp. Required if '--source-id' is not specified.None.
- name: --slot
summary: |-
The name of the slot. Default to the production slot if not specified.
- name: --source-id
summary: |-
The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified.
- uid: az_webapp_connection_list-configuration
name: az webapp connection list-configuration
summary: |-
List source configurations of a webapp connection.
status: GA
sourceType: Core
syntax: >-
az webapp connection list-configuration [--connection]
[--id]
[--name]
[--resource-group]
[--slot]
examples:
- summary: |-
List a connection's source configurations interactively
syntax: az webapp connection list-configuration
- summary: |-
List a connection's source configurations by connection name
syntax: az webapp connection list-configuration -g WebAppRG -n MyWebApp --connection MyConnection
- summary: |-
List a connection's source configurations by connection id
syntax: az webapp connection list-configuration --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker}
optionalParameters:
- name: --connection
summary: |-
Name of the webapp connection.
- name: --id
summary: |-
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
- name: --name -n
summary: |-
Name of the webapp. Required if '--id' is not specified.None.
- name: --resource-group -g
summary: |-
The resource group which contains the webapp. Required if '--id' is not specified.None.
- name: --slot
summary: |-
The name of the slot. Default to the production slot if not specified.
- uid: az_webapp_connection_list-support-types
name: az webapp connection list-support-types
summary: |-
List client types and auth types supported by webapp connections.
status: GA
sourceType: Core
syntax: az webapp connection list-support-types [--target-type {app-insights, appconfig, cognitiveservices, confluent-cloud, cosmos-cassandra, cosmos-gremlin, cosmos-mongo, cosmos-sql, cosmos-table, eventhub, keyvault, mysql, mysql-flexible, postgres, postgres-flexible, redis, redis-enterprise, servicebus, signalr, sql, storage-blob, storage-file, storage-queue, storage-table, webpubsub}]
examples:
- summary: |-
List all webapp supported target resource types and auth types
syntax: az webapp connection list-support-types -o table
- summary: |-
List webapp supported auth types for a specific target resource type
syntax: az webapp connection list-support-types --target-type storage-blob -o table
optionalParameters:
- name: --target-type -t
parameterValueGroup: "app-insights, appconfig, cognitiveservices, confluent-cloud, cosmos-cassandra, cosmos-gremlin, cosmos-mongo, cosmos-sql, cosmos-table, eventhub, keyvault, mysql, mysql-flexible, postgres, postgres-flexible, redis, redis-enterprise, servicebus, signalr, sql, storage-blob, storage-file, storage-queue, storage-table, webpubsub"
summary: |-
The target resource type.
- uid: az_webapp_connection_show
name: az webapp connection show
summary: |-
Get the details of a webapp connection.
status: GA
sourceType: Core
syntax: >-
az webapp connection show [--connection]
[--id]
[--name]
[--resource-group]
[--slot]
examples:
- summary: |-
Get a connection interactively
syntax: az webapp connection show
- summary: |-
Get a connection by connection name
syntax: az webapp connection show -g WebAppRG -n MyWebApp --connection MyConnection
- summary: |-
Get a connection by connection id
syntax: az webapp connection show --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker}
optionalParameters:
- name: --connection
summary: |-
Name of the webapp connection.
- name: --id
summary: |-
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
- name: --name -n
summary: |-
Name of the webapp. Required if '--id' is not specified.None.
- name: --resource-group -g
summary: |-
The resource group which contains the webapp. Required if '--id' is not specified.None.
- name: --slot
summary: |-
The name of the slot. Default to the production slot if not specified.
- uid: az_webapp_connection_validate
name: az webapp connection validate
summary: |-
Validate a webapp connection.
status: GA
sourceType: Core
syntax: >-
az webapp connection validate [--connection]
[--id]
[--name]
[--resource-group]
[--slot]
examples:
- summary: |-
Validate a connection interactively
syntax: az webapp connection validate
- summary: |-
Validate a connection by connection name
syntax: az webapp connection validate -g WebAppRG -n MyWebApp --connection MyConnection
- summary: |-
Validate a connection by connection id
syntax: az webapp connection validate --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker}
optionalParameters:
- name: --connection
summary: |-
Name of the webapp connection.
- name: --id
summary: |-
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
- name: --name -n
summary: |-
Name of the webapp. Required if '--id' is not specified.None.
- name: --resource-group -g
summary: |-
The resource group which contains the webapp. Required if '--id' is not specified.None.
- name: --slot
summary: |-
The name of the slot. Default to the production slot if not specified.
- uid: az_webapp_connection_wait
name: az webapp connection wait
summary: |-
Place the CLI in a waiting state until a condition of the connection is met.
status: GA
sourceType: Core
syntax: >-
az webapp connection wait [--connection]
[--created]
[--custom]
[--deleted]
[--exists]
[--id]
[--interval]
[--name]
[--resource-group]
[--slot]
[--timeout]
[--updated]
examples:
- summary: |-
Wait until the connection is successfully created.
syntax: az webapp connection wait --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --created
optionalParameters:
- name: --connection
summary: |-
Name of the webapp connection.
- name: --created
defaultValue: "False"
summary: |-
Wait until created with 'provisioningState' at 'Succeeded'.
- name: --custom
summary: |-
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
- name: --deleted
defaultValue: "False"
summary: |-
Wait until deleted.
- name: --exists
defaultValue: "False"
summary: |-
Wait until the resource exists.
- name: --id
summary: |-
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
- name: --interval
defaultValue: "30"
summary: |-
Polling interval in seconds.
- name: --name -n
summary: |-
Name of the webapp. Required if '--id' is not specified.None.
- name: --resource-group -g
summary: |-
The resource group which contains the webapp. Required if '--id' is not specified.None.
- name: --slot
summary: |-
The name of the slot. Default to the production slot if not specified.
- name: --timeout
defaultValue: "3600"
summary: |-
Maximum wait in seconds.
- name: --updated
defaultValue: "False"
summary: |-
Wait until updated with provisioningState at 'Succeeded'.
commands:
- az_webapp_connection_create
- az_webapp_connection_create_app-insights
- az_webapp_connection_create_appconfig
- az_webapp_connection_create_cognitiveservices
- az_webapp_connection_create_confluent-cloud
- az_webapp_connection_create_cosmos-cassandra
- az_webapp_connection_create_cosmos-gremlin
- az_webapp_connection_create_cosmos-mongo
- az_webapp_connection_create_cosmos-sql
- az_webapp_connection_create_cosmos-table
- az_webapp_connection_create_eventhub
- az_webapp_connection_create_keyvault
- az_webapp_connection_create_mysql
- az_webapp_connection_create_mysql-flexible
- az_webapp_connection_create_mysql-flexible(serviceconnector-passwordless)
- az_webapp_connection_create_postgres
- az_webapp_connection_create_postgres(serviceconnector-passwordless)
- az_webapp_connection_create_postgres-flexible
- az_webapp_connection_create_postgres-flexible(serviceconnector-passwordless)
- az_webapp_connection_create_redis
- az_webapp_connection_create_redis-enterprise
- az_webapp_connection_create_servicebus
- az_webapp_connection_create_signalr
- az_webapp_connection_create_sql
- az_webapp_connection_create_sql(serviceconnector-passwordless)
- az_webapp_connection_create_storage-blob
- az_webapp_connection_create_storage-file
- az_webapp_connection_create_storage-queue
- az_webapp_connection_create_storage-table
- az_webapp_connection_create_webpubsub
- az_webapp_connection_delete
- az_webapp_connection_list
- az_webapp_connection_list-configuration
- az_webapp_connection_list-support-types
- az_webapp_connection_show
- az_webapp_connection_update
- az_webapp_connection_update_app-insights
- az_webapp_connection_update_appconfig
- az_webapp_connection_update_cognitiveservices
- az_webapp_connection_update_confluent-cloud
- az_webapp_connection_update_cosmos-cassandra
- az_webapp_connection_update_cosmos-gremlin
- az_webapp_connection_update_cosmos-mongo
- az_webapp_connection_update_cosmos-sql
- az_webapp_connection_update_cosmos-table
- az_webapp_connection_update_eventhub
- az_webapp_connection_update_keyvault
- az_webapp_connection_update_mysql
- az_webapp_connection_update_mysql-flexible
- az_webapp_connection_update_postgres
- az_webapp_connection_update_postgres-flexible
- az_webapp_connection_update_redis
- az_webapp_connection_update_redis-enterprise
- az_webapp_connection_update_servicebus
- az_webapp_connection_update_signalr
- az_webapp_connection_update_sql
- az_webapp_connection_update_storage-blob
- az_webapp_connection_update_storage-file
- az_webapp_connection_update_storage-queue
- az_webapp_connection_update_storage-table
- az_webapp_connection_update_webpubsub
- az_webapp_connection_validate
- az_webapp_connection_wait
globalParameters:
- name: --debug
summary: |-
Increase logging verbosity to show all debug logs.
- name: --help -h
summary: |-
Show this help message and exit.
- name: --only-show-errors
summary: |-
Only show errors, suppressing warnings.
- name: --output -o
defaultValue: "json"
parameterValueGroup: "json, jsonc, none, table, tsv, yaml, yamlc"
summary: |-
Output format.
- name: --query
summary: |-
JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
- name: --subscription
summary: |-
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- name: --verbose
summary: |-
Increase logging verbosity. Use --debug for full debug logs.
metadata:
description: Commands to manage webapp connections.