Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Update-AzFunctionApp
- Module:
- Az.Functions Module
Updates a function app.
Syntax
ByName (Default)
Update-AzFunctionApp
-ResourceGroupName <String>
-Name <String>
[-SubscriptionId <String>]
[-PlanName <String>]
[-Force]
[-ApplicationInsightsName <String>]
[-ApplicationInsightsKey <String>]
[-Tag <Hashtable>]
[-EnableSystemAssignedIdentity <Boolean>]
[-UserAssignedIdentity <String[]>]
[-DefaultProfile <PSObject>]
[-NoWait]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByObjectInput
Update-AzFunctionApp
-InputObject <ISite>
[-PlanName <String>]
[-Force]
[-ApplicationInsightsName <String>]
[-ApplicationInsightsKey <String>]
[-Tag <Hashtable>]
[-EnableSystemAssignedIdentity <Boolean>]
[-UserAssignedIdentity <String[]>]
[-DefaultProfile <PSObject>]
[-NoWait]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Updates a function app.
Examples
Example 1: Update function app hosting plan.
Update-AzFunctionApp -Name MyUniqueFunctionAppName -ResourceGroupName MyResourceGroupName -PlanName NewPlanName -Force
This command updates function app hosting plan.
Example 2: Set a SystemAssigned managed identity for a function app.
Update-AzFunctionApp -Name MyUniqueFunctionAppName -ResourceGroupName MyResourceGroupName -EnableSystemAssignedIdentity $true -Force
This command sets a SystemAssigned managed identity for a function app.
Example 3: Update function app Application Insights.
Update-AzFunctionApp -Name MyUniqueFunctionAppName -ResourceGroupName MyResourceGroupName -ApplicationInsightsName ApplicationInsightsProjectName -Force
This command updates function app Application Insights.
Example 4: Remove managed identity from a function app.
Update-AzFunctionApp -Name MyUniqueFunctionAppName -ResourceGroupName MyResourceGroupName -EnableSystemAssignedIdentity $false -Force
This command removes a managed identity from a function app.
Parameters
-ApplicationInsightsKey
Instrumentation key of App Insights to be added.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AppInsightsKey |
Parameter sets
-ApplicationInsightsName
Name of the existing App Insights project to be added to the function app.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AppInsightsName |
Parameter sets
-AsJob
Runs the cmdlet as a background job.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | PSObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzureRMContext, AzureCredential |
Parameter sets
-EnableSystemAssignedIdentity
Determines whether to enable a system-assigned identity for the resource.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Force
Forces the cmdlet to update the function app without prompting for confirmation.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-InputObject
The function app object.
Parameter properties
| Type: | Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.ISite |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
The name of the function app.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NoWait
Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PlanName
The name of the service plan.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceGroupName
The name of the resource group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SubscriptionId
The Azure subscription ID.
Parameter properties
| Type: | String |
| Default value: | (Get-AzContext).Subscription.Id |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Tag
Resource tags.
Parameter properties
| Type: | Hashtable |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-UserAssignedIdentity
The array of user assigned identities associated with the function app. The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.ISite
Outputs
Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.ISite
Azure PowerShell
Feedback
Was this page helpful?