az functionapp deployment config
Manage a function app's deployment configuration.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az functionapp deployment config set |
Update an existing function app's deployment configuration. |
Core | GA |
| az functionapp deployment config show |
Get the details of a function app's deployment configuration. |
Core | GA |
az functionapp deployment config set
Update an existing function app's deployment configuration.
Use --deployment-storage-* for a blob container, or --deployment-image and its authentication arguments for a container image on Flex Consumption. Image deployment is separate from az functionapp config container. For an existing image deployment, you can update the image or authentication separately. Use a new tag or digest when deploying a newer image.
az functionapp deployment config set [--acquire-policy-token]
[--change-reference]
[--deployment-image]
[--deployment-image-auth-type --diat {Anonymous, Basic, SystemAssignedIdentity, UserAssignedIdentity}]
[--deployment-image-identity --dii]
[--deployment-image-password-setting --dips]
[--deployment-image-username-setting --dius]
[--deployment-storage-auth-type --dsat {StorageAccountConnectionString, SystemAssignedIdentity, UserAssignedIdentity}]
[--deployment-storage-auth-value --dsav]
[--deployment-storage-container-name --dscn]
[--deployment-storage-name --dsn]
[--ids]
[--name]
[--resource-group]
[--subscription]
Examples
Set the function app's deployment storage.
az functionapp deployment config set --name MyFunctionApp --resource-group MyResourceGroup --deployment-storage-name MyStorageAccount --deployment-storage-container-name MyStorageContainer
Set the function app's deployment storage authentication method.
az functionapp deployment config set --name MyFunctionApp --resource-group MyResourceGroup --deployment-storage-auth-type userAssignedIdentity --deployment-storage-auth-value myAssignedId
Run a public container image (Anonymous authentication).
az functionapp deployment config set --name MyFunctionApp --resource-group MyResourceGroup --deployment-image mcr.microsoft.com/azure-functions/dotnet-isolated:4-dotnet-isolated8.0 --deployment-image-auth-type Anonymous
Pull a container image by digest with the app's system-assigned identity.
az functionapp deployment config set --name MyFunctionApp --resource-group MyResourceGroup --deployment-image myregistry.azurecr.io/myimage@sha256:<digest> --deployment-image-auth-type SystemAssignedIdentity
Pull the container image with a user-assigned identity.
az functionapp deployment config set --name MyFunctionApp --resource-group MyResourceGroup --deployment-image myregistry.azurecr.io/myimage:v1 --deployment-image-auth-type UserAssignedIdentity --deployment-image-identity /subscriptions/<subscription-id>/resourceGroups/MyResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MyIdentity
Pull the container image with a username and password stored in app settings (Basic authentication).
az functionapp deployment config set --name MyFunctionApp --resource-group MyResourceGroup --deployment-image myregistry.azurecr.io/myimage:v1 --deployment-image-auth-type Basic --deployment-image-username-setting REGISTRY_USERNAME --deployment-image-password-setting REGISTRY_PASSWORD
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
Container image for a Flex Consumption app, specified by tag or digest, e.g. myregistry.azurecr.io/myimage:v1 or myregistry.azurecr.io/myimage@sha256:<digest>.
| Property | Value |
|---|---|
| Parameter group: | Flex Registry Deployment Arguments |
How the platform authenticates to the registry: Anonymous (public image), SystemAssignedIdentity, UserAssignedIdentity (requires --deployment-image-identity), or Basic (requires --deployment-image-username-setting and --deployment-image-password-setting). The CLI doesn't assign identities or grant registry access.
| Property | Value |
|---|---|
| Parameter group: | Flex Registry Deployment Arguments |
| Accepted values: | Anonymous, Basic, SystemAssignedIdentity, UserAssignedIdentity |
Resource ID of the user-assigned managed identity used to pull the image. Only valid with UserAssignedIdentity. Saved as provided; the CLI doesn't create, look up, or assign it.
| Property | Value |
|---|---|
| Parameter group: | Flex Registry Deployment Arguments |
Name of the app setting that stores the registry password. Only valid with Basic. Pass the app setting name, not the password.
| Property | Value |
|---|---|
| Parameter group: | Flex Registry Deployment Arguments |
Name of the app setting that stores the registry username. Only valid with Basic.
| Property | Value |
|---|---|
| Parameter group: | Flex Registry Deployment Arguments |
The deployment storage account authentication type.
| Property | Value |
|---|---|
| Accepted values: | StorageAccountConnectionString, SystemAssignedIdentity, UserAssignedIdentity |
The deployment storage account authentication value. For the user-assigned managed identity authentication type, this should be the user assigned identity resource id. For the storage account connection string authentication type, this should be the name of the app setting that will contain the storage account connection string. For the system assigned managed-identity authentication type, this parameter is not applicable and should be left empty.
The deployment storage account container name.
The deployment storage account name.
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.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of the function app.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az functionapp deployment config show
Get the details of a function app's deployment configuration.
For Registry deployment storage, shows the image reference and authentication type, with the user-assigned identity resource ID or the names of the app settings that hold Basic credentials. Credential values aren't retrieved or shown.
az functionapp deployment config show [--ids]
[--name]
[--resource-group]
[--subscription]
Examples
Get the details of a function app's deployment configuration.
az functionapp deployment config show --name MyFunctionApp --resource-group MyResourceGroup
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of the function app.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |