az functionapp 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 functionapp connections.

Commands

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

az functionapp connection delete

Delete a functionapp connection.

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

Examples

Delete a functionapp connection interactively

az functionapp connection delete

Delete a functionapp connection by connection name

az functionapp connection delete -g FuncAppRG -n MyFunctionApp --connection MyConnection

Delete a functionapp connection by connection id

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

Optional Parameters

--connection

Name of the functionapp connection.

--id

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

--name -n

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

--no-wait

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

default value: False

--resource-group -g

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

--yes -y

Do not prompt for confirmation.

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

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

az functionapp connection list

List connections of a functionapp.

az functionapp connection list [--name]
                               [--resource-group]
                               [--source-id]

Examples

List functionapp connections interactively

az functionapp connection list

List functionapp connections by source resource name

az functionapp connection list -g FuncAppRG -n MyFunctionApp

List functionapp connections by source resource id

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

Optional Parameters

--name -n

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

--resource-group -g

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

--source-id

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

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

az functionapp connection list-configuration

List source configurations of a functionapp connection.

az functionapp connection list-configuration [--connection]
                                             [--id]
                                             [--name]
                                             [--resource-group]

Examples

List a connection's source configurations interactively

az functionapp connection list-configuration

List a connection's source configurations by connection name

az functionapp connection list-configuration -g FuncAppRG -n MyFunctionApp --connection MyConnection

List a connection's source configurations by connection id

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

Optional Parameters

--connection

Name of the functionapp connection.

--id

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

--name -n

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

--resource-group -g

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

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

az functionapp connection list-support-types

List client types and auth types supported by functionapp connections.

az functionapp connection list-support-types [--target-type {app-insights, appconfig, 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

List all functionapp supported target resource types and auth types

az functionapp connection list-support-types -o table

List functionapp supported auth types for a specific target resource type

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

Optional Parameters

--target-type -t

The target resource type.

accepted values: app-insights, appconfig, 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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

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

az functionapp connection show

Get the details of a functionapp connection.

az functionapp connection show [--connection]
                               [--id]
                               [--name]
                               [--resource-group]

Examples

Get a connection interactively

az functionapp connection show

Get a connection by connection name

az functionapp connection show -g FuncAppRG -n MyFunctionApp --connection MyConnection

Get a connection by connection id

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

Optional Parameters

--connection

Name of the functionapp connection.

--id

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

--name -n

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

--resource-group -g

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

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

az functionapp connection validate

Validate a functionapp connection.

az functionapp connection validate [--connection]
                                   [--id]
                                   [--name]
                                   [--resource-group]

Examples

Validate a connection interactively

az functionapp connection validate

Validate a connection by connection name

az functionapp connection validate -g FuncAppRG -n MyFunctionApp --connection MyConnection

Validate a connection by connection id

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

Optional Parameters

--connection

Name of the functionapp connection.

--id

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

--name -n

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

--resource-group -g

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

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

az functionapp connection wait

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

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

Examples

Wait until the connection is successfully created.

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

Optional Parameters

--connection

Name of the functionapp connection.

--created

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

default value: False

--custom

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

--deleted

Wait until deleted.

default value: False

--exists

Wait until the resource exists.

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.

default value: 30

--name -n

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

--resource-group -g

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

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

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