az functionapp config container

  • Reference

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.

Manage an existing function app's container settings.

Commands

Name Description Type Status
az functionapp config container delete

Delete an existing function app's container settings.

 Core GA
az functionapp config container set

Set an existing function app's container settings.

 Core GA
az functionapp config container set (appservice-kube extension)

Set an existing function app's container settings.

 Extension GA
az functionapp config container show

Get details of a function app's container settings.

 Core GA

az functionapp config container delete

Edit

Delete an existing function app's container settings.

az functionapp config container delete [--ids]
                                       [--name]
                                       [--resource-group]
                                       [--slot]
                                       [--subscription]

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the function app.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--slot -s

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

--subscription

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

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 config container set

Edit

Set an existing function app's container settings.

az functionapp config container set [--cpu]
                                    [--dal {false, true}]
                                    [--dapr-app-id]
                                    [--dapr-app-port]
                                    [--dapr-http-max-request-size]
                                    [--dapr-http-read-buffer-size]
                                    [--dapr-log-level {debug, error, info, warn}]
                                    [--docker-custom-image-name]
                                    [--docker-registry-server-password]
                                    [--docker-registry-server-url]
                                    [--docker-registry-server-user]
                                    [--enable-dapr {false, true}]
                                    [--ids]
                                    [--image]
                                    [--max-replicas]
                                    [--memory]
                                    [--min-replicas]
                                    [--name]
                                    [--registry-password]
                                    [--registry-server]
                                    [--registry-username]
                                    [--resource-group]
                                    [--slot]
                                    [--subscription]
                                    [--workload-profile-name]

Examples

Set a function app container's settings. (autogenerated)

az functionapp config container set --docker-custom-image-name MyDockerCustomImage --docker-registry-server-password StrongPassword --docker-registry-server-url https://{azure-container-registry-name}.azurecr.io --docker-registry-server-user DockerUserId --name MyFunctionApp --resource-group MyResourceGroup

Optional Parameters

--cpu
Preview

Required CPU in cores from 0.5 to 2.0.

--dal --dapr-enable-api-logging

Enable/Disable API logging for the Dapr sidecar.

accepted values: false, true
--dapr-app-id

The Dapr application identifier.

--dapr-app-port

The port Dapr uses to communicate to the application.

--dapr-http-max-request-size --dhmrs

Max size of request body http and grpc servers in MB to handle uploading of large files.

--dapr-http-read-buffer-size --dhrbs

Max size of http header read buffer in KB to handle when sending multi-KB headers.

--dapr-log-level

The log level for the Dapr sidecar.

accepted values: debug, error, info, warn
--docker-custom-image-name
Deprecated

Option '--docker-custom-image-name' has been deprecated and will be removed in a future release. Use '--image' instead.

The container custom image name and optionally the tag name (e.g., /:).

--docker-registry-server-password
Deprecated

Option '--docker-registry-server-password' has been deprecated and will be removed in a future release. Use '--registry-password' instead.

The container registry server password.

--docker-registry-server-url
Deprecated

Option '--docker-registry-server-url' has been deprecated and will be removed in a future release. Use '--registry-server' instead.

The container registry server url.

--docker-registry-server-user
Deprecated

Option '--docker-registry-server-user' has been deprecated and will be removed in a future release. Use '--registry-username' instead.

The container registry server username.

--enable-dapr

Enable/Disable Dapr for a function app on an Azure Container App environment.

accepted values: false, true
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--image -c -i

The container custom image name and optionally the tag name (e.g., /:).

--max-replicas
Preview

The maximum number of replicas when create function app on container app.

--memory
Preview

Required momory from 1.0 to 4.0 ending with Gi e.g. 1.0Gi,.

--min-replicas
Preview

The minimum number of replicas when create function app on container app.

--name -n

Name of the function app.

--registry-password -p

The container registry server password.

--registry-server -r

The container registry server url.

--registry-username -u

The container registry server username.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--slot -s

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

--subscription

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

--workload-profile-name
Preview

The name of the workload profile to run the app on.

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 config container set (appservice-kube extension)

Set an existing function app's container settings.

az functionapp config container set [--docker-custom-image-name]
                                    [--docker-registry-server-password]
                                    [--docker-registry-server-url]
                                    [--docker-registry-server-user]
                                    [--ids]
                                    [--name]
                                    [--resource-group]
                                    [--slot]
                                    [--subscription]

Examples

Set a function app container's settings. (autogenerated)

az functionapp config container set --docker-custom-image-name MyDockerCustomImage --docker-registry-server-password StrongPassword --docker-registry-server-url https://{azure-container-registry-name}.azurecr.io --docker-registry-server-user DockerUserId --name MyFunctionApp --resource-group MyResourceGroup

Optional Parameters

--docker-custom-image-name -c -i

The container custom image name and optionally the tag name.

--docker-registry-server-password -p

The container registry server password.

--docker-registry-server-url -r

The container registry server url.

--docker-registry-server-user -u

The container registry server username.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the function app.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--slot -s

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

--subscription

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

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 config container show

Edit

Get details of a function app's container settings.

az functionapp config container show [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--slot]
                                     [--subscription]

Examples

Get details of a function app container's settings. (autogenerated)

az functionapp config container show --name MyFunctionApp --resource-group MyResourceGroup

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the function app.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--slot -s

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

--subscription

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

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.