az functionapp connection update
Update a functionapp connection.
Commands
Name | Description | Type | Status |
---|---|---|---|
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 cognitiveservices |
Update a functionapp to cognitiveservices 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 update app-insights
Update a functionapp to app-insights connection.
az functionapp connection update app-insights [--appconfig-id]
[--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--resource-group]
[--secret]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update app-insights -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update app-insights --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update appconfig
Update a functionapp to appconfig connection.
az functionapp connection update appconfig [--appconfig-id]
[--client-type {dotnet, dotnet-internal, java, nodejs, none, python}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-principal]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update appconfig -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update appconfig --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update cognitiveservices
Update a functionapp to cognitiveservices connection.
az functionapp connection update cognitiveservices [--appconfig-id]
[--client-type {dotnet, none, python}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--resource-group]
[--secret]
[--service-principal]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update cognitiveservices -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update cognitiveservices --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update confluent-cloud
Update a functionapp to confluent-cloud connection.
az functionapp connection update confluent-cloud --connection
[--appconfig-id]
[--bootstrap-server]
[--client-type {dotnet, dotnet-internal, go, java, none, python, springBoot}]
[--customized-keys]
[--kafka-key]
[--kafka-secret]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--resource-group]
[--schema-key]
[--schema-registry]
[--schema-secret]
[--source-id]
[--vault-id]
Examples
Update the client-type of a bootstrap server connection
az functionapp connection update confluent-cloud -g FuncAppRG -n MyFunctionApp --connection MyConnection --client python
Update the auth configurations of a bootstrap server connection
az functionapp connection update confluent-cloud -g FuncAppRG -n MyFunctionApp --connection MyConnection --bootstrap-server xxx.eastus.azure.confluent.cloud:9092 --kafka-key Name --kafka-secret Secret
Update the client-type of a schema registry connection
az functionapp connection update confluent-cloud -g FuncAppRG -n MyFunctionApp --connection MyConnection_schema --client python
Update the auth configurations of a schema registry connection
az functionapp connection update confluent-cloud -g FuncAppRG -n MyFunctionApp --connection MyConnection_schema --schema-registry https://xxx.eastus.azure.confluent.cloud --schema-key Name --schema-secret Secret
Required Parameters
Name of the connection.
Optional Parameters
The app configuration id to store configuration.
Kafka bootstrap server url.
The client type used on the functionapp.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
Kafka API-Key (key).
Kafka API-Key (secret).
Name of the function app. Required if '--source-id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
The resource group which contains the function app. Required if '--source-id' is not specified.None.
Schema registry API-Key (key).
Schema registry url.
Schema registry API-Key (secret).
The resource id of a functionapp. Required if ['--resource-group', '--name'] are not specified.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update cosmos-cassandra
Update a functionapp to cosmos-cassandra connection.
az functionapp connection update cosmos-cassandra [--appconfig-id]
[--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update cosmos-cassandra -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update cosmos-cassandra --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update cosmos-gremlin
Update a functionapp to cosmos-gremlin connection.
az functionapp connection update cosmos-gremlin [--appconfig-id]
[--client-type {dotnet, dotnet-internal, java, nodejs, none, php, python}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update cosmos-gremlin -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update cosmos-gremlin --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update cosmos-mongo
Update a functionapp to cosmos-mongo connection.
az functionapp connection update cosmos-mongo [--appconfig-id]
[--client-type {dotnet, dotnet-internal, go, java, nodejs, none, springBoot}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update cosmos-mongo -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update cosmos-mongo --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update cosmos-sql
Update a functionapp to cosmos-sql connection.
az functionapp connection update cosmos-sql [--appconfig-id]
[--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update cosmos-sql -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update cosmos-sql --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update cosmos-table
Update a functionapp to cosmos-table connection.
az functionapp connection update cosmos-table [--appconfig-id]
[--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update cosmos-table -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update cosmos-table --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update eventhub
Update a functionapp to eventhub connection.
az functionapp connection update eventhub [--appconfig-id]
[--client-type {dotnet, dotnet-internal, go, java, kafka-springBoot, nodejs, none, python, springBoot}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update eventhub -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update eventhub --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update keyvault
Update a functionapp to keyvault connection.
az functionapp connection update keyvault [--appconfig-id]
[--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--service-endpoint {false, true}]
[--service-principal]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update keyvault -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update keyvault --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the function app. Required if '--id' is not specified.None.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update mysql
This command has been deprecated and will be removed in a future release.
Update a functionapp to mysql connection.
az functionapp connection update mysql [--appconfig-id]
[--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update mysql -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update mysql --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX
name : Required. Username or account name for secret auth. secret : One of <secret, secret-uri, secret-name> is required. Password or account key for secret auth. secret-uri : One of <secret, secret-uri, secret-name> is required. Keyvault secret uri which stores password. secret-name : One of <secret, secret-uri, secret-name> is required. Keyvault secret name which stores password. It's for AKS only.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update mysql-flexible
Update a functionapp to mysql-flexible connection.
az functionapp connection update mysql-flexible [--appconfig-id]
[--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--resource-group]
[--secret]
[--service-principal]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update mysql-flexible -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update mysql-flexible --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX
name : Required. Username or account name for secret auth. secret : One of <secret, secret-uri, secret-name> is required. Password or account key for secret auth. secret-uri : One of <secret, secret-uri, secret-name> is required. Keyvault secret uri which stores password. secret-name : One of <secret, secret-uri, secret-name> is required. Keyvault secret name which stores password. It's for AKS only.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The system assigned identity auth info.
Usage: --system-identity mysql-identity-id=xx
mysql-identity-id : Optional. ID of identity used for MySQL flexible server AAD Authentication. Ignore it if you are the server AAD administrator.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update postgres
This command has been deprecated and will be removed in a future release.
Update a functionapp to postgres connection.
az functionapp connection update postgres [--appconfig-id]
[--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update postgres -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update postgres --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX
name : Required. Username or account name for secret auth. secret : One of <secret, secret-uri, secret-name> is required. Password or account key for secret auth. secret-uri : One of <secret, secret-uri, secret-name> is required. Keyvault secret uri which stores password. secret-name : One of <secret, secret-uri, secret-name> is required. Keyvault secret name which stores password. It's for AKS only.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update postgres-flexible
Update a functionapp to postgres-flexible connection.
az functionapp connection update postgres-flexible [--appconfig-id]
[--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--resource-group]
[--secret]
[--service-principal]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update postgres-flexible -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update postgres-flexible --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX
name : Required. Username or account name for secret auth. secret : One of <secret, secret-uri, secret-name> is required. Password or account key for secret auth. secret-uri : One of <secret, secret-uri, secret-name> is required. Keyvault secret uri which stores password. secret-name : One of <secret, secret-uri, secret-name> is required. Keyvault secret name which stores password. It's for AKS only.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update redis
Update a functionapp to redis connection.
az functionapp connection update redis [--appconfig-id]
[--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update redis -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update redis --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update redis-enterprise
Update a functionapp to redis-enterprise connection.
az functionapp connection update redis-enterprise [--appconfig-id]
[--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--resource-group]
[--secret]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update redis-enterprise -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update redis-enterprise --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update servicebus
Update a functionapp to servicebus connection.
az functionapp connection update servicebus [--appconfig-id]
[--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update servicebus -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update servicebus --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update signalr
Update a functionapp to signalr connection.
az functionapp connection update signalr [--appconfig-id]
[--client-type {dotnet, dotnet-internal, none}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-principal]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update signalr -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update signalr --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update sql
Update a functionapp to sql connection.
az functionapp connection update sql [--appconfig-id]
[--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update sql -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update sql --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX
name : Required. Username or account name for secret auth. secret : One of <secret, secret-uri, secret-name> is required. Password or account key for secret auth. secret-uri : One of <secret, secret-uri, secret-name> is required. Keyvault secret uri which stores password. secret-name : One of <secret, secret-uri, secret-name> is required. Keyvault secret name which stores password. It's for AKS only.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update storage-blob
Update a functionapp to storage-blob connection.
az functionapp connection update storage-blob [--appconfig-id]
[--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update storage-blob -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update storage-blob --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update storage-file
Update a functionapp to storage-file connection.
az functionapp connection update storage-file [--appconfig-id]
[--client-type {dotnet, dotnet-internal, java, nodejs, none, php, python, ruby, springBoot}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update storage-file -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update storage-file --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update storage-queue
Update a functionapp to storage-queue connection.
az functionapp connection update storage-queue [--appconfig-id]
[--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update storage-queue -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update storage-queue --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update storage-table
Update a functionapp to storage-table connection.
az functionapp connection update storage-table [--appconfig-id]
[--client-type {dotnet, dotnet-internal, java, nodejs, none, python}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update storage-table -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update storage-table --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az functionapp connection update webpubsub
Update a functionapp to webpubsub connection.
az functionapp connection update webpubsub [--appconfig-id]
[--client-type {dotnet, dotnet-internal, java, nodejs, none, python}]
[--connection]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-principal]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az functionapp connection update webpubsub -g FuncAppRG -n MyFunctionApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az functionapp connection update webpubsub --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the functionapp.
Name of the functionapp connection.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the function app. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the function app. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Azure CLI