az webapp connection

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 about extensions.

Commands to manage webapp connections.

Commands

Name	Description	Type	Status
az webapp connection create	Create a connection between a webapp and a target resource.	Core and Extension	GA
az webapp connection create app-insights	Create a webapp connection to app-insights.	Core	GA
az webapp connection create appconfig	Create a webapp connection to appconfig.	Core	GA
az webapp connection create cognitiveservices	Create a webapp connection to cognitiveservices.	Core	GA
az webapp connection create confluent-cloud	Create a webapp connection to confluent-cloud.	Core	GA
az webapp connection create cosmos-cassandra	Create a webapp connection to cosmos-cassandra.	Core	GA
az webapp connection create cosmos-gremlin	Create a webapp connection to cosmos-gremlin.	Core	GA
az webapp connection create cosmos-mongo	Create a webapp connection to cosmos-mongo.	Core	GA
az webapp connection create cosmos-sql	Create a webapp connection to cosmos-sql.	Core	GA
az webapp connection create cosmos-table	Create a webapp connection to cosmos-table.	Core	GA
az webapp connection create eventhub	Create a webapp connection to eventhub.	Core	GA
az webapp connection create fabric-sql	Create a webapp connection to fabric-sql.	Core	GA
az webapp connection create fabric-sql (serviceconnector-passwordless extension)	Create a webapp connection to fabric-sql.	Extension	GA
az webapp connection create keyvault	Create a webapp connection to keyvault.	Core	GA
az webapp connection create mongodb-atlas	Create a webapp connection to mongodb-atlas.	Core	GA
az webapp connection create mysql	Create a webapp connection to mysql.	Core	Deprecated
az webapp connection create mysql-flexible	Create a webapp connection to mysql-flexible.	Core	GA
az webapp connection create mysql-flexible (serviceconnector-passwordless extension)	Create a webapp connection to mysql-flexible.	Extension	GA
az webapp connection create neon-postgres	Create a webapp connection to neon-postgres.	Core	GA
az webapp connection create postgres	Create a webapp connection to postgres.	Core	Deprecated
az webapp connection create postgres-flexible	Create a webapp connection to postgres-flexible.	Core	GA
az webapp connection create postgres-flexible (serviceconnector-passwordless extension)	Create a webapp connection to postgres-flexible.	Extension	GA
az webapp connection create redis	Create a webapp connection to redis.	Core	GA
az webapp connection create redis-enterprise	Create a webapp connection to redis-enterprise.	Core	GA
az webapp connection create servicebus	Create a webapp connection to servicebus.	Core	GA
az webapp connection create signalr	Create a webapp connection to signalr.	Core	GA
az webapp connection create sql	Create a webapp connection to sql.	Core	GA
az webapp connection create sql (serviceconnector-passwordless extension)	Create a webapp connection to sql.	Extension	GA
az webapp connection create storage-blob	Create a webapp connection to storage-blob.	Core	GA
az webapp connection create storage-file	Create a webapp connection to storage-file.	Core	GA
az webapp connection create storage-queue	Create a webapp connection to storage-queue.	Core	GA
az webapp connection create storage-table	Create a webapp connection to storage-table.	Core	GA
az webapp connection create webpubsub	Create a webapp connection to webpubsub.	Core	GA
az webapp connection delete	Delete a webapp connection.	Core	GA
az webapp connection list	List connections of a webapp.	Core	GA
az webapp connection list-configuration	List source configurations of a webapp connection.	Core	GA
az webapp connection list-support-types	List client types and auth types supported by webapp connections.	Core	GA
az webapp connection show	Get the details of a webapp connection.	Core	GA
az webapp connection update	Update a webapp connection.	Core	GA
az webapp connection update app-insights	Update a webapp to app-insights connection.	Core	GA
az webapp connection update appconfig	Update a webapp to appconfig connection.	Core	GA
az webapp connection update cognitiveservices	Update a webapp to cognitiveservices connection.	Core	GA
az webapp connection update confluent-cloud	Update a webapp to confluent-cloud connection.	Core	GA
az webapp connection update cosmos-cassandra	Update a webapp to cosmos-cassandra connection.	Core	GA
az webapp connection update cosmos-gremlin	Update a webapp to cosmos-gremlin connection.	Core	GA
az webapp connection update cosmos-mongo	Update a webapp to cosmos-mongo connection.	Core	GA
az webapp connection update cosmos-sql	Update a webapp to cosmos-sql connection.	Core	GA
az webapp connection update cosmos-table	Update a webapp to cosmos-table connection.	Core	GA
az webapp connection update eventhub	Update a webapp to eventhub connection.	Core	GA
az webapp connection update fabric-sql	Update a webapp to fabric-sql connection.	Core	GA
az webapp connection update keyvault	Update a webapp to keyvault connection.	Core	GA
az webapp connection update mongodb-atlas	Update a webapp to mongodb-atlas connection.	Core	GA
az webapp connection update mysql	Update a webapp to mysql connection.	Core	Deprecated
az webapp connection update mysql-flexible	Update a webapp to mysql-flexible connection.	Core	GA
az webapp connection update neon-postgres	Update a webapp to neon-postgres connection.	Core	GA
az webapp connection update postgres	Update a webapp to postgres connection.	Core	Deprecated
az webapp connection update postgres-flexible	Update a webapp to postgres-flexible connection.	Core	GA
az webapp connection update redis	Update a webapp to redis connection.	Core	GA
az webapp connection update redis-enterprise	Update a webapp to redis-enterprise connection.	Core	GA
az webapp connection update servicebus	Update a webapp to servicebus connection.	Core	GA
az webapp connection update signalr	Update a webapp to signalr connection.	Core	GA
az webapp connection update sql	Update a webapp to sql connection.	Core	GA
az webapp connection update storage-blob	Update a webapp to storage-blob connection.	Core	GA
az webapp connection update storage-file	Update a webapp to storage-file connection.	Core	GA
az webapp connection update storage-queue	Update a webapp to storage-queue connection.	Core	GA
az webapp connection update storage-table	Update a webapp to storage-table connection.	Core	GA
az webapp connection update webpubsub	Update a webapp to webpubsub connection.	Core	GA
az webapp connection validate	Validate a webapp connection.	Core	GA
az webapp connection wait	Place the CLI in a waiting state until a condition of the connection is met.	Core	GA

az webapp connection delete

Delete a webapp connection.

az webapp connection delete [--connection]
                            [--id]
                            [--name]
                            [--no-wait]
                            [--resource-group]
                            [--slot]
                            [--yes]

Examples

Delete a webapp connection interactively

az webapp connection delete

Delete a webapp connection by connection name

az webapp connection delete -g WebAppRG -n MyWebApp --connection MyConnection

Delete a webapp connection by connection id

az webapp connection delete --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker}

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--connection

Name of the webapp connection.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the webapp. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--resource-group -g

The resource group which contains the webapp. Required if '--id' is not specified.None.

--slot

The name of the slot. Default to the production slot if not specified.

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az webapp connection list

List connections of a webapp.

az webapp connection list [--name]
                          [--resource-group]
                          [--slot]
                          [--source-id]

Examples

List webapp connections interactively

az webapp connection list

List webapp connections by source resource name

az webapp connection list -g WebAppRG -n MyWebApp

List webapp connections by source resource id

az webapp connection list --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--name -n

Name of the webapp. Required if '--source-id' is not specified.None.

--resource-group -g

The resource group which contains the webapp. Required if '--source-id' is not specified.None.

--slot

The name of the slot. Default to the production slot if not specified.

--source-id

The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az webapp connection list-configuration

List source configurations of a webapp connection.

az webapp connection list-configuration [--connection]
                                        [--id]
                                        [--name]
                                        [--resource-group]
                                        [--slot]

Examples

List a connection's source configurations interactively

az webapp connection list-configuration

List a connection's source configurations by connection name

az webapp connection list-configuration -g WebAppRG -n MyWebApp --connection MyConnection

List a connection's source configurations by connection id

az webapp connection list-configuration --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker}

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--connection

Name of the webapp connection.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the webapp. Required if '--id' is not specified.None.

--resource-group -g

The resource group which contains the webapp. Required if '--id' is not specified.None.

--slot

The name of the slot. Default to the production slot if not specified.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az webapp connection list-support-types

List client types and auth types supported by webapp connections.

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, fabric-sql, keyvault, mongodb-atlas, mysql, mysql-flexible, neon-postgres, postgres, postgres-flexible, redis, redis-enterprise, servicebus, signalr, sql, storage-blob, storage-file, storage-queue, storage-table, webpubsub}]

Examples

List all webapp supported target resource types and auth types

az webapp connection list-support-types -o table

List webapp supported auth types for a specific target resource type

az webapp connection list-support-types --target-type storage-blob -o table

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--target-type -t

The target resource type.

Property	Value
Accepted values:	app-insights, appconfig, cognitiveservices, confluent-cloud, cosmos-cassandra, cosmos-gremlin, cosmos-mongo, cosmos-sql, cosmos-table, eventhub, fabric-sql, keyvault, mongodb-atlas, mysql, mysql-flexible, neon-postgres, postgres, postgres-flexible, redis, redis-enterprise, servicebus, signalr, sql, storage-blob, storage-file, storage-queue, storage-table, webpubsub

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az webapp connection show

Get the details of a webapp connection.

az webapp connection show [--connection]
                          [--id]
                          [--name]
                          [--resource-group]
                          [--slot]

Examples

Get a connection interactively

az webapp connection show

Get a connection by connection name

az webapp connection show -g WebAppRG -n MyWebApp --connection MyConnection

Get a connection by connection id

az webapp connection show --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker}

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--connection

Name of the webapp connection.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the webapp. Required if '--id' is not specified.None.

--resource-group -g

The resource group which contains the webapp. Required if '--id' is not specified.None.

--slot

The name of the slot. Default to the production slot if not specified.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az webapp connection validate

Validate a webapp connection.

az webapp connection validate [--connection]
                              [--id]
                              [--name]
                              [--resource-group]
                              [--slot]

Examples

Validate a connection interactively

az webapp connection validate

Validate a connection by connection name

az webapp connection validate -g WebAppRG -n MyWebApp --connection MyConnection

Validate a connection by connection id

az webapp connection validate --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker}

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--connection

Name of the webapp connection.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the webapp. Required if '--id' is not specified.None.

--resource-group -g

The resource group which contains the webapp. Required if '--id' is not specified.None.

--slot

The name of the slot. Default to the production slot if not specified.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az webapp connection wait

Place the CLI in a waiting state until a condition of the connection is met.

az webapp connection wait [--connection]
                          [--created]
                          [--custom]
                          [--deleted]
                          [--exists]
                          [--id]
                          [--interval]
                          [--name]
                          [--resource-group]
                          [--slot]
                          [--timeout]
                          [--updated]

Examples

Wait until the connection is successfully created.

az webapp connection wait --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --created

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--connection

Name of the webapp connection.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name -n

Name of the webapp. Required if '--id' is not specified.None.

--resource-group -g

The resource group which contains the webapp. Required if '--id' is not specified.None.

--slot

The name of the slot. Default to the production slot if not specified.

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

Share via

az webapp connection

Commands

az webapp connection delete

Examples

Optional Parameters

az webapp connection list

Examples

Optional Parameters

az webapp connection list-configuration

Examples

Optional Parameters

az webapp connection list-support-types

Examples

Optional Parameters

az webapp connection show

Examples

Optional Parameters

az webapp connection validate

Examples

Optional Parameters

az webapp connection wait

Examples

Optional Parameters

Feedback