Functions.Autorest/exports/ProxyCmdletDefinitions.ps1
|
# ---------------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # http://www.apache.org/licenses/LICENSE-2.0 # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code # is regenerated. # ---------------------------------------------------------------------------------- <# .Synopsis Gets function apps in a subscription. .Description Gets function apps in a subscription. .Example Get-AzFunctionApp .Example Get-AzFunctionApp -ResourceGroupName Functions-West-Europe-Win -Name Functions1-Windows-DoNet .Example Get-AzFunctionApp -ResourceGroupName Functions-West-Europe-Win .Example Get-AzFunctionApp -SubscriptionId fe16564a-d943-4bf8-8c28-cf01708c3f8b .Example Get-AzFunctionApp -Location "Central US" .Outputs Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite .Link https://learn.microsoft.com/powershell/module/az.functions/get-azfunctionapp #> function Get-AzFunctionApp { [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite])] [CmdletBinding(DefaultParameterSetName='GetAll', PositionalBinding=$false)] param( [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.DefaultInfo(Script='(Get-AzContext).Subscription.Id')] [System.String[]] # The Azure subscription ID. ${SubscriptionId}, [Parameter(ParameterSetName='ByLocation', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] # The location of the function app. ${Location}, [Parameter(ParameterSetName='ByResourceGroupName', Mandatory)] [Parameter(ParameterSetName='ByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] # The name of the resource group. ${ResourceGroupName}, [Parameter(ParameterSetName='ByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] # The name of the function app. ${Name}, [Parameter(ParameterSetName='ByResourceGroupName')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.Management.Automation.SwitchParameter] # Use to specify whether to include deployment slots in results. ${IncludeSlot}, [Parameter()] [Alias('AzureRMContext', 'AzureCredential')] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Azure')] [System.Management.Automation.PSObject] # The credentials, account, tenant, and subscription used for communication with Azure. ${DefaultProfile}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelinePrepend}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Uri] ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.PSCredential] ${ProxyCredential}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName if ($null -eq [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion) { [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion = $PSVersionTable.PSVersion.ToString() } $preTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId if ($preTelemetryId -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId =(New-Guid).ToString() [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Create', $MyInvocation, $parameterSet, $PSCmdlet) } else { $internalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets if ($internalCalledCmdlets -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $MyInvocation.MyCommand.Name } else { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets += ',' + $MyInvocation.MyCommand.Name } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = 'internal' } $mapping = @{ GetAll = 'Az.Functions.custom\Get-AzFunctionApp'; ByLocation = 'Az.Functions.custom\Get-AzFunctionApp'; ByResourceGroupName = 'Az.Functions.custom\Get-AzFunctionApp'; ByName = 'Az.Functions.custom\Get-AzFunctionApp'; } if (('GetAll', 'ByLocation', 'ByResourceGroupName', 'ByName') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $testPlayback = $false $PSBoundParameters['HttpPipelinePrepend'] | Foreach-Object { if ($_) { $testPlayback = $testPlayback -or ('Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.PipelineMock' -eq $_.Target.GetType().FullName -and 'Playback' -eq $_.Target.Mode) } } if ($testPlayback) { $PSBoundParameters['SubscriptionId'] = . (Join-Path $PSScriptRoot '..' 'utils' 'Get-SubscriptionIdTestSafe.ps1') } else { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id } } $cmdInfo = Get-Command -Name $mapping[$parameterSet] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessCustomAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) if ($null -ne $MyInvocation.MyCommand -and [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets -notcontains $MyInvocation.MyCommand.Name -and [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ContainsPreviewAttribute($cmdInfo, $MyInvocation)){ [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessPreviewMessageAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets.Enqueue($MyInvocation.MyCommand.Name) } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } process { try { $steppablePipeline.Process($_) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } finally { $backupTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId $backupInternalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } } end { try { $steppablePipeline.End() [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $backupTelemetryId [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $backupInternalCalledCmdlets if ($preTelemetryId -eq '') { [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Send', $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $preTelemetryId } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } } <# .Synopsis Gets the location where a function app for the given os and plan type is available. .Description Gets the location where a function app for the given os and plan type is available. .Example Get-AzFunctionAppAvailableLocation .Example Get-AzFunctionAppAvailableLocation -PlanType Premium -OSType Linux .Example Get-AzFunctionAppAvailableLocation -PlanType Consumption -OSType Windows .Outputs Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IGeoRegion .Link https://learn.microsoft.com/powershell/module/az.functions/get-azfunctionappavailablelocation #> function Get-AzFunctionAppAvailableLocation { [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IGeoRegion])] [CmdletBinding(PositionalBinding=$false)] param( [Parameter(Position=0)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.DefaultInfo(Script='(Get-AzContext).Subscription.Id')] [System.String[]] # The Azure subscription ID. ${SubscriptionId}, [Parameter(Position=1)] [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.Functions.Support.AvailablePlanType])] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # The plan type. # Valid inputs: Consumption or Premium ${PlanType}, [Parameter(Position=2)] [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.Functions.Support.WorkerType])] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # The OS type for the service plan. ${OSType}, [Parameter(Position=3)] [Alias('AzureRMContext', 'AzureCredential')] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Azure')] [System.Management.Automation.PSObject] # The credentials, account, tenant, and subscription used for communication with Azure. ${DefaultProfile}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${Break}, [Parameter(Position=4, DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelineAppend}, [Parameter(Position=5, DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelinePrepend}, [Parameter(Position=6, DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Uri] ${Proxy}, [Parameter(Position=7, DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.PSCredential] ${ProxyCredential}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName if ($null -eq [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion) { [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion = $PSVersionTable.PSVersion.ToString() } $preTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId if ($preTelemetryId -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId =(New-Guid).ToString() [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Create', $MyInvocation, $parameterSet, $PSCmdlet) } else { $internalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets if ($internalCalledCmdlets -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $MyInvocation.MyCommand.Name } else { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets += ',' + $MyInvocation.MyCommand.Name } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = 'internal' } $mapping = @{ __AllParameterSets = 'Az.Functions.custom\Get-AzFunctionAppAvailableLocation'; } if (('__AllParameterSets') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $testPlayback = $false $PSBoundParameters['HttpPipelinePrepend'] | Foreach-Object { if ($_) { $testPlayback = $testPlayback -or ('Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.PipelineMock' -eq $_.Target.GetType().FullName -and 'Playback' -eq $_.Target.Mode) } } if ($testPlayback) { $PSBoundParameters['SubscriptionId'] = . (Join-Path $PSScriptRoot '..' 'utils' 'Get-SubscriptionIdTestSafe.ps1') } else { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id } } $cmdInfo = Get-Command -Name $mapping[$parameterSet] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessCustomAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) if ($null -ne $MyInvocation.MyCommand -and [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets -notcontains $MyInvocation.MyCommand.Name -and [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ContainsPreviewAttribute($cmdInfo, $MyInvocation)){ [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessPreviewMessageAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets.Enqueue($MyInvocation.MyCommand.Name) } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } process { try { $steppablePipeline.Process($_) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } finally { $backupTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId $backupInternalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } } end { try { $steppablePipeline.End() [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $backupTelemetryId [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $backupInternalCalledCmdlets if ($preTelemetryId -eq '') { [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Send', $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $preTelemetryId } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } } <# .Synopsis Get function apps plans in a subscription. .Description Get function apps plans in a subscription. .Example Get-AzFunctionAppPlan .Example Get-AzFunctionAppPlan -ResourceGroupName "West Europe" .Example Get-AzFunctionAppPlan -SubscriptionId fe16564a-d943-4bf8-8c28-cf01708c3f8z .Example Get-AzFunctionAppPlan -Location "Central US" .Outputs Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IAppServicePlan .Link https://learn.microsoft.com/powershell/module/az.functions/get-azfunctionappplan #> function Get-AzFunctionAppPlan { [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IAppServicePlan])] [CmdletBinding(DefaultParameterSetName='GetAll', PositionalBinding=$false)] param( [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.DefaultInfo(Script='(Get-AzContext).Subscription.Id')] [System.String[]] # The Azure subscription ID. ${SubscriptionId}, [Parameter(ParameterSetName='ByLocation', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] # The location of the function app plan. ${Location}, [Parameter(ParameterSetName='ByResourceGroupName')] [Parameter(ParameterSetName='ByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] # The name of the resource group. ${ResourceGroupName}, [Parameter(ParameterSetName='ByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] # The service plan name. ${Name}, [Parameter()] [Alias('AzureRMContext', 'AzureCredential')] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Azure')] [System.Management.Automation.PSObject] # The credentials, account, tenant, and subscription used for communication with Azure. ${DefaultProfile}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelinePrepend}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Uri] ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.PSCredential] ${ProxyCredential}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName if ($null -eq [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion) { [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion = $PSVersionTable.PSVersion.ToString() } $preTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId if ($preTelemetryId -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId =(New-Guid).ToString() [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Create', $MyInvocation, $parameterSet, $PSCmdlet) } else { $internalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets if ($internalCalledCmdlets -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $MyInvocation.MyCommand.Name } else { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets += ',' + $MyInvocation.MyCommand.Name } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = 'internal' } $mapping = @{ GetAll = 'Az.Functions.custom\Get-AzFunctionAppPlan'; ByLocation = 'Az.Functions.custom\Get-AzFunctionAppPlan'; ByResourceGroupName = 'Az.Functions.custom\Get-AzFunctionAppPlan'; ByName = 'Az.Functions.custom\Get-AzFunctionAppPlan'; } if (('GetAll', 'ByLocation', 'ByResourceGroupName', 'ByName') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $testPlayback = $false $PSBoundParameters['HttpPipelinePrepend'] | Foreach-Object { if ($_) { $testPlayback = $testPlayback -or ('Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.PipelineMock' -eq $_.Target.GetType().FullName -and 'Playback' -eq $_.Target.Mode) } } if ($testPlayback) { $PSBoundParameters['SubscriptionId'] = . (Join-Path $PSScriptRoot '..' 'utils' 'Get-SubscriptionIdTestSafe.ps1') } else { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id } } $cmdInfo = Get-Command -Name $mapping[$parameterSet] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessCustomAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) if ($null -ne $MyInvocation.MyCommand -and [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets -notcontains $MyInvocation.MyCommand.Name -and [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ContainsPreviewAttribute($cmdInfo, $MyInvocation)){ [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessPreviewMessageAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets.Enqueue($MyInvocation.MyCommand.Name) } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } process { try { $steppablePipeline.Process($_) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } finally { $backupTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId $backupInternalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } } end { try { $steppablePipeline.End() [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $backupTelemetryId [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $backupInternalCalledCmdlets if ($preTelemetryId -eq '') { [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Send', $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $preTelemetryId } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } } <# .Synopsis Gets app settings for a function app. .Description Gets app settings for a function app. .Example Get-AzFunctionAppSetting -Name MyAppName -ResourceGroupName MyResourceGroupName .Inputs Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite .Outputs Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IStringDictionary .Notes COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. INPUTOBJECT <ISite>: Location <String>: Resource Location. [Kind <String>]: Kind of resource. [Tag <IResourceTags>]: Resource tags. [(Any) <String>]: This indicates any property can be added to this object. [AuthenticationStorageAccountConnectionStringName <String>]: Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. [AuthenticationType <AuthenticationType?>]: Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. [AuthenticationUserAssignedIdentityResourceId <String>]: Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. [ClientAffinityEnabled <Boolean?>]: <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>. [ClientCertEnabled <Boolean?>]: <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. [ClientCertExclusionPath <String>]: client certificate authentication comma-separated exclusion paths [ClientCertMode <ClientCertMode?>]: This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. [CloningInfoAppSettingsOverride <ICloningInfoAppSettingsOverrides>]: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. [(Any) <String>]: This indicates any property can be added to this object. [CloningInfoCloneCustomHostName <Boolean?>]: <code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>. [CloningInfoCloneSourceControl <Boolean?>]: <code>true</code> to clone source control from source app; otherwise, <code>false</code>. [CloningInfoConfigureLoadBalancing <Boolean?>]: <code>true</code> to configure load balancing for source and destination app. [CloningInfoCorrelationId <String>]: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. [CloningInfoHostingEnvironment <String>]: App Service Environment. [CloningInfoOverwrite <Boolean?>]: <code>true</code> to overwrite destination app; otherwise, <code>false</code>. [CloningInfoSourceWebAppId <String>]: ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. [CloningInfoSourceWebAppLocation <String>]: Location of source app ex: West US or North Europe [CloningInfoTrafficManagerProfileId <String>]: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. [CloningInfoTrafficManagerProfileName <String>]: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. [Config <ISiteConfig>]: Configuration of the app. [AcrUseManagedIdentityCred <Boolean?>]: Flag to use Managed Identity Creds for ACR pull [AcrUserManagedIdentityId <String>]: If using user managed identity, the user managed identity ClientId [ActionMinProcessExecutionTime <String>]: Minimum time the process must execute before taking the action [ActionType <AutoHealActionType?>]: Predefined action to be taken. [AlwaysOn <Boolean?>]: <code>true</code> if Always On is enabled; otherwise, <code>false</code>. [ApiDefinitionUrl <String>]: The URL of the API definition. [ApiManagementConfigId <String>]: APIM-Api Identifier. [AppCommandLine <String>]: App command line to launch. [AppSetting <INameValuePair[]>]: Application settings. [Name <String>]: Pair name. [Value <String>]: Pair value. [AutoHealEnabled <Boolean?>]: <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. [AutoSwapSlotName <String>]: Auto-swap slot name. [AzureStorageAccount <ISiteConfigAzureStorageAccounts>]: List of Azure Storage Accounts. [(Any) <IAzureStorageInfoValue>]: This indicates any property can be added to this object. [ConnectionString <IConnStringInfo[]>]: Connection strings. [ConnectionString <String>]: Connection string value. [Name <String>]: Name of connection string. [Type <ConnectionStringType?>]: Type of database. [CorAllowedOrigin <String[]>]: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. [CorSupportCredentials <Boolean?>]: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. [CustomActionExe <String>]: Executable to be run. [CustomActionParameter <String>]: Parameters for the executable. [DefaultDocument <String[]>]: Default documents. [DetailedErrorLoggingEnabled <Boolean?>]: <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. [DocumentRoot <String>]: Document root. [DynamicTagsJson <String>]: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. [ElasticWebAppScaleLimit <Int32?>]: Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is <code>true</code> [ExperimentRampUpRule <IRampUpRule[]>]: List of ramp-up rules. [ActionHostName <String>]: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. [ChangeDecisionCallbackUrl <String>]: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/ [ChangeIntervalInMinute <Int32?>]: Specifies interval in minutes to reevaluate ReroutePercentage. [ChangeStep <Double?>]: In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>. [MaxReroutePercentage <Double?>]: Specifies upper boundary below which ReroutePercentage will stay. [MinReroutePercentage <Double?>]: Specifies lower boundary above which ReroutePercentage will stay. [Name <String>]: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. [ReroutePercentage <Double?>]: Percentage of the traffic which will be redirected to <code>ActionHostName</code>. [FtpsState <FtpsState?>]: State of FTP / FTPS service [FunctionAppScaleLimit <Int32?>]: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans [FunctionsRuntimeScaleMonitoringEnabled <Boolean?>]: Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status. [HandlerMapping <IHandlerMapping[]>]: Handler mappings. [Argument <String>]: Command-line arguments to be passed to the script processor. [Extension <String>]: Requests with this extension will be handled using the specified FastCGI application. [ScriptProcessor <String>]: The absolute path to the FastCGI application. [HealthCheckPath <String>]: Health check path [Http20Enabled <Boolean?>]: Http20Enabled: configures a web site to allow clients to connect over http2.0 [HttpLoggingEnabled <Boolean?>]: <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. [IPSecurityRestriction <IIPSecurityRestriction[]>]: IP security restrictions for main. [Action <String>]: Allow or Deny access for this IP range. [Description <String>]: IP restriction rule description. [Header <IIPSecurityRestrictionHeaders>]: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. [(Any) <String[]>]: This indicates any property can be added to this object. [IPAddress <String>]: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. [Name <String>]: IP restriction rule name. [Priority <Int32?>]: Priority of IP restriction rule. [SubnetMask <String>]: Subnet mask for the range of IP addresses the restriction is valid for. [SubnetTrafficTag <Int32?>]: (internal) Subnet traffic tag [Tag <IPFilterTag?>]: Defines what this IP filter will be used for. This is to support IP filtering on proxies. [VnetSubnetResourceId <String>]: Virtual network resource id [VnetTrafficTag <Int32?>]: (internal) Vnet traffic tag [IPSecurityRestrictionsDefaultAction <DefaultAction?>]: Default action for main access restriction if no rules are matched. [IsPushEnabled <Boolean?>]: Gets or sets a flag indicating whether the Push endpoint is enabled. [JavaContainer <String>]: Java container. [JavaContainerVersion <String>]: Java container version. [JavaVersion <String>]: Java version. [KeyVaultReferenceIdentity <String>]: Identity to use for Key Vault Reference authentication. [LimitMaxDiskSizeInMb <Int64?>]: Maximum allowed disk size usage in MB. [LimitMaxMemoryInMb <Int64?>]: Maximum allowed memory usage in MB. [LimitMaxPercentageCpu <Double?>]: Maximum allowed CPU usage percentage. [LinuxFxVersion <String>]: Linux App Framework and version [LoadBalancing <SiteLoadBalancing?>]: Site load balancing. [LocalMySqlEnabled <Boolean?>]: <code>true</code> to enable local MySQL; otherwise, <code>false</code>. [LogsDirectorySizeLimit <Int32?>]: HTTP logs directory size limit. [MachineKeyDecryption <String>]: Algorithm used for decryption. [MachineKeyDecryptionKey <String>]: Decryption key. [MachineKeyValidation <String>]: MachineKey validation. [MachineKeyValidationKey <String>]: Validation key. [ManagedPipelineMode <ManagedPipelineMode?>]: Managed pipeline mode. [ManagedServiceIdentityId <Int32?>]: Managed Service Identity Id [Metadata <INameValuePair[]>]: Application metadata. This property cannot be retrieved, since it may contain secrets. [MinTlsCipherSuite <TlsCipherSuites?>]: The minimum strength TLS cipher suite allowed for an application [MinTlsVersion <SupportedTlsVersions?>]: MinTlsVersion: configures the minimum version of TLS required for SSL requests [MinimumElasticInstanceCount <Int32?>]: Number of minimum instance count for a site This setting only applies to the Elastic Plans [NetFrameworkVersion <String>]: .NET Framework version. [NodeVersion <String>]: Version of Node.js. [NumberOfWorker <Int32?>]: Number of workers. [PhpVersion <String>]: Version of PHP. [PowerShellVersion <String>]: Version of PowerShell. [PreWarmedInstanceCount <Int32?>]: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans [PublicNetworkAccess <String>]: Property to allow or block all public traffic. [PublishingUsername <String>]: Publishing user name. [PushKind <String>]: Kind of resource. [PythonVersion <String>]: Version of Python. [RemoteDebuggingEnabled <Boolean?>]: <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. [RemoteDebuggingVersion <String>]: Remote debugging version. [RequestCount <Int32?>]: Request Count. [RequestTimeInterval <String>]: Time interval. [RequestTracingEnabled <Boolean?>]: <code>true</code> if request tracing is enabled; otherwise, <code>false</code>. [RequestTracingExpirationTime <DateTime?>]: Request tracing expiration time. [ScmIPSecurityRestriction <IIPSecurityRestriction[]>]: IP security restrictions for scm. [ScmIPSecurityRestrictionsDefaultAction <DefaultAction?>]: Default action for scm access restriction if no rules are matched. [ScmIPSecurityRestrictionsUseMain <Boolean?>]: IP security restrictions for scm to use main. [ScmMinTlsVersion <SupportedTlsVersions?>]: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site [ScmType <ScmType?>]: SCM type. [SlowRequestCount <Int32?>]: Request Count. [SlowRequestPath <String>]: Request Path. [SlowRequestTimeInterval <String>]: Time interval. [SlowRequestTimeTaken <String>]: Time taken. [TagWhitelistJson <String>]: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. [TagsRequiringAuth <String>]: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. [TracingOption <String>]: Tracing options. [TriggerPrivateBytesInKb <Int32?>]: A rule based on private bytes. [TriggerSlowRequestsWithPath <ISlowRequestsBasedTrigger[]>]: A rule based on multiple Slow Requests Rule with path [Count <Int32?>]: Request Count. [Path <String>]: Request Path. [TimeInterval <String>]: Time interval. [TimeTaken <String>]: Time taken. [TriggerStatusCode <IStatusCodesBasedTrigger[]>]: A rule based on status codes. [Count <Int32?>]: Request Count. [Path <String>]: Request Path [Status <Int32?>]: HTTP status code. [SubStatus <Int32?>]: Request Sub Status. [TimeInterval <String>]: Time interval. [Win32Status <Int32?>]: Win32 error code. [TriggerStatusCodesRange <IStatusCodesRangeBasedTrigger[]>]: A rule based on status codes ranges. [Count <Int32?>]: Request Count. [Path <String>]: [StatusCode <String>]: HTTP status code. [TimeInterval <String>]: Time interval. [Use32BitWorkerProcess <Boolean?>]: <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. [VirtualApplication <IVirtualApplication[]>]: Virtual applications. [PhysicalPath <String>]: Physical path. [PreloadEnabled <Boolean?>]: <code>true</code> if preloading is enabled; otherwise, <code>false</code>. [VirtualDirectory <IVirtualDirectory[]>]: Virtual directories for virtual application. [PhysicalPath <String>]: Physical path. [VirtualPath <String>]: Path to virtual application. [VirtualPath <String>]: Virtual path. [VnetName <String>]: Virtual Network name. [VnetPrivatePortsCount <Int32?>]: The number of private ports assigned to this app. These will be assigned dynamically on runtime. [VnetRouteAllEnabled <Boolean?>]: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. [WebSocketsEnabled <Boolean?>]: <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. [WebsiteTimeZone <String>]: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones [WindowsFxVersion <String>]: Xenon App Framework and version [XManagedServiceIdentityId <Int32?>]: Explicit Managed Service Identity Id [ContainerSize <Int32?>]: Size of the function container. [CustomDomainVerificationId <String>]: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. [DailyMemoryTimeQuota <Int32?>]: Maximum allowed daily memory-time quota (applicable on dynamic apps only). [DaprConfigAppId <String>]: Dapr application identifier [DaprConfigAppPort <Int32?>]: Tells Dapr which port your application is listening on [DaprConfigEnableApiLogging <Boolean?>]: Enables API logging for the Dapr sidecar [DaprConfigEnabled <Boolean?>]: Boolean indicating if the Dapr side car is enabled [DaprConfigHttpMaxRequestSize <Int32?>]: Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. [DaprConfigHttpReadBufferSize <Int32?>]: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. [DaprConfigLogLevel <DaprLogLevel?>]: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. [DnsConfigurationDnsAltServer <String>]: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. [DnsConfigurationDnsMaxCacheTimeout <Int32?>]: Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. [DnsConfigurationDnsRetryAttemptCount <Int32?>]: Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. [DnsConfigurationDnsRetryAttemptTimeout <Int32?>]: Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. [DnsConfigurationDnsServer <String[]>]: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. [Enabled <Boolean?>]: <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline). [ExtendedLocationName <String>]: Name of extended location. [HostNameSslState <IHostNameSslState[]>]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. [HostType <HostType?>]: Indicates whether the hostname is a standard or repository hostname. [Name <String>]: Hostname. [SslState <SslState?>]: SSL type. [Thumbprint <String>]: SSL certificate thumbprint. [ToUpdate <Boolean?>]: Set to <code>true</code> to update existing hostname. [VirtualIP <String>]: Virtual IP address assigned to the hostname if IP based SSL is enabled. [HostNamesDisabled <Boolean?>]: <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process. [HostingEnvironmentProfileId <String>]: Resource ID of the App Service Environment. [HttpPerInstanceConcurrency <Single?>]: The maximum number of concurrent HTTP trigger invocations per instance. [HttpsOnly <Boolean?>]: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests [HyperV <Boolean?>]: Hyper-V sandbox. [IdentityType <ManagedServiceIdentityType?>]: Type of managed service identity. [IdentityUserAssignedIdentity <IManagedServiceIdentityUserAssignedIdentities>]: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} [(Any) <IUserAssignedIdentity>]: This indicates any property can be added to this object. [IsXenon <Boolean?>]: Obsolete: Hyper-V sandbox. [KeyVaultReferenceIdentity <String>]: Identity to use for Key Vault Reference authentication. [ManagedEnvironmentId <String>]: Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} [PublicNetworkAccess <String>]: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. [RedundancyMode <RedundancyMode?>]: Site redundancy mode [Reserved <Boolean?>]: <code>true</code> if reserved; otherwise, <code>false</code>. [ResourceConfigCpu <Double?>]: Required CPU in cores, e.g. 0.5 [ResourceConfigMemory <String>]: Required memory, e.g. "1Gi" [RuntimeName <RuntimeName?>]: Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom [RuntimeVersion <String>]: Function app runtime version. Example: 8 (for dotnet-isolated) [ScaleAndConcurrencyAlwaysReady <IFunctionsAlwaysReadyConfig[]>]: 'Always Ready' configuration for the function app. [InstanceCount <Single?>]: Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready. [Name <String>]: Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. [ScaleAndConcurrencyInstanceMemoryMb <Single?>]: Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. [ScaleAndConcurrencyMaximumInstanceCount <Single?>]: The maximum number of instances for the function app. [ScmSiteAlsoStopped <Boolean?>]: <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. [ServerFarmId <String>]: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". [StorageAccountRequired <Boolean?>]: Checks if Customer provided storage account is required [StorageType <FunctionsDeploymentStorageType?>]: Property to select Azure Storage type. Available options: blobContainer. [StorageValue <String>]: Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://<storageAccountName>.blob.core.windows.net/<containerName>. [VirtualNetworkSubnetId <String>]: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} [VnetBackupRestoreEnabled <Boolean?>]: To enable Backup and Restore operations over virtual network [VnetContentShareEnabled <Boolean?>]: To enable accessing content over virtual network [VnetImagePullEnabled <Boolean?>]: To enable pulling image over Virtual Network [VnetRouteAllEnabled <Boolean?>]: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. [WorkloadProfileName <String>]: Workload profile name for function app to execute on. .Link https://learn.microsoft.com/powershell/module/az.functions/get-azfunctionappsetting #> function Get-AzFunctionAppSetting { [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IStringDictionary])] [CmdletBinding(DefaultParameterSetName='ByName', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='ByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] # Name of the function app. ${Name}, [Parameter(ParameterSetName='ByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] # Name of the resource group to which the resource belongs. ${ResourceGroupName}, [Parameter(ParameterSetName='ByName')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.DefaultInfo(Script='(Get-AzContext).Subscription.Id')] [System.String[]] # The Azure subscription ID. ${SubscriptionId}, [Parameter(ParameterSetName='ByObjectInput', Mandatory, ValueFromPipeline)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite] # To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ${InputObject}, [Parameter()] [Alias('AzureRMContext', 'AzureCredential')] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Azure')] [System.Management.Automation.PSObject] ${DefaultProfile}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelinePrepend}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Uri] ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.PSCredential] ${ProxyCredential}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName if ($null -eq [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion) { [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion = $PSVersionTable.PSVersion.ToString() } $preTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId if ($preTelemetryId -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId =(New-Guid).ToString() [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Create', $MyInvocation, $parameterSet, $PSCmdlet) } else { $internalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets if ($internalCalledCmdlets -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $MyInvocation.MyCommand.Name } else { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets += ',' + $MyInvocation.MyCommand.Name } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = 'internal' } $mapping = @{ ByName = 'Az.Functions.custom\Get-AzFunctionAppSetting'; ByObjectInput = 'Az.Functions.custom\Get-AzFunctionAppSetting'; } if (('ByName') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $testPlayback = $false $PSBoundParameters['HttpPipelinePrepend'] | Foreach-Object { if ($_) { $testPlayback = $testPlayback -or ('Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.PipelineMock' -eq $_.Target.GetType().FullName -and 'Playback' -eq $_.Target.Mode) } } if ($testPlayback) { $PSBoundParameters['SubscriptionId'] = . (Join-Path $PSScriptRoot '..' 'utils' 'Get-SubscriptionIdTestSafe.ps1') } else { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id } } $cmdInfo = Get-Command -Name $mapping[$parameterSet] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessCustomAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) if ($null -ne $MyInvocation.MyCommand -and [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets -notcontains $MyInvocation.MyCommand.Name -and [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ContainsPreviewAttribute($cmdInfo, $MyInvocation)){ [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessPreviewMessageAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets.Enqueue($MyInvocation.MyCommand.Name) } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } process { try { $steppablePipeline.Process($_) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } finally { $backupTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId $backupInternalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } } end { try { $steppablePipeline.End() [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $backupTelemetryId [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $backupInternalCalledCmdlets if ($preTelemetryId -eq '') { [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Send', $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $preTelemetryId } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } } <# .Synopsis Creates a function app. .Description Creates a function app. .Example New-AzFunctionApp -Name MyUniqueFunctionAppName ` -ResourceGroupName MyResourceGroupName ` -Location centralUS ` -StorageAccountName MyStorageAccountName ` -Runtime PowerShell .Example New-AzFunctionApp -Name MyUniqueFunctionAppName ` -ResourceGroupName MyResourceGroupName ` -PlanName MyPlanName ` -StorageAccountName MyStorageAccountName ` -Runtime PowerShell .Example New-AzFunctionApp -Name MyUniqueFunctionAppName ` -ResourceGroupName MyResourceGroupName ` -PlanName MyPlanName ` -StorageAccountName MyStorageAccountName ` -DockerImageName myacr.azurecr.io/myimage:tag .Example New-AzFunctionApp -Name MyUniqueFunctionAppName ` -ResourceGroupName MyResourceGroupName ` -StorageAccountName MyStorageAccountName ` -Environment MyEnvironment ` -WorkloadProfileName MyWorkloadProfileName .Outputs Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite .Link https://learn.microsoft.com/powershell/module/az.functions/new-azfunctionapp #> function New-AzFunctionApp { [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite])] [CmdletBinding(DefaultParameterSetName='Consumption', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # The name of the resource group. ${ResourceGroupName}, [Parameter(Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # The name of the function app. ${Name}, [Parameter(Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # The name of the storage account. ${StorageAccountName}, [Parameter(ParameterSetName='Consumption', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # The location for the consumption plan. ${Location}, [Parameter(ParameterSetName='Consumption', Mandatory)] [Parameter(ParameterSetName='ByAppServicePlan', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # The function runtime. ${Runtime}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.DefaultInfo(Script='(Get-AzContext).Subscription.Id')] [System.String] # The Azure subscription ID. ${SubscriptionId}, [Parameter()] [Alias('AppInsightsName')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # Name of the existing App Insights project to be added to the function app. ${ApplicationInsightsName}, [Parameter()] [Alias('AppInsightsKey')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # Instrumentation key of App Insights to be added. ${ApplicationInsightsKey}, [Parameter(ParameterSetName='Consumption')] [Parameter(ParameterSetName='ByAppServicePlan')] [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.Functions.Support.WorkerType])] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # The OS to host the function app. ${OSType}, [Parameter(ParameterSetName='Consumption')] [Parameter(ParameterSetName='ByAppServicePlan')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # The function runtime. ${RuntimeVersion}, [Parameter(ParameterSetName='Consumption')] [Parameter(ParameterSetName='ByAppServicePlan')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # The Functions version. ${FunctionsVersion}, [Parameter()] [Alias('DisableAppInsights')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.Management.Automation.SwitchParameter] # Disable creating application insights resource during the function app creation. # No logs will be available. ${DisableApplicationInsights}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.Management.Automation.SwitchParameter] # Returns true when the command succeeds. ${PassThru}, [Parameter()] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.Info(PossibleTypes=([Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IResourceTags]))] [System.Collections.Hashtable] # Resource tags. ${Tag}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.Collections.Hashtable] # Function app settings. ${AppSetting}, [Parameter()] [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.Functions.Support.FunctionAppManagedServiceIdentityCreateType])] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Support.ManagedServiceIdentityType] # Specifies the type of identity used for the function app. # The acceptable values for this parameter are: # - SystemAssigned # - UserAssigned ${IdentityType}, [Parameter()] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String[]] # Specifies the list of user 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/identities/{identityName}' ${IdentityID}, [Parameter(ParameterSetName='EnvironmentForContainerApp', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # Name of the container app environment. ${Environment}, [Parameter(ParameterSetName='EnvironmentForContainerApp')] [Parameter(ParameterSetName='CustomDockerImage', Mandatory)] [Alias('DockerImageName')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # Container image name, e.g., publisher/image-name:tag. ${Image}, [Parameter(ParameterSetName='EnvironmentForContainerApp')] [Parameter(ParameterSetName='CustomDockerImage')] [Alias('DockerRegistryCredential')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.Management.Automation.PSCredential] # The container registry username and password. # Required for private registries. ${RegistryCredential}, [Parameter(ParameterSetName='EnvironmentForContainerApp')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # The workload profile name to run the container app on. ${WorkloadProfileName}, [Parameter(ParameterSetName='EnvironmentForContainerApp')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.Double] # The CPU in cores of the container app. # e.g., 0.75. ${ResourceCpu}, [Parameter(ParameterSetName='EnvironmentForContainerApp')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # The memory size of the container app. # e.g., 1.0Gi. ${ResourceMemory}, [Parameter(ParameterSetName='EnvironmentForContainerApp')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.Int32] # The maximum number of replicas when creating a function app on container app. ${ScaleMaxReplica}, [Parameter(ParameterSetName='EnvironmentForContainerApp')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.Int32] # The minimum number of replicas when create function app on container app. ${ScaleMinReplica}, [Parameter(ParameterSetName='EnvironmentForContainerApp')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # The container registry server hostname, e.g. # myregistry.azurecr.io. ${RegistryServer}, [Parameter(ParameterSetName='CustomDockerImage', Mandatory)] [Parameter(ParameterSetName='ByAppServicePlan', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # The name of the service plan. ${PlanName}, [Parameter()] [Alias('AzureRMContext', 'AzureCredential')] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Azure')] [System.Management.Automation.PSObject] ${DefaultProfile}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] # 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. ${NoWait}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Runs the cmdlet as a background job. ${AsJob}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelinePrepend}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Uri] ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.PSCredential] ${ProxyCredential}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName if ($null -eq [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion) { [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion = $PSVersionTable.PSVersion.ToString() } $preTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId if ($preTelemetryId -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId =(New-Guid).ToString() [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Create', $MyInvocation, $parameterSet, $PSCmdlet) } else { $internalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets if ($internalCalledCmdlets -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $MyInvocation.MyCommand.Name } else { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets += ',' + $MyInvocation.MyCommand.Name } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = 'internal' } $mapping = @{ Consumption = 'Az.Functions.custom\New-AzFunctionApp'; EnvironmentForContainerApp = 'Az.Functions.custom\New-AzFunctionApp'; CustomDockerImage = 'Az.Functions.custom\New-AzFunctionApp'; ByAppServicePlan = 'Az.Functions.custom\New-AzFunctionApp'; } if (('Consumption', 'EnvironmentForContainerApp', 'CustomDockerImage', 'ByAppServicePlan') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $testPlayback = $false $PSBoundParameters['HttpPipelinePrepend'] | Foreach-Object { if ($_) { $testPlayback = $testPlayback -or ('Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.PipelineMock' -eq $_.Target.GetType().FullName -and 'Playback' -eq $_.Target.Mode) } } if ($testPlayback) { $PSBoundParameters['SubscriptionId'] = . (Join-Path $PSScriptRoot '..' 'utils' 'Get-SubscriptionIdTestSafe.ps1') } else { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id } } $cmdInfo = Get-Command -Name $mapping[$parameterSet] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessCustomAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) if ($null -ne $MyInvocation.MyCommand -and [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets -notcontains $MyInvocation.MyCommand.Name -and [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ContainsPreviewAttribute($cmdInfo, $MyInvocation)){ [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessPreviewMessageAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets.Enqueue($MyInvocation.MyCommand.Name) } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } process { try { $steppablePipeline.Process($_) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } finally { $backupTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId $backupInternalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } } end { try { $steppablePipeline.End() [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $backupTelemetryId [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $backupInternalCalledCmdlets if ($preTelemetryId -eq '') { [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Send', $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $preTelemetryId } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } } <# .Synopsis Creates a function app service plan. .Description Creates a function app service plan. .Example New-AzFunctionAppPlan -ResourceGroupName MyResourceGroupName ` -Name MyPremiumPlan ` -Location WestEurope ` -MinimumWorkerCount 1 ` -MaximumWorkerCount 10 ` -Sku EP1 ` -WorkerType Windows .Outputs Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IAppServicePlan .Link https://learn.microsoft.com/powershell/module/az.functions/new-azfunctionappplan #> function New-AzFunctionAppPlan { [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IAppServicePlan])] [CmdletBinding(PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] # Name of the App Service plan. ${Name}, [Parameter(Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] # Name of the resource group to which the resource belongs. ${ResourceGroupName}, [Parameter(Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] # The location for the consumption plan. ${Location}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.DefaultInfo(Script='(Get-AzContext).Subscription.Id')] [System.String] # The Azure subscription ID. ${SubscriptionId}, [Parameter(Mandatory)] [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.Functions.Support.SkuType])] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # The plan sku. # Valid inputs are: EP1, EP2, EP3 ${Sku}, [Parameter()] [Alias('MaxBurst')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.Int32] # The maximum number of workers for the app service plan. ${MaximumWorkerCount}, [Parameter()] [Alias('MinInstances')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.Int32] # The minimum number of workers for the app service plan. ${MinimumWorkerCount}, [Parameter()] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.Info(PossibleTypes=([Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IResourceTags]))] [System.Collections.Hashtable] # Resource tags. ${Tag}, [Parameter()] [Alias('AzureRMContext', 'AzureCredential')] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Azure')] [System.Management.Automation.PSObject] ${DefaultProfile}, [Parameter(Mandatory)] [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.Functions.Support.WorkerType])] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.String] # The worker type for the plan. # Valid inputs are: Windows or Linux. ${WorkerType}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Run the command asynchronously. ${NoWait}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Run the command as a job. ${AsJob}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelinePrepend}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Uri] ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.PSCredential] ${ProxyCredential}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName if ($null -eq [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion) { [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion = $PSVersionTable.PSVersion.ToString() } $preTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId if ($preTelemetryId -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId =(New-Guid).ToString() [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Create', $MyInvocation, $parameterSet, $PSCmdlet) } else { $internalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets if ($internalCalledCmdlets -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $MyInvocation.MyCommand.Name } else { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets += ',' + $MyInvocation.MyCommand.Name } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = 'internal' } $mapping = @{ __AllParameterSets = 'Az.Functions.custom\New-AzFunctionAppPlan'; } if (('__AllParameterSets') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $testPlayback = $false $PSBoundParameters['HttpPipelinePrepend'] | Foreach-Object { if ($_) { $testPlayback = $testPlayback -or ('Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.PipelineMock' -eq $_.Target.GetType().FullName -and 'Playback' -eq $_.Target.Mode) } } if ($testPlayback) { $PSBoundParameters['SubscriptionId'] = . (Join-Path $PSScriptRoot '..' 'utils' 'Get-SubscriptionIdTestSafe.ps1') } else { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id } } $cmdInfo = Get-Command -Name $mapping[$parameterSet] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessCustomAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) if ($null -ne $MyInvocation.MyCommand -and [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets -notcontains $MyInvocation.MyCommand.Name -and [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ContainsPreviewAttribute($cmdInfo, $MyInvocation)){ [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessPreviewMessageAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets.Enqueue($MyInvocation.MyCommand.Name) } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } process { try { $steppablePipeline.Process($_) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } finally { $backupTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId $backupInternalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } } end { try { $steppablePipeline.End() [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $backupTelemetryId [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $backupInternalCalledCmdlets if ($preTelemetryId -eq '') { [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Send', $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $preTelemetryId } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } } <# .Synopsis Deletes a function app. .Description Deletes a function app. .Example Get-AzFunctionApp -Name MyAppName -ResourceGroupName MyResourceGroupName | Remove-AzFunctionApp -Force .Example Remove-AzFunctionApp -Name MyAppName -ResourceGroupName MyResourceGroupName -Force .Inputs Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite .Outputs System.Boolean .Notes COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. INPUTOBJECT <ISite>: Location <String>: Resource Location. [Kind <String>]: Kind of resource. [Tag <IResourceTags>]: Resource tags. [(Any) <String>]: This indicates any property can be added to this object. [AuthenticationStorageAccountConnectionStringName <String>]: Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. [AuthenticationType <AuthenticationType?>]: Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. [AuthenticationUserAssignedIdentityResourceId <String>]: Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. [ClientAffinityEnabled <Boolean?>]: <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>. [ClientCertEnabled <Boolean?>]: <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. [ClientCertExclusionPath <String>]: client certificate authentication comma-separated exclusion paths [ClientCertMode <ClientCertMode?>]: This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. [CloningInfoAppSettingsOverride <ICloningInfoAppSettingsOverrides>]: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. [(Any) <String>]: This indicates any property can be added to this object. [CloningInfoCloneCustomHostName <Boolean?>]: <code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>. [CloningInfoCloneSourceControl <Boolean?>]: <code>true</code> to clone source control from source app; otherwise, <code>false</code>. [CloningInfoConfigureLoadBalancing <Boolean?>]: <code>true</code> to configure load balancing for source and destination app. [CloningInfoCorrelationId <String>]: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. [CloningInfoHostingEnvironment <String>]: App Service Environment. [CloningInfoOverwrite <Boolean?>]: <code>true</code> to overwrite destination app; otherwise, <code>false</code>. [CloningInfoSourceWebAppId <String>]: ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. [CloningInfoSourceWebAppLocation <String>]: Location of source app ex: West US or North Europe [CloningInfoTrafficManagerProfileId <String>]: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. [CloningInfoTrafficManagerProfileName <String>]: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. [Config <ISiteConfig>]: Configuration of the app. [AcrUseManagedIdentityCred <Boolean?>]: Flag to use Managed Identity Creds for ACR pull [AcrUserManagedIdentityId <String>]: If using user managed identity, the user managed identity ClientId [ActionMinProcessExecutionTime <String>]: Minimum time the process must execute before taking the action [ActionType <AutoHealActionType?>]: Predefined action to be taken. [AlwaysOn <Boolean?>]: <code>true</code> if Always On is enabled; otherwise, <code>false</code>. [ApiDefinitionUrl <String>]: The URL of the API definition. [ApiManagementConfigId <String>]: APIM-Api Identifier. [AppCommandLine <String>]: App command line to launch. [AppSetting <INameValuePair[]>]: Application settings. [Name <String>]: Pair name. [Value <String>]: Pair value. [AutoHealEnabled <Boolean?>]: <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. [AutoSwapSlotName <String>]: Auto-swap slot name. [AzureStorageAccount <ISiteConfigAzureStorageAccounts>]: List of Azure Storage Accounts. [(Any) <IAzureStorageInfoValue>]: This indicates any property can be added to this object. [ConnectionString <IConnStringInfo[]>]: Connection strings. [ConnectionString <String>]: Connection string value. [Name <String>]: Name of connection string. [Type <ConnectionStringType?>]: Type of database. [CorAllowedOrigin <String[]>]: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. [CorSupportCredentials <Boolean?>]: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. [CustomActionExe <String>]: Executable to be run. [CustomActionParameter <String>]: Parameters for the executable. [DefaultDocument <String[]>]: Default documents. [DetailedErrorLoggingEnabled <Boolean?>]: <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. [DocumentRoot <String>]: Document root. [DynamicTagsJson <String>]: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. [ElasticWebAppScaleLimit <Int32?>]: Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is <code>true</code> [ExperimentRampUpRule <IRampUpRule[]>]: List of ramp-up rules. [ActionHostName <String>]: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. [ChangeDecisionCallbackUrl <String>]: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/ [ChangeIntervalInMinute <Int32?>]: Specifies interval in minutes to reevaluate ReroutePercentage. [ChangeStep <Double?>]: In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>. [MaxReroutePercentage <Double?>]: Specifies upper boundary below which ReroutePercentage will stay. [MinReroutePercentage <Double?>]: Specifies lower boundary above which ReroutePercentage will stay. [Name <String>]: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. [ReroutePercentage <Double?>]: Percentage of the traffic which will be redirected to <code>ActionHostName</code>. [FtpsState <FtpsState?>]: State of FTP / FTPS service [FunctionAppScaleLimit <Int32?>]: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans [FunctionsRuntimeScaleMonitoringEnabled <Boolean?>]: Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status. [HandlerMapping <IHandlerMapping[]>]: Handler mappings. [Argument <String>]: Command-line arguments to be passed to the script processor. [Extension <String>]: Requests with this extension will be handled using the specified FastCGI application. [ScriptProcessor <String>]: The absolute path to the FastCGI application. [HealthCheckPath <String>]: Health check path [Http20Enabled <Boolean?>]: Http20Enabled: configures a web site to allow clients to connect over http2.0 [HttpLoggingEnabled <Boolean?>]: <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. [IPSecurityRestriction <IIPSecurityRestriction[]>]: IP security restrictions for main. [Action <String>]: Allow or Deny access for this IP range. [Description <String>]: IP restriction rule description. [Header <IIPSecurityRestrictionHeaders>]: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. [(Any) <String[]>]: This indicates any property can be added to this object. [IPAddress <String>]: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. [Name <String>]: IP restriction rule name. [Priority <Int32?>]: Priority of IP restriction rule. [SubnetMask <String>]: Subnet mask for the range of IP addresses the restriction is valid for. [SubnetTrafficTag <Int32?>]: (internal) Subnet traffic tag [Tag <IPFilterTag?>]: Defines what this IP filter will be used for. This is to support IP filtering on proxies. [VnetSubnetResourceId <String>]: Virtual network resource id [VnetTrafficTag <Int32?>]: (internal) Vnet traffic tag [IPSecurityRestrictionsDefaultAction <DefaultAction?>]: Default action for main access restriction if no rules are matched. [IsPushEnabled <Boolean?>]: Gets or sets a flag indicating whether the Push endpoint is enabled. [JavaContainer <String>]: Java container. [JavaContainerVersion <String>]: Java container version. [JavaVersion <String>]: Java version. [KeyVaultReferenceIdentity <String>]: Identity to use for Key Vault Reference authentication. [LimitMaxDiskSizeInMb <Int64?>]: Maximum allowed disk size usage in MB. [LimitMaxMemoryInMb <Int64?>]: Maximum allowed memory usage in MB. [LimitMaxPercentageCpu <Double?>]: Maximum allowed CPU usage percentage. [LinuxFxVersion <String>]: Linux App Framework and version [LoadBalancing <SiteLoadBalancing?>]: Site load balancing. [LocalMySqlEnabled <Boolean?>]: <code>true</code> to enable local MySQL; otherwise, <code>false</code>. [LogsDirectorySizeLimit <Int32?>]: HTTP logs directory size limit. [MachineKeyDecryption <String>]: Algorithm used for decryption. [MachineKeyDecryptionKey <String>]: Decryption key. [MachineKeyValidation <String>]: MachineKey validation. [MachineKeyValidationKey <String>]: Validation key. [ManagedPipelineMode <ManagedPipelineMode?>]: Managed pipeline mode. [ManagedServiceIdentityId <Int32?>]: Managed Service Identity Id [Metadata <INameValuePair[]>]: Application metadata. This property cannot be retrieved, since it may contain secrets. [MinTlsCipherSuite <TlsCipherSuites?>]: The minimum strength TLS cipher suite allowed for an application [MinTlsVersion <SupportedTlsVersions?>]: MinTlsVersion: configures the minimum version of TLS required for SSL requests [MinimumElasticInstanceCount <Int32?>]: Number of minimum instance count for a site This setting only applies to the Elastic Plans [NetFrameworkVersion <String>]: .NET Framework version. [NodeVersion <String>]: Version of Node.js. [NumberOfWorker <Int32?>]: Number of workers. [PhpVersion <String>]: Version of PHP. [PowerShellVersion <String>]: Version of PowerShell. [PreWarmedInstanceCount <Int32?>]: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans [PublicNetworkAccess <String>]: Property to allow or block all public traffic. [PublishingUsername <String>]: Publishing user name. [PushKind <String>]: Kind of resource. [PythonVersion <String>]: Version of Python. [RemoteDebuggingEnabled <Boolean?>]: <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. [RemoteDebuggingVersion <String>]: Remote debugging version. [RequestCount <Int32?>]: Request Count. [RequestTimeInterval <String>]: Time interval. [RequestTracingEnabled <Boolean?>]: <code>true</code> if request tracing is enabled; otherwise, <code>false</code>. [RequestTracingExpirationTime <DateTime?>]: Request tracing expiration time. [ScmIPSecurityRestriction <IIPSecurityRestriction[]>]: IP security restrictions for scm. [ScmIPSecurityRestrictionsDefaultAction <DefaultAction?>]: Default action for scm access restriction if no rules are matched. [ScmIPSecurityRestrictionsUseMain <Boolean?>]: IP security restrictions for scm to use main. [ScmMinTlsVersion <SupportedTlsVersions?>]: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site [ScmType <ScmType?>]: SCM type. [SlowRequestCount <Int32?>]: Request Count. [SlowRequestPath <String>]: Request Path. [SlowRequestTimeInterval <String>]: Time interval. [SlowRequestTimeTaken <String>]: Time taken. [TagWhitelistJson <String>]: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. [TagsRequiringAuth <String>]: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. [TracingOption <String>]: Tracing options. [TriggerPrivateBytesInKb <Int32?>]: A rule based on private bytes. [TriggerSlowRequestsWithPath <ISlowRequestsBasedTrigger[]>]: A rule based on multiple Slow Requests Rule with path [Count <Int32?>]: Request Count. [Path <String>]: Request Path. [TimeInterval <String>]: Time interval. [TimeTaken <String>]: Time taken. [TriggerStatusCode <IStatusCodesBasedTrigger[]>]: A rule based on status codes. [Count <Int32?>]: Request Count. [Path <String>]: Request Path [Status <Int32?>]: HTTP status code. [SubStatus <Int32?>]: Request Sub Status. [TimeInterval <String>]: Time interval. [Win32Status <Int32?>]: Win32 error code. [TriggerStatusCodesRange <IStatusCodesRangeBasedTrigger[]>]: A rule based on status codes ranges. [Count <Int32?>]: Request Count. [Path <String>]: [StatusCode <String>]: HTTP status code. [TimeInterval <String>]: Time interval. [Use32BitWorkerProcess <Boolean?>]: <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. [VirtualApplication <IVirtualApplication[]>]: Virtual applications. [PhysicalPath <String>]: Physical path. [PreloadEnabled <Boolean?>]: <code>true</code> if preloading is enabled; otherwise, <code>false</code>. [VirtualDirectory <IVirtualDirectory[]>]: Virtual directories for virtual application. [PhysicalPath <String>]: Physical path. [VirtualPath <String>]: Path to virtual application. [VirtualPath <String>]: Virtual path. [VnetName <String>]: Virtual Network name. [VnetPrivatePortsCount <Int32?>]: The number of private ports assigned to this app. These will be assigned dynamically on runtime. [VnetRouteAllEnabled <Boolean?>]: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. [WebSocketsEnabled <Boolean?>]: <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. [WebsiteTimeZone <String>]: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones [WindowsFxVersion <String>]: Xenon App Framework and version [XManagedServiceIdentityId <Int32?>]: Explicit Managed Service Identity Id [ContainerSize <Int32?>]: Size of the function container. [CustomDomainVerificationId <String>]: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. [DailyMemoryTimeQuota <Int32?>]: Maximum allowed daily memory-time quota (applicable on dynamic apps only). [DaprConfigAppId <String>]: Dapr application identifier [DaprConfigAppPort <Int32?>]: Tells Dapr which port your application is listening on [DaprConfigEnableApiLogging <Boolean?>]: Enables API logging for the Dapr sidecar [DaprConfigEnabled <Boolean?>]: Boolean indicating if the Dapr side car is enabled [DaprConfigHttpMaxRequestSize <Int32?>]: Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. [DaprConfigHttpReadBufferSize <Int32?>]: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. [DaprConfigLogLevel <DaprLogLevel?>]: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. [DnsConfigurationDnsAltServer <String>]: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. [DnsConfigurationDnsMaxCacheTimeout <Int32?>]: Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. [DnsConfigurationDnsRetryAttemptCount <Int32?>]: Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. [DnsConfigurationDnsRetryAttemptTimeout <Int32?>]: Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. [DnsConfigurationDnsServer <String[]>]: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. [Enabled <Boolean?>]: <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline). [ExtendedLocationName <String>]: Name of extended location. [HostNameSslState <IHostNameSslState[]>]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. [HostType <HostType?>]: Indicates whether the hostname is a standard or repository hostname. [Name <String>]: Hostname. [SslState <SslState?>]: SSL type. [Thumbprint <String>]: SSL certificate thumbprint. [ToUpdate <Boolean?>]: Set to <code>true</code> to update existing hostname. [VirtualIP <String>]: Virtual IP address assigned to the hostname if IP based SSL is enabled. [HostNamesDisabled <Boolean?>]: <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process. [HostingEnvironmentProfileId <String>]: Resource ID of the App Service Environment. [HttpPerInstanceConcurrency <Single?>]: The maximum number of concurrent HTTP trigger invocations per instance. [HttpsOnly <Boolean?>]: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests [HyperV <Boolean?>]: Hyper-V sandbox. [IdentityType <ManagedServiceIdentityType?>]: Type of managed service identity. [IdentityUserAssignedIdentity <IManagedServiceIdentityUserAssignedIdentities>]: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} [(Any) <IUserAssignedIdentity>]: This indicates any property can be added to this object. [IsXenon <Boolean?>]: Obsolete: Hyper-V sandbox. [KeyVaultReferenceIdentity <String>]: Identity to use for Key Vault Reference authentication. [ManagedEnvironmentId <String>]: Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} [PublicNetworkAccess <String>]: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. [RedundancyMode <RedundancyMode?>]: Site redundancy mode [Reserved <Boolean?>]: <code>true</code> if reserved; otherwise, <code>false</code>. [ResourceConfigCpu <Double?>]: Required CPU in cores, e.g. 0.5 [ResourceConfigMemory <String>]: Required memory, e.g. "1Gi" [RuntimeName <RuntimeName?>]: Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom [RuntimeVersion <String>]: Function app runtime version. Example: 8 (for dotnet-isolated) [ScaleAndConcurrencyAlwaysReady <IFunctionsAlwaysReadyConfig[]>]: 'Always Ready' configuration for the function app. [InstanceCount <Single?>]: Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready. [Name <String>]: Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. [ScaleAndConcurrencyInstanceMemoryMb <Single?>]: Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. [ScaleAndConcurrencyMaximumInstanceCount <Single?>]: The maximum number of instances for the function app. [ScmSiteAlsoStopped <Boolean?>]: <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. [ServerFarmId <String>]: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". [StorageAccountRequired <Boolean?>]: Checks if Customer provided storage account is required [StorageType <FunctionsDeploymentStorageType?>]: Property to select Azure Storage type. Available options: blobContainer. [StorageValue <String>]: Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://<storageAccountName>.blob.core.windows.net/<containerName>. [VirtualNetworkSubnetId <String>]: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} [VnetBackupRestoreEnabled <Boolean?>]: To enable Backup and Restore operations over virtual network [VnetContentShareEnabled <Boolean?>]: To enable accessing content over virtual network [VnetImagePullEnabled <Boolean?>]: To enable pulling image over Virtual Network [VnetRouteAllEnabled <Boolean?>]: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. [WorkloadProfileName <String>]: Workload profile name for function app to execute on. .Link https://learn.microsoft.com/powershell/module/az.functions/remove-azfunctionapp #> function Remove-AzFunctionApp { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='ByName', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='ByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] # The name of function app. ${Name}, [Parameter(ParameterSetName='ByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] ${ResourceGroupName}, [Parameter(ParameterSetName='ByName')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.DefaultInfo(Script='(Get-AzContext).Subscription.Id')] [System.String] # The Azure subscription ID. ${SubscriptionId}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.Management.Automation.SwitchParameter] # Forces the cmdlet to remove the function app without prompting for confirmation. ${Force}, [Parameter(ParameterSetName='ByObjectInput', Mandatory, ValueFromPipeline)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite] # To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ${InputObject}, [Parameter()] [Alias('AzureRMContext', 'AzureCredential')] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Azure')] [System.Management.Automation.PSObject] # The credentials, account, tenant, and subscription used for communication with Azure. ${DefaultProfile}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Returns true when the command succeeds. ${PassThru}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelinePrepend}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Uri] ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.PSCredential] ${ProxyCredential}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName if ($null -eq [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion) { [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion = $PSVersionTable.PSVersion.ToString() } $preTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId if ($preTelemetryId -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId =(New-Guid).ToString() [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Create', $MyInvocation, $parameterSet, $PSCmdlet) } else { $internalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets if ($internalCalledCmdlets -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $MyInvocation.MyCommand.Name } else { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets += ',' + $MyInvocation.MyCommand.Name } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = 'internal' } $mapping = @{ ByName = 'Az.Functions.custom\Remove-AzFunctionApp'; ByObjectInput = 'Az.Functions.custom\Remove-AzFunctionApp'; } if (('ByName') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $testPlayback = $false $PSBoundParameters['HttpPipelinePrepend'] | Foreach-Object { if ($_) { $testPlayback = $testPlayback -or ('Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.PipelineMock' -eq $_.Target.GetType().FullName -and 'Playback' -eq $_.Target.Mode) } } if ($testPlayback) { $PSBoundParameters['SubscriptionId'] = . (Join-Path $PSScriptRoot '..' 'utils' 'Get-SubscriptionIdTestSafe.ps1') } else { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id } } $cmdInfo = Get-Command -Name $mapping[$parameterSet] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessCustomAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) if ($null -ne $MyInvocation.MyCommand -and [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets -notcontains $MyInvocation.MyCommand.Name -and [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ContainsPreviewAttribute($cmdInfo, $MyInvocation)){ [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessPreviewMessageAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets.Enqueue($MyInvocation.MyCommand.Name) } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } process { try { $steppablePipeline.Process($_) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } finally { $backupTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId $backupInternalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } } end { try { $steppablePipeline.End() [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $backupTelemetryId [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $backupInternalCalledCmdlets if ($preTelemetryId -eq '') { [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Send', $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $preTelemetryId } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } } <# .Synopsis Deletes a function app plan. .Description Deletes a function app plan. .Example Get-AzFunctionAppPlan -Name MyAppName -ResourceGroupName MyResourceGroupName | Remove-AzFunctionAppPlan -Force .Example Remove-AzFunctionAppPlan -Name MyAppName -ResourceGroupName MyResourceGroupName -Force .Inputs Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IAppServicePlan .Outputs System.Boolean .Notes COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. INPUTOBJECT <IAppServicePlan>: Location <String>: Resource Location. [Kind <String>]: Kind of resource. [Tag <IResourceTags>]: Resource tags. [(Any) <String>]: This indicates any property can be added to this object. [Capacity <Int32?>]: Current number of instances assigned to the resource. [ElasticScaleEnabled <Boolean?>]: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku [ExtendedLocationName <String>]: Name of extended location. [FreeOfferExpirationTime <DateTime?>]: The time when the server farm free offer expires. [HostingEnvironmentProfileId <String>]: Resource ID of the App Service Environment. [HyperV <Boolean?>]: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise. [IsSpot <Boolean?>]: If <code>true</code>, this App Service Plan owns spot instances. [IsXenon <Boolean?>]: Obsolete: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise. [KubeEnvironmentProfileId <String>]: Resource ID of the Kubernetes Environment. [MaximumElasticWorkerCount <Int32?>]: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan [PerSiteScaling <Boolean?>]: If <code>true</code>, apps assigned to this App Service plan can be scaled independently. If <code>false</code>, apps assigned to this App Service plan will scale to all instances of the plan. [Reserved <Boolean?>]: If Linux app service plan <code>true</code>, <code>false</code> otherwise. [SkuCapability <ICapability[]>]: Capabilities of the SKU, e.g., is traffic manager enabled? [Name <String>]: Name of the SKU capability. [Reason <String>]: Reason of the SKU capability. [Value <String>]: Value of the SKU capability. [SkuCapacityDefault <Int32?>]: Default number of workers for this App Service plan SKU. [SkuCapacityElasticMaximum <Int32?>]: Maximum number of Elastic workers for this App Service plan SKU. [SkuCapacityMaximum <Int32?>]: Maximum number of workers for this App Service plan SKU. [SkuCapacityMinimum <Int32?>]: Minimum number of workers for this App Service plan SKU. [SkuCapacityScaleType <String>]: Available scale configurations for an App Service plan. [SkuFamily <String>]: Family code of the resource SKU. [SkuLocation <String[]>]: Locations of the SKU. [SkuName <String>]: Name of the resource SKU. [SkuSize <String>]: Size specifier of the resource SKU. [SkuTier <String>]: Service tier of the resource SKU. [SpotExpirationTime <DateTime?>]: The time when the server farm expires. Valid only if it is a spot server farm. [TargetWorkerCount <Int32?>]: Scaling worker count. [TargetWorkerSizeId <Int32?>]: Scaling worker size ID. [WorkerTierName <String>]: Target worker tier assigned to the App Service plan. [ZoneRedundant <Boolean?>]: If <code>true</code>, this App Service Plan will perform availability zone balancing. If <code>false</code>, this App Service Plan will not perform availability zone balancing. .Link https://learn.microsoft.com/powershell/module/az.functions/remove-azfunctionappplan #> function Remove-AzFunctionAppPlan { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='ByName', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='ByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] # The name of function app. ${Name}, [Parameter(ParameterSetName='ByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] ${ResourceGroupName}, [Parameter(ParameterSetName='ByName')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.DefaultInfo(Script='(Get-AzContext).Subscription.Id')] [System.String] # The Azure subscription ID. ${SubscriptionId}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.Management.Automation.SwitchParameter] # Forces the cmdlet to remove the function app plan without prompting for confirmation. ${Force}, [Parameter(ParameterSetName='ByObjectInput', Mandatory, ValueFromPipeline)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IAppServicePlan] # To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ${InputObject}, [Parameter()] [Alias('AzureRMContext', 'AzureCredential')] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Azure')] [System.Management.Automation.PSObject] # The credentials, account, tenant, and subscription used for communication with Azure. ${DefaultProfile}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Returns true when the command succeeds. ${PassThru}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${Break}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Uri] ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelinePrepend}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.PSCredential] ${ProxyCredential}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName if ($null -eq [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion) { [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion = $PSVersionTable.PSVersion.ToString() } $preTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId if ($preTelemetryId -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId =(New-Guid).ToString() [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Create', $MyInvocation, $parameterSet, $PSCmdlet) } else { $internalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets if ($internalCalledCmdlets -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $MyInvocation.MyCommand.Name } else { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets += ',' + $MyInvocation.MyCommand.Name } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = 'internal' } $mapping = @{ ByName = 'Az.Functions.custom\Remove-AzFunctionAppPlan'; ByObjectInput = 'Az.Functions.custom\Remove-AzFunctionAppPlan'; } if (('ByName') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $testPlayback = $false $PSBoundParameters['HttpPipelinePrepend'] | Foreach-Object { if ($_) { $testPlayback = $testPlayback -or ('Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.PipelineMock' -eq $_.Target.GetType().FullName -and 'Playback' -eq $_.Target.Mode) } } if ($testPlayback) { $PSBoundParameters['SubscriptionId'] = . (Join-Path $PSScriptRoot '..' 'utils' 'Get-SubscriptionIdTestSafe.ps1') } else { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id } } $cmdInfo = Get-Command -Name $mapping[$parameterSet] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessCustomAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) if ($null -ne $MyInvocation.MyCommand -and [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets -notcontains $MyInvocation.MyCommand.Name -and [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ContainsPreviewAttribute($cmdInfo, $MyInvocation)){ [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessPreviewMessageAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets.Enqueue($MyInvocation.MyCommand.Name) } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } process { try { $steppablePipeline.Process($_) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } finally { $backupTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId $backupInternalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } } end { try { $steppablePipeline.End() [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $backupTelemetryId [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $backupInternalCalledCmdlets if ($preTelemetryId -eq '') { [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Send', $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $preTelemetryId } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } } <# .Synopsis Removes app settings from a function app. .Description Removes app settings from a function app. .Example Remove-AzFunctionAppSetting -Name MyAppName -ResourceGroupName MyResourceGroupName -AppSettingName "MyAppSetting1", "MyAppSetting2" .Inputs Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite .Outputs Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IStringDictionary .Notes COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. INPUTOBJECT <ISite>: Location <String>: Resource Location. [Kind <String>]: Kind of resource. [Tag <IResourceTags>]: Resource tags. [(Any) <String>]: This indicates any property can be added to this object. [AuthenticationStorageAccountConnectionStringName <String>]: Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. [AuthenticationType <AuthenticationType?>]: Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. [AuthenticationUserAssignedIdentityResourceId <String>]: Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. [ClientAffinityEnabled <Boolean?>]: <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>. [ClientCertEnabled <Boolean?>]: <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. [ClientCertExclusionPath <String>]: client certificate authentication comma-separated exclusion paths [ClientCertMode <ClientCertMode?>]: This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. [CloningInfoAppSettingsOverride <ICloningInfoAppSettingsOverrides>]: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. [(Any) <String>]: This indicates any property can be added to this object. [CloningInfoCloneCustomHostName <Boolean?>]: <code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>. [CloningInfoCloneSourceControl <Boolean?>]: <code>true</code> to clone source control from source app; otherwise, <code>false</code>. [CloningInfoConfigureLoadBalancing <Boolean?>]: <code>true</code> to configure load balancing for source and destination app. [CloningInfoCorrelationId <String>]: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. [CloningInfoHostingEnvironment <String>]: App Service Environment. [CloningInfoOverwrite <Boolean?>]: <code>true</code> to overwrite destination app; otherwise, <code>false</code>. [CloningInfoSourceWebAppId <String>]: ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. [CloningInfoSourceWebAppLocation <String>]: Location of source app ex: West US or North Europe [CloningInfoTrafficManagerProfileId <String>]: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. [CloningInfoTrafficManagerProfileName <String>]: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. [Config <ISiteConfig>]: Configuration of the app. [AcrUseManagedIdentityCred <Boolean?>]: Flag to use Managed Identity Creds for ACR pull [AcrUserManagedIdentityId <String>]: If using user managed identity, the user managed identity ClientId [ActionMinProcessExecutionTime <String>]: Minimum time the process must execute before taking the action [ActionType <AutoHealActionType?>]: Predefined action to be taken. [AlwaysOn <Boolean?>]: <code>true</code> if Always On is enabled; otherwise, <code>false</code>. [ApiDefinitionUrl <String>]: The URL of the API definition. [ApiManagementConfigId <String>]: APIM-Api Identifier. [AppCommandLine <String>]: App command line to launch. [AppSetting <INameValuePair[]>]: Application settings. [Name <String>]: Pair name. [Value <String>]: Pair value. [AutoHealEnabled <Boolean?>]: <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. [AutoSwapSlotName <String>]: Auto-swap slot name. [AzureStorageAccount <ISiteConfigAzureStorageAccounts>]: List of Azure Storage Accounts. [(Any) <IAzureStorageInfoValue>]: This indicates any property can be added to this object. [ConnectionString <IConnStringInfo[]>]: Connection strings. [ConnectionString <String>]: Connection string value. [Name <String>]: Name of connection string. [Type <ConnectionStringType?>]: Type of database. [CorAllowedOrigin <String[]>]: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. [CorSupportCredentials <Boolean?>]: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. [CustomActionExe <String>]: Executable to be run. [CustomActionParameter <String>]: Parameters for the executable. [DefaultDocument <String[]>]: Default documents. [DetailedErrorLoggingEnabled <Boolean?>]: <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. [DocumentRoot <String>]: Document root. [DynamicTagsJson <String>]: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. [ElasticWebAppScaleLimit <Int32?>]: Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is <code>true</code> [ExperimentRampUpRule <IRampUpRule[]>]: List of ramp-up rules. [ActionHostName <String>]: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. [ChangeDecisionCallbackUrl <String>]: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/ [ChangeIntervalInMinute <Int32?>]: Specifies interval in minutes to reevaluate ReroutePercentage. [ChangeStep <Double?>]: In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>. [MaxReroutePercentage <Double?>]: Specifies upper boundary below which ReroutePercentage will stay. [MinReroutePercentage <Double?>]: Specifies lower boundary above which ReroutePercentage will stay. [Name <String>]: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. [ReroutePercentage <Double?>]: Percentage of the traffic which will be redirected to <code>ActionHostName</code>. [FtpsState <FtpsState?>]: State of FTP / FTPS service [FunctionAppScaleLimit <Int32?>]: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans [FunctionsRuntimeScaleMonitoringEnabled <Boolean?>]: Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status. [HandlerMapping <IHandlerMapping[]>]: Handler mappings. [Argument <String>]: Command-line arguments to be passed to the script processor. [Extension <String>]: Requests with this extension will be handled using the specified FastCGI application. [ScriptProcessor <String>]: The absolute path to the FastCGI application. [HealthCheckPath <String>]: Health check path [Http20Enabled <Boolean?>]: Http20Enabled: configures a web site to allow clients to connect over http2.0 [HttpLoggingEnabled <Boolean?>]: <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. [IPSecurityRestriction <IIPSecurityRestriction[]>]: IP security restrictions for main. [Action <String>]: Allow or Deny access for this IP range. [Description <String>]: IP restriction rule description. [Header <IIPSecurityRestrictionHeaders>]: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. [(Any) <String[]>]: This indicates any property can be added to this object. [IPAddress <String>]: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. [Name <String>]: IP restriction rule name. [Priority <Int32?>]: Priority of IP restriction rule. [SubnetMask <String>]: Subnet mask for the range of IP addresses the restriction is valid for. [SubnetTrafficTag <Int32?>]: (internal) Subnet traffic tag [Tag <IPFilterTag?>]: Defines what this IP filter will be used for. This is to support IP filtering on proxies. [VnetSubnetResourceId <String>]: Virtual network resource id [VnetTrafficTag <Int32?>]: (internal) Vnet traffic tag [IPSecurityRestrictionsDefaultAction <DefaultAction?>]: Default action for main access restriction if no rules are matched. [IsPushEnabled <Boolean?>]: Gets or sets a flag indicating whether the Push endpoint is enabled. [JavaContainer <String>]: Java container. [JavaContainerVersion <String>]: Java container version. [JavaVersion <String>]: Java version. [KeyVaultReferenceIdentity <String>]: Identity to use for Key Vault Reference authentication. [LimitMaxDiskSizeInMb <Int64?>]: Maximum allowed disk size usage in MB. [LimitMaxMemoryInMb <Int64?>]: Maximum allowed memory usage in MB. [LimitMaxPercentageCpu <Double?>]: Maximum allowed CPU usage percentage. [LinuxFxVersion <String>]: Linux App Framework and version [LoadBalancing <SiteLoadBalancing?>]: Site load balancing. [LocalMySqlEnabled <Boolean?>]: <code>true</code> to enable local MySQL; otherwise, <code>false</code>. [LogsDirectorySizeLimit <Int32?>]: HTTP logs directory size limit. [MachineKeyDecryption <String>]: Algorithm used for decryption. [MachineKeyDecryptionKey <String>]: Decryption key. [MachineKeyValidation <String>]: MachineKey validation. [MachineKeyValidationKey <String>]: Validation key. [ManagedPipelineMode <ManagedPipelineMode?>]: Managed pipeline mode. [ManagedServiceIdentityId <Int32?>]: Managed Service Identity Id [Metadata <INameValuePair[]>]: Application metadata. This property cannot be retrieved, since it may contain secrets. [MinTlsCipherSuite <TlsCipherSuites?>]: The minimum strength TLS cipher suite allowed for an application [MinTlsVersion <SupportedTlsVersions?>]: MinTlsVersion: configures the minimum version of TLS required for SSL requests [MinimumElasticInstanceCount <Int32?>]: Number of minimum instance count for a site This setting only applies to the Elastic Plans [NetFrameworkVersion <String>]: .NET Framework version. [NodeVersion <String>]: Version of Node.js. [NumberOfWorker <Int32?>]: Number of workers. [PhpVersion <String>]: Version of PHP. [PowerShellVersion <String>]: Version of PowerShell. [PreWarmedInstanceCount <Int32?>]: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans [PublicNetworkAccess <String>]: Property to allow or block all public traffic. [PublishingUsername <String>]: Publishing user name. [PushKind <String>]: Kind of resource. [PythonVersion <String>]: Version of Python. [RemoteDebuggingEnabled <Boolean?>]: <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. [RemoteDebuggingVersion <String>]: Remote debugging version. [RequestCount <Int32?>]: Request Count. [RequestTimeInterval <String>]: Time interval. [RequestTracingEnabled <Boolean?>]: <code>true</code> if request tracing is enabled; otherwise, <code>false</code>. [RequestTracingExpirationTime <DateTime?>]: Request tracing expiration time. [ScmIPSecurityRestriction <IIPSecurityRestriction[]>]: IP security restrictions for scm. [ScmIPSecurityRestrictionsDefaultAction <DefaultAction?>]: Default action for scm access restriction if no rules are matched. [ScmIPSecurityRestrictionsUseMain <Boolean?>]: IP security restrictions for scm to use main. [ScmMinTlsVersion <SupportedTlsVersions?>]: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site [ScmType <ScmType?>]: SCM type. [SlowRequestCount <Int32?>]: Request Count. [SlowRequestPath <String>]: Request Path. [SlowRequestTimeInterval <String>]: Time interval. [SlowRequestTimeTaken <String>]: Time taken. [TagWhitelistJson <String>]: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. [TagsRequiringAuth <String>]: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. [TracingOption <String>]: Tracing options. [TriggerPrivateBytesInKb <Int32?>]: A rule based on private bytes. [TriggerSlowRequestsWithPath <ISlowRequestsBasedTrigger[]>]: A rule based on multiple Slow Requests Rule with path [Count <Int32?>]: Request Count. [Path <String>]: Request Path. [TimeInterval <String>]: Time interval. [TimeTaken <String>]: Time taken. [TriggerStatusCode <IStatusCodesBasedTrigger[]>]: A rule based on status codes. [Count <Int32?>]: Request Count. [Path <String>]: Request Path [Status <Int32?>]: HTTP status code. [SubStatus <Int32?>]: Request Sub Status. [TimeInterval <String>]: Time interval. [Win32Status <Int32?>]: Win32 error code. [TriggerStatusCodesRange <IStatusCodesRangeBasedTrigger[]>]: A rule based on status codes ranges. [Count <Int32?>]: Request Count. [Path <String>]: [StatusCode <String>]: HTTP status code. [TimeInterval <String>]: Time interval. [Use32BitWorkerProcess <Boolean?>]: <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. [VirtualApplication <IVirtualApplication[]>]: Virtual applications. [PhysicalPath <String>]: Physical path. [PreloadEnabled <Boolean?>]: <code>true</code> if preloading is enabled; otherwise, <code>false</code>. [VirtualDirectory <IVirtualDirectory[]>]: Virtual directories for virtual application. [PhysicalPath <String>]: Physical path. [VirtualPath <String>]: Path to virtual application. [VirtualPath <String>]: Virtual path. [VnetName <String>]: Virtual Network name. [VnetPrivatePortsCount <Int32?>]: The number of private ports assigned to this app. These will be assigned dynamically on runtime. [VnetRouteAllEnabled <Boolean?>]: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. [WebSocketsEnabled <Boolean?>]: <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. [WebsiteTimeZone <String>]: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones [WindowsFxVersion <String>]: Xenon App Framework and version [XManagedServiceIdentityId <Int32?>]: Explicit Managed Service Identity Id [ContainerSize <Int32?>]: Size of the function container. [CustomDomainVerificationId <String>]: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. [DailyMemoryTimeQuota <Int32?>]: Maximum allowed daily memory-time quota (applicable on dynamic apps only). [DaprConfigAppId <String>]: Dapr application identifier [DaprConfigAppPort <Int32?>]: Tells Dapr which port your application is listening on [DaprConfigEnableApiLogging <Boolean?>]: Enables API logging for the Dapr sidecar [DaprConfigEnabled <Boolean?>]: Boolean indicating if the Dapr side car is enabled [DaprConfigHttpMaxRequestSize <Int32?>]: Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. [DaprConfigHttpReadBufferSize <Int32?>]: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. [DaprConfigLogLevel <DaprLogLevel?>]: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. [DnsConfigurationDnsAltServer <String>]: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. [DnsConfigurationDnsMaxCacheTimeout <Int32?>]: Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. [DnsConfigurationDnsRetryAttemptCount <Int32?>]: Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. [DnsConfigurationDnsRetryAttemptTimeout <Int32?>]: Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. [DnsConfigurationDnsServer <String[]>]: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. [Enabled <Boolean?>]: <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline). [ExtendedLocationName <String>]: Name of extended location. [HostNameSslState <IHostNameSslState[]>]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. [HostType <HostType?>]: Indicates whether the hostname is a standard or repository hostname. [Name <String>]: Hostname. [SslState <SslState?>]: SSL type. [Thumbprint <String>]: SSL certificate thumbprint. [ToUpdate <Boolean?>]: Set to <code>true</code> to update existing hostname. [VirtualIP <String>]: Virtual IP address assigned to the hostname if IP based SSL is enabled. [HostNamesDisabled <Boolean?>]: <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process. [HostingEnvironmentProfileId <String>]: Resource ID of the App Service Environment. [HttpPerInstanceConcurrency <Single?>]: The maximum number of concurrent HTTP trigger invocations per instance. [HttpsOnly <Boolean?>]: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests [HyperV <Boolean?>]: Hyper-V sandbox. [IdentityType <ManagedServiceIdentityType?>]: Type of managed service identity. [IdentityUserAssignedIdentity <IManagedServiceIdentityUserAssignedIdentities>]: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} [(Any) <IUserAssignedIdentity>]: This indicates any property can be added to this object. [IsXenon <Boolean?>]: Obsolete: Hyper-V sandbox. [KeyVaultReferenceIdentity <String>]: Identity to use for Key Vault Reference authentication. [ManagedEnvironmentId <String>]: Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} [PublicNetworkAccess <String>]: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. [RedundancyMode <RedundancyMode?>]: Site redundancy mode [Reserved <Boolean?>]: <code>true</code> if reserved; otherwise, <code>false</code>. [ResourceConfigCpu <Double?>]: Required CPU in cores, e.g. 0.5 [ResourceConfigMemory <String>]: Required memory, e.g. "1Gi" [RuntimeName <RuntimeName?>]: Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom [RuntimeVersion <String>]: Function app runtime version. Example: 8 (for dotnet-isolated) [ScaleAndConcurrencyAlwaysReady <IFunctionsAlwaysReadyConfig[]>]: 'Always Ready' configuration for the function app. [InstanceCount <Single?>]: Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready. [Name <String>]: Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. [ScaleAndConcurrencyInstanceMemoryMb <Single?>]: Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. [ScaleAndConcurrencyMaximumInstanceCount <Single?>]: The maximum number of instances for the function app. [ScmSiteAlsoStopped <Boolean?>]: <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. [ServerFarmId <String>]: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". [StorageAccountRequired <Boolean?>]: Checks if Customer provided storage account is required [StorageType <FunctionsDeploymentStorageType?>]: Property to select Azure Storage type. Available options: blobContainer. [StorageValue <String>]: Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://<storageAccountName>.blob.core.windows.net/<containerName>. [VirtualNetworkSubnetId <String>]: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} [VnetBackupRestoreEnabled <Boolean?>]: To enable Backup and Restore operations over virtual network [VnetContentShareEnabled <Boolean?>]: To enable accessing content over virtual network [VnetImagePullEnabled <Boolean?>]: To enable pulling image over Virtual Network [VnetRouteAllEnabled <Boolean?>]: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. [WorkloadProfileName <String>]: Workload profile name for function app to execute on. .Link https://learn.microsoft.com/powershell/module/az.functions/remove-azfunctionappsetting #> function Remove-AzFunctionAppSetting { [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IStringDictionary])] [CmdletBinding(DefaultParameterSetName='ByName', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='ByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] # Name of the function app. ${Name}, [Parameter(ParameterSetName='ByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] # Name of the resource group to which the resource belongs. ${ResourceGroupName}, [Parameter(ParameterSetName='ByName')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.DefaultInfo(Script='(Get-AzContext).Subscription.Id')] [System.String] # The Azure subscription ID. ${SubscriptionId}, [Parameter(Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String[]] # List of function app settings to be removed from the function app. ${AppSettingName}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.Management.Automation.SwitchParameter] # Forces the cmdlet to remove function app setting without prompting for confirmation. ${Force}, [Parameter(ParameterSetName='ByObjectInput', Mandatory, ValueFromPipeline)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite] # To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ${InputObject}, [Parameter()] [Alias('AzureRMContext', 'AzureCredential')] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Azure')] [System.Management.Automation.PSObject] ${DefaultProfile}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelinePrepend}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Uri] ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.PSCredential] ${ProxyCredential}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName if ($null -eq [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion) { [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion = $PSVersionTable.PSVersion.ToString() } $preTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId if ($preTelemetryId -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId =(New-Guid).ToString() [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Create', $MyInvocation, $parameterSet, $PSCmdlet) } else { $internalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets if ($internalCalledCmdlets -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $MyInvocation.MyCommand.Name } else { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets += ',' + $MyInvocation.MyCommand.Name } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = 'internal' } $mapping = @{ ByName = 'Az.Functions.custom\Remove-AzFunctionAppSetting'; ByObjectInput = 'Az.Functions.custom\Remove-AzFunctionAppSetting'; } if (('ByName') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $testPlayback = $false $PSBoundParameters['HttpPipelinePrepend'] | Foreach-Object { if ($_) { $testPlayback = $testPlayback -or ('Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.PipelineMock' -eq $_.Target.GetType().FullName -and 'Playback' -eq $_.Target.Mode) } } if ($testPlayback) { $PSBoundParameters['SubscriptionId'] = . (Join-Path $PSScriptRoot '..' 'utils' 'Get-SubscriptionIdTestSafe.ps1') } else { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id } } $cmdInfo = Get-Command -Name $mapping[$parameterSet] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessCustomAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) if ($null -ne $MyInvocation.MyCommand -and [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets -notcontains $MyInvocation.MyCommand.Name -and [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ContainsPreviewAttribute($cmdInfo, $MyInvocation)){ [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessPreviewMessageAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets.Enqueue($MyInvocation.MyCommand.Name) } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } process { try { $steppablePipeline.Process($_) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } finally { $backupTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId $backupInternalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } } end { try { $steppablePipeline.End() [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $backupTelemetryId [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $backupInternalCalledCmdlets if ($preTelemetryId -eq '') { [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Send', $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $preTelemetryId } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } } <# .Synopsis Restarts a function app. .Description Restarts a function app. .Example Get-AzFunctionApp -Name MyAppName -ResourceGroupName MyResourceGroupName | Restart-AzFunctionApp -Force .Example Restart-AzFunctionApp -Name MyAppName -ResourceGroupName MyResourceGroupName -Force .Inputs Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite .Outputs System.Boolean .Notes COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. INPUTOBJECT <ISite>: Location <String>: Resource Location. [Kind <String>]: Kind of resource. [Tag <IResourceTags>]: Resource tags. [(Any) <String>]: This indicates any property can be added to this object. [AuthenticationStorageAccountConnectionStringName <String>]: Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. [AuthenticationType <AuthenticationType?>]: Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. [AuthenticationUserAssignedIdentityResourceId <String>]: Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. [ClientAffinityEnabled <Boolean?>]: <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>. [ClientCertEnabled <Boolean?>]: <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. [ClientCertExclusionPath <String>]: client certificate authentication comma-separated exclusion paths [ClientCertMode <ClientCertMode?>]: This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. [CloningInfoAppSettingsOverride <ICloningInfoAppSettingsOverrides>]: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. [(Any) <String>]: This indicates any property can be added to this object. [CloningInfoCloneCustomHostName <Boolean?>]: <code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>. [CloningInfoCloneSourceControl <Boolean?>]: <code>true</code> to clone source control from source app; otherwise, <code>false</code>. [CloningInfoConfigureLoadBalancing <Boolean?>]: <code>true</code> to configure load balancing for source and destination app. [CloningInfoCorrelationId <String>]: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. [CloningInfoHostingEnvironment <String>]: App Service Environment. [CloningInfoOverwrite <Boolean?>]: <code>true</code> to overwrite destination app; otherwise, <code>false</code>. [CloningInfoSourceWebAppId <String>]: ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. [CloningInfoSourceWebAppLocation <String>]: Location of source app ex: West US or North Europe [CloningInfoTrafficManagerProfileId <String>]: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. [CloningInfoTrafficManagerProfileName <String>]: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. [Config <ISiteConfig>]: Configuration of the app. [AcrUseManagedIdentityCred <Boolean?>]: Flag to use Managed Identity Creds for ACR pull [AcrUserManagedIdentityId <String>]: If using user managed identity, the user managed identity ClientId [ActionMinProcessExecutionTime <String>]: Minimum time the process must execute before taking the action [ActionType <AutoHealActionType?>]: Predefined action to be taken. [AlwaysOn <Boolean?>]: <code>true</code> if Always On is enabled; otherwise, <code>false</code>. [ApiDefinitionUrl <String>]: The URL of the API definition. [ApiManagementConfigId <String>]: APIM-Api Identifier. [AppCommandLine <String>]: App command line to launch. [AppSetting <INameValuePair[]>]: Application settings. [Name <String>]: Pair name. [Value <String>]: Pair value. [AutoHealEnabled <Boolean?>]: <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. [AutoSwapSlotName <String>]: Auto-swap slot name. [AzureStorageAccount <ISiteConfigAzureStorageAccounts>]: List of Azure Storage Accounts. [(Any) <IAzureStorageInfoValue>]: This indicates any property can be added to this object. [ConnectionString <IConnStringInfo[]>]: Connection strings. [ConnectionString <String>]: Connection string value. [Name <String>]: Name of connection string. [Type <ConnectionStringType?>]: Type of database. [CorAllowedOrigin <String[]>]: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. [CorSupportCredentials <Boolean?>]: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. [CustomActionExe <String>]: Executable to be run. [CustomActionParameter <String>]: Parameters for the executable. [DefaultDocument <String[]>]: Default documents. [DetailedErrorLoggingEnabled <Boolean?>]: <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. [DocumentRoot <String>]: Document root. [DynamicTagsJson <String>]: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. [ElasticWebAppScaleLimit <Int32?>]: Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is <code>true</code> [ExperimentRampUpRule <IRampUpRule[]>]: List of ramp-up rules. [ActionHostName <String>]: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. [ChangeDecisionCallbackUrl <String>]: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/ [ChangeIntervalInMinute <Int32?>]: Specifies interval in minutes to reevaluate ReroutePercentage. [ChangeStep <Double?>]: In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>. [MaxReroutePercentage <Double?>]: Specifies upper boundary below which ReroutePercentage will stay. [MinReroutePercentage <Double?>]: Specifies lower boundary above which ReroutePercentage will stay. [Name <String>]: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. [ReroutePercentage <Double?>]: Percentage of the traffic which will be redirected to <code>ActionHostName</code>. [FtpsState <FtpsState?>]: State of FTP / FTPS service [FunctionAppScaleLimit <Int32?>]: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans [FunctionsRuntimeScaleMonitoringEnabled <Boolean?>]: Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status. [HandlerMapping <IHandlerMapping[]>]: Handler mappings. [Argument <String>]: Command-line arguments to be passed to the script processor. [Extension <String>]: Requests with this extension will be handled using the specified FastCGI application. [ScriptProcessor <String>]: The absolute path to the FastCGI application. [HealthCheckPath <String>]: Health check path [Http20Enabled <Boolean?>]: Http20Enabled: configures a web site to allow clients to connect over http2.0 [HttpLoggingEnabled <Boolean?>]: <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. [IPSecurityRestriction <IIPSecurityRestriction[]>]: IP security restrictions for main. [Action <String>]: Allow or Deny access for this IP range. [Description <String>]: IP restriction rule description. [Header <IIPSecurityRestrictionHeaders>]: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. [(Any) <String[]>]: This indicates any property can be added to this object. [IPAddress <String>]: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. [Name <String>]: IP restriction rule name. [Priority <Int32?>]: Priority of IP restriction rule. [SubnetMask <String>]: Subnet mask for the range of IP addresses the restriction is valid for. [SubnetTrafficTag <Int32?>]: (internal) Subnet traffic tag [Tag <IPFilterTag?>]: Defines what this IP filter will be used for. This is to support IP filtering on proxies. [VnetSubnetResourceId <String>]: Virtual network resource id [VnetTrafficTag <Int32?>]: (internal) Vnet traffic tag [IPSecurityRestrictionsDefaultAction <DefaultAction?>]: Default action for main access restriction if no rules are matched. [IsPushEnabled <Boolean?>]: Gets or sets a flag indicating whether the Push endpoint is enabled. [JavaContainer <String>]: Java container. [JavaContainerVersion <String>]: Java container version. [JavaVersion <String>]: Java version. [KeyVaultReferenceIdentity <String>]: Identity to use for Key Vault Reference authentication. [LimitMaxDiskSizeInMb <Int64?>]: Maximum allowed disk size usage in MB. [LimitMaxMemoryInMb <Int64?>]: Maximum allowed memory usage in MB. [LimitMaxPercentageCpu <Double?>]: Maximum allowed CPU usage percentage. [LinuxFxVersion <String>]: Linux App Framework and version [LoadBalancing <SiteLoadBalancing?>]: Site load balancing. [LocalMySqlEnabled <Boolean?>]: <code>true</code> to enable local MySQL; otherwise, <code>false</code>. [LogsDirectorySizeLimit <Int32?>]: HTTP logs directory size limit. [MachineKeyDecryption <String>]: Algorithm used for decryption. [MachineKeyDecryptionKey <String>]: Decryption key. [MachineKeyValidation <String>]: MachineKey validation. [MachineKeyValidationKey <String>]: Validation key. [ManagedPipelineMode <ManagedPipelineMode?>]: Managed pipeline mode. [ManagedServiceIdentityId <Int32?>]: Managed Service Identity Id [Metadata <INameValuePair[]>]: Application metadata. This property cannot be retrieved, since it may contain secrets. [MinTlsCipherSuite <TlsCipherSuites?>]: The minimum strength TLS cipher suite allowed for an application [MinTlsVersion <SupportedTlsVersions?>]: MinTlsVersion: configures the minimum version of TLS required for SSL requests [MinimumElasticInstanceCount <Int32?>]: Number of minimum instance count for a site This setting only applies to the Elastic Plans [NetFrameworkVersion <String>]: .NET Framework version. [NodeVersion <String>]: Version of Node.js. [NumberOfWorker <Int32?>]: Number of workers. [PhpVersion <String>]: Version of PHP. [PowerShellVersion <String>]: Version of PowerShell. [PreWarmedInstanceCount <Int32?>]: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans [PublicNetworkAccess <String>]: Property to allow or block all public traffic. [PublishingUsername <String>]: Publishing user name. [PushKind <String>]: Kind of resource. [PythonVersion <String>]: Version of Python. [RemoteDebuggingEnabled <Boolean?>]: <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. [RemoteDebuggingVersion <String>]: Remote debugging version. [RequestCount <Int32?>]: Request Count. [RequestTimeInterval <String>]: Time interval. [RequestTracingEnabled <Boolean?>]: <code>true</code> if request tracing is enabled; otherwise, <code>false</code>. [RequestTracingExpirationTime <DateTime?>]: Request tracing expiration time. [ScmIPSecurityRestriction <IIPSecurityRestriction[]>]: IP security restrictions for scm. [ScmIPSecurityRestrictionsDefaultAction <DefaultAction?>]: Default action for scm access restriction if no rules are matched. [ScmIPSecurityRestrictionsUseMain <Boolean?>]: IP security restrictions for scm to use main. [ScmMinTlsVersion <SupportedTlsVersions?>]: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site [ScmType <ScmType?>]: SCM type. [SlowRequestCount <Int32?>]: Request Count. [SlowRequestPath <String>]: Request Path. [SlowRequestTimeInterval <String>]: Time interval. [SlowRequestTimeTaken <String>]: Time taken. [TagWhitelistJson <String>]: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. [TagsRequiringAuth <String>]: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. [TracingOption <String>]: Tracing options. [TriggerPrivateBytesInKb <Int32?>]: A rule based on private bytes. [TriggerSlowRequestsWithPath <ISlowRequestsBasedTrigger[]>]: A rule based on multiple Slow Requests Rule with path [Count <Int32?>]: Request Count. [Path <String>]: Request Path. [TimeInterval <String>]: Time interval. [TimeTaken <String>]: Time taken. [TriggerStatusCode <IStatusCodesBasedTrigger[]>]: A rule based on status codes. [Count <Int32?>]: Request Count. [Path <String>]: Request Path [Status <Int32?>]: HTTP status code. [SubStatus <Int32?>]: Request Sub Status. [TimeInterval <String>]: Time interval. [Win32Status <Int32?>]: Win32 error code. [TriggerStatusCodesRange <IStatusCodesRangeBasedTrigger[]>]: A rule based on status codes ranges. [Count <Int32?>]: Request Count. [Path <String>]: [StatusCode <String>]: HTTP status code. [TimeInterval <String>]: Time interval. [Use32BitWorkerProcess <Boolean?>]: <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. [VirtualApplication <IVirtualApplication[]>]: Virtual applications. [PhysicalPath <String>]: Physical path. [PreloadEnabled <Boolean?>]: <code>true</code> if preloading is enabled; otherwise, <code>false</code>. [VirtualDirectory <IVirtualDirectory[]>]: Virtual directories for virtual application. [PhysicalPath <String>]: Physical path. [VirtualPath <String>]: Path to virtual application. [VirtualPath <String>]: Virtual path. [VnetName <String>]: Virtual Network name. [VnetPrivatePortsCount <Int32?>]: The number of private ports assigned to this app. These will be assigned dynamically on runtime. [VnetRouteAllEnabled <Boolean?>]: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. [WebSocketsEnabled <Boolean?>]: <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. [WebsiteTimeZone <String>]: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones [WindowsFxVersion <String>]: Xenon App Framework and version [XManagedServiceIdentityId <Int32?>]: Explicit Managed Service Identity Id [ContainerSize <Int32?>]: Size of the function container. [CustomDomainVerificationId <String>]: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. [DailyMemoryTimeQuota <Int32?>]: Maximum allowed daily memory-time quota (applicable on dynamic apps only). [DaprConfigAppId <String>]: Dapr application identifier [DaprConfigAppPort <Int32?>]: Tells Dapr which port your application is listening on [DaprConfigEnableApiLogging <Boolean?>]: Enables API logging for the Dapr sidecar [DaprConfigEnabled <Boolean?>]: Boolean indicating if the Dapr side car is enabled [DaprConfigHttpMaxRequestSize <Int32?>]: Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. [DaprConfigHttpReadBufferSize <Int32?>]: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. [DaprConfigLogLevel <DaprLogLevel?>]: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. [DnsConfigurationDnsAltServer <String>]: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. [DnsConfigurationDnsMaxCacheTimeout <Int32?>]: Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. [DnsConfigurationDnsRetryAttemptCount <Int32?>]: Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. [DnsConfigurationDnsRetryAttemptTimeout <Int32?>]: Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. [DnsConfigurationDnsServer <String[]>]: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. [Enabled <Boolean?>]: <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline). [ExtendedLocationName <String>]: Name of extended location. [HostNameSslState <IHostNameSslState[]>]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. [HostType <HostType?>]: Indicates whether the hostname is a standard or repository hostname. [Name <String>]: Hostname. [SslState <SslState?>]: SSL type. [Thumbprint <String>]: SSL certificate thumbprint. [ToUpdate <Boolean?>]: Set to <code>true</code> to update existing hostname. [VirtualIP <String>]: Virtual IP address assigned to the hostname if IP based SSL is enabled. [HostNamesDisabled <Boolean?>]: <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process. [HostingEnvironmentProfileId <String>]: Resource ID of the App Service Environment. [HttpPerInstanceConcurrency <Single?>]: The maximum number of concurrent HTTP trigger invocations per instance. [HttpsOnly <Boolean?>]: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests [HyperV <Boolean?>]: Hyper-V sandbox. [IdentityType <ManagedServiceIdentityType?>]: Type of managed service identity. [IdentityUserAssignedIdentity <IManagedServiceIdentityUserAssignedIdentities>]: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} [(Any) <IUserAssignedIdentity>]: This indicates any property can be added to this object. [IsXenon <Boolean?>]: Obsolete: Hyper-V sandbox. [KeyVaultReferenceIdentity <String>]: Identity to use for Key Vault Reference authentication. [ManagedEnvironmentId <String>]: Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} [PublicNetworkAccess <String>]: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. [RedundancyMode <RedundancyMode?>]: Site redundancy mode [Reserved <Boolean?>]: <code>true</code> if reserved; otherwise, <code>false</code>. [ResourceConfigCpu <Double?>]: Required CPU in cores, e.g. 0.5 [ResourceConfigMemory <String>]: Required memory, e.g. "1Gi" [RuntimeName <RuntimeName?>]: Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom [RuntimeVersion <String>]: Function app runtime version. Example: 8 (for dotnet-isolated) [ScaleAndConcurrencyAlwaysReady <IFunctionsAlwaysReadyConfig[]>]: 'Always Ready' configuration for the function app. [InstanceCount <Single?>]: Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready. [Name <String>]: Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. [ScaleAndConcurrencyInstanceMemoryMb <Single?>]: Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. [ScaleAndConcurrencyMaximumInstanceCount <Single?>]: The maximum number of instances for the function app. [ScmSiteAlsoStopped <Boolean?>]: <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. [ServerFarmId <String>]: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". [StorageAccountRequired <Boolean?>]: Checks if Customer provided storage account is required [StorageType <FunctionsDeploymentStorageType?>]: Property to select Azure Storage type. Available options: blobContainer. [StorageValue <String>]: Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://<storageAccountName>.blob.core.windows.net/<containerName>. [VirtualNetworkSubnetId <String>]: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} [VnetBackupRestoreEnabled <Boolean?>]: To enable Backup and Restore operations over virtual network [VnetContentShareEnabled <Boolean?>]: To enable accessing content over virtual network [VnetImagePullEnabled <Boolean?>]: To enable pulling image over Virtual Network [VnetRouteAllEnabled <Boolean?>]: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. [WorkloadProfileName <String>]: Workload profile name for function app to execute on. .Link https://learn.microsoft.com/powershell/module/az.functions/restart-azfunctionapp #> function Restart-AzFunctionApp { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='RestartByName', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='RestartByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] # The name of function app. ${Name}, [Parameter(ParameterSetName='RestartByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] ${ResourceGroupName}, [Parameter(ParameterSetName='RestartByName')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.DefaultInfo(Script='(Get-AzContext).Subscription.Id')] [System.String] # The Azure subscription ID. ${SubscriptionId}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.Management.Automation.SwitchParameter] # Forces the cmdlet to restart the function app without prompting for confirmation. ${Force}, [Parameter(ParameterSetName='ByObjectInput', Mandatory, ValueFromPipeline)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite] # To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ${InputObject}, [Parameter()] [Alias('AzureRMContext', 'AzureCredential')] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Azure')] [System.Management.Automation.PSObject] # The credentials, account, tenant, and subscription used for communication with Azure. ${DefaultProfile}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Returns true when the command succeeds. ${PassThru}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelinePrepend}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Uri] ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.PSCredential] ${ProxyCredential}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName if ($null -eq [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion) { [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion = $PSVersionTable.PSVersion.ToString() } $preTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId if ($preTelemetryId -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId =(New-Guid).ToString() [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Create', $MyInvocation, $parameterSet, $PSCmdlet) } else { $internalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets if ($internalCalledCmdlets -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $MyInvocation.MyCommand.Name } else { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets += ',' + $MyInvocation.MyCommand.Name } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = 'internal' } $mapping = @{ RestartByName = 'Az.Functions.custom\Restart-AzFunctionApp'; ByObjectInput = 'Az.Functions.custom\Restart-AzFunctionApp'; } if (('RestartByName') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $testPlayback = $false $PSBoundParameters['HttpPipelinePrepend'] | Foreach-Object { if ($_) { $testPlayback = $testPlayback -or ('Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.PipelineMock' -eq $_.Target.GetType().FullName -and 'Playback' -eq $_.Target.Mode) } } if ($testPlayback) { $PSBoundParameters['SubscriptionId'] = . (Join-Path $PSScriptRoot '..' 'utils' 'Get-SubscriptionIdTestSafe.ps1') } else { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id } } $cmdInfo = Get-Command -Name $mapping[$parameterSet] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessCustomAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) if ($null -ne $MyInvocation.MyCommand -and [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets -notcontains $MyInvocation.MyCommand.Name -and [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ContainsPreviewAttribute($cmdInfo, $MyInvocation)){ [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessPreviewMessageAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets.Enqueue($MyInvocation.MyCommand.Name) } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } process { try { $steppablePipeline.Process($_) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } finally { $backupTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId $backupInternalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } } end { try { $steppablePipeline.End() [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $backupTelemetryId [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $backupInternalCalledCmdlets if ($preTelemetryId -eq '') { [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Send', $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $preTelemetryId } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } } <# .Synopsis Starts a function app. .Description Starts a function app. .Example Get-AzFunctionApp -Name MyAppName -ResourceGroupName MyResourceGroupName | Start-AzFunctionApp .Example Start-AzFunctionApp -Name MyAppName -ResourceGroupName MyResourceGroupName .Inputs Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite .Outputs System.Boolean .Notes COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. INPUTOBJECT <ISite>: Location <String>: Resource Location. [Kind <String>]: Kind of resource. [Tag <IResourceTags>]: Resource tags. [(Any) <String>]: This indicates any property can be added to this object. [AuthenticationStorageAccountConnectionStringName <String>]: Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. [AuthenticationType <AuthenticationType?>]: Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. [AuthenticationUserAssignedIdentityResourceId <String>]: Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. [ClientAffinityEnabled <Boolean?>]: <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>. [ClientCertEnabled <Boolean?>]: <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. [ClientCertExclusionPath <String>]: client certificate authentication comma-separated exclusion paths [ClientCertMode <ClientCertMode?>]: This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. [CloningInfoAppSettingsOverride <ICloningInfoAppSettingsOverrides>]: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. [(Any) <String>]: This indicates any property can be added to this object. [CloningInfoCloneCustomHostName <Boolean?>]: <code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>. [CloningInfoCloneSourceControl <Boolean?>]: <code>true</code> to clone source control from source app; otherwise, <code>false</code>. [CloningInfoConfigureLoadBalancing <Boolean?>]: <code>true</code> to configure load balancing for source and destination app. [CloningInfoCorrelationId <String>]: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. [CloningInfoHostingEnvironment <String>]: App Service Environment. [CloningInfoOverwrite <Boolean?>]: <code>true</code> to overwrite destination app; otherwise, <code>false</code>. [CloningInfoSourceWebAppId <String>]: ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. [CloningInfoSourceWebAppLocation <String>]: Location of source app ex: West US or North Europe [CloningInfoTrafficManagerProfileId <String>]: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. [CloningInfoTrafficManagerProfileName <String>]: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. [Config <ISiteConfig>]: Configuration of the app. [AcrUseManagedIdentityCred <Boolean?>]: Flag to use Managed Identity Creds for ACR pull [AcrUserManagedIdentityId <String>]: If using user managed identity, the user managed identity ClientId [ActionMinProcessExecutionTime <String>]: Minimum time the process must execute before taking the action [ActionType <AutoHealActionType?>]: Predefined action to be taken. [AlwaysOn <Boolean?>]: <code>true</code> if Always On is enabled; otherwise, <code>false</code>. [ApiDefinitionUrl <String>]: The URL of the API definition. [ApiManagementConfigId <String>]: APIM-Api Identifier. [AppCommandLine <String>]: App command line to launch. [AppSetting <INameValuePair[]>]: Application settings. [Name <String>]: Pair name. [Value <String>]: Pair value. [AutoHealEnabled <Boolean?>]: <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. [AutoSwapSlotName <String>]: Auto-swap slot name. [AzureStorageAccount <ISiteConfigAzureStorageAccounts>]: List of Azure Storage Accounts. [(Any) <IAzureStorageInfoValue>]: This indicates any property can be added to this object. [ConnectionString <IConnStringInfo[]>]: Connection strings. [ConnectionString <String>]: Connection string value. [Name <String>]: Name of connection string. [Type <ConnectionStringType?>]: Type of database. [CorAllowedOrigin <String[]>]: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. [CorSupportCredentials <Boolean?>]: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. [CustomActionExe <String>]: Executable to be run. [CustomActionParameter <String>]: Parameters for the executable. [DefaultDocument <String[]>]: Default documents. [DetailedErrorLoggingEnabled <Boolean?>]: <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. [DocumentRoot <String>]: Document root. [DynamicTagsJson <String>]: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. [ElasticWebAppScaleLimit <Int32?>]: Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is <code>true</code> [ExperimentRampUpRule <IRampUpRule[]>]: List of ramp-up rules. [ActionHostName <String>]: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. [ChangeDecisionCallbackUrl <String>]: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/ [ChangeIntervalInMinute <Int32?>]: Specifies interval in minutes to reevaluate ReroutePercentage. [ChangeStep <Double?>]: In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>. [MaxReroutePercentage <Double?>]: Specifies upper boundary below which ReroutePercentage will stay. [MinReroutePercentage <Double?>]: Specifies lower boundary above which ReroutePercentage will stay. [Name <String>]: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. [ReroutePercentage <Double?>]: Percentage of the traffic which will be redirected to <code>ActionHostName</code>. [FtpsState <FtpsState?>]: State of FTP / FTPS service [FunctionAppScaleLimit <Int32?>]: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans [FunctionsRuntimeScaleMonitoringEnabled <Boolean?>]: Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status. [HandlerMapping <IHandlerMapping[]>]: Handler mappings. [Argument <String>]: Command-line arguments to be passed to the script processor. [Extension <String>]: Requests with this extension will be handled using the specified FastCGI application. [ScriptProcessor <String>]: The absolute path to the FastCGI application. [HealthCheckPath <String>]: Health check path [Http20Enabled <Boolean?>]: Http20Enabled: configures a web site to allow clients to connect over http2.0 [HttpLoggingEnabled <Boolean?>]: <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. [IPSecurityRestriction <IIPSecurityRestriction[]>]: IP security restrictions for main. [Action <String>]: Allow or Deny access for this IP range. [Description <String>]: IP restriction rule description. [Header <IIPSecurityRestrictionHeaders>]: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. [(Any) <String[]>]: This indicates any property can be added to this object. [IPAddress <String>]: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. [Name <String>]: IP restriction rule name. [Priority <Int32?>]: Priority of IP restriction rule. [SubnetMask <String>]: Subnet mask for the range of IP addresses the restriction is valid for. [SubnetTrafficTag <Int32?>]: (internal) Subnet traffic tag [Tag <IPFilterTag?>]: Defines what this IP filter will be used for. This is to support IP filtering on proxies. [VnetSubnetResourceId <String>]: Virtual network resource id [VnetTrafficTag <Int32?>]: (internal) Vnet traffic tag [IPSecurityRestrictionsDefaultAction <DefaultAction?>]: Default action for main access restriction if no rules are matched. [IsPushEnabled <Boolean?>]: Gets or sets a flag indicating whether the Push endpoint is enabled. [JavaContainer <String>]: Java container. [JavaContainerVersion <String>]: Java container version. [JavaVersion <String>]: Java version. [KeyVaultReferenceIdentity <String>]: Identity to use for Key Vault Reference authentication. [LimitMaxDiskSizeInMb <Int64?>]: Maximum allowed disk size usage in MB. [LimitMaxMemoryInMb <Int64?>]: Maximum allowed memory usage in MB. [LimitMaxPercentageCpu <Double?>]: Maximum allowed CPU usage percentage. [LinuxFxVersion <String>]: Linux App Framework and version [LoadBalancing <SiteLoadBalancing?>]: Site load balancing. [LocalMySqlEnabled <Boolean?>]: <code>true</code> to enable local MySQL; otherwise, <code>false</code>. [LogsDirectorySizeLimit <Int32?>]: HTTP logs directory size limit. [MachineKeyDecryption <String>]: Algorithm used for decryption. [MachineKeyDecryptionKey <String>]: Decryption key. [MachineKeyValidation <String>]: MachineKey validation. [MachineKeyValidationKey <String>]: Validation key. [ManagedPipelineMode <ManagedPipelineMode?>]: Managed pipeline mode. [ManagedServiceIdentityId <Int32?>]: Managed Service Identity Id [Metadata <INameValuePair[]>]: Application metadata. This property cannot be retrieved, since it may contain secrets. [MinTlsCipherSuite <TlsCipherSuites?>]: The minimum strength TLS cipher suite allowed for an application [MinTlsVersion <SupportedTlsVersions?>]: MinTlsVersion: configures the minimum version of TLS required for SSL requests [MinimumElasticInstanceCount <Int32?>]: Number of minimum instance count for a site This setting only applies to the Elastic Plans [NetFrameworkVersion <String>]: .NET Framework version. [NodeVersion <String>]: Version of Node.js. [NumberOfWorker <Int32?>]: Number of workers. [PhpVersion <String>]: Version of PHP. [PowerShellVersion <String>]: Version of PowerShell. [PreWarmedInstanceCount <Int32?>]: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans [PublicNetworkAccess <String>]: Property to allow or block all public traffic. [PublishingUsername <String>]: Publishing user name. [PushKind <String>]: Kind of resource. [PythonVersion <String>]: Version of Python. [RemoteDebuggingEnabled <Boolean?>]: <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. [RemoteDebuggingVersion <String>]: Remote debugging version. [RequestCount <Int32?>]: Request Count. [RequestTimeInterval <String>]: Time interval. [RequestTracingEnabled <Boolean?>]: <code>true</code> if request tracing is enabled; otherwise, <code>false</code>. [RequestTracingExpirationTime <DateTime?>]: Request tracing expiration time. [ScmIPSecurityRestriction <IIPSecurityRestriction[]>]: IP security restrictions for scm. [ScmIPSecurityRestrictionsDefaultAction <DefaultAction?>]: Default action for scm access restriction if no rules are matched. [ScmIPSecurityRestrictionsUseMain <Boolean?>]: IP security restrictions for scm to use main. [ScmMinTlsVersion <SupportedTlsVersions?>]: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site [ScmType <ScmType?>]: SCM type. [SlowRequestCount <Int32?>]: Request Count. [SlowRequestPath <String>]: Request Path. [SlowRequestTimeInterval <String>]: Time interval. [SlowRequestTimeTaken <String>]: Time taken. [TagWhitelistJson <String>]: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. [TagsRequiringAuth <String>]: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. [TracingOption <String>]: Tracing options. [TriggerPrivateBytesInKb <Int32?>]: A rule based on private bytes. [TriggerSlowRequestsWithPath <ISlowRequestsBasedTrigger[]>]: A rule based on multiple Slow Requests Rule with path [Count <Int32?>]: Request Count. [Path <String>]: Request Path. [TimeInterval <String>]: Time interval. [TimeTaken <String>]: Time taken. [TriggerStatusCode <IStatusCodesBasedTrigger[]>]: A rule based on status codes. [Count <Int32?>]: Request Count. [Path <String>]: Request Path [Status <Int32?>]: HTTP status code. [SubStatus <Int32?>]: Request Sub Status. [TimeInterval <String>]: Time interval. [Win32Status <Int32?>]: Win32 error code. [TriggerStatusCodesRange <IStatusCodesRangeBasedTrigger[]>]: A rule based on status codes ranges. [Count <Int32?>]: Request Count. [Path <String>]: [StatusCode <String>]: HTTP status code. [TimeInterval <String>]: Time interval. [Use32BitWorkerProcess <Boolean?>]: <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. [VirtualApplication <IVirtualApplication[]>]: Virtual applications. [PhysicalPath <String>]: Physical path. [PreloadEnabled <Boolean?>]: <code>true</code> if preloading is enabled; otherwise, <code>false</code>. [VirtualDirectory <IVirtualDirectory[]>]: Virtual directories for virtual application. [PhysicalPath <String>]: Physical path. [VirtualPath <String>]: Path to virtual application. [VirtualPath <String>]: Virtual path. [VnetName <String>]: Virtual Network name. [VnetPrivatePortsCount <Int32?>]: The number of private ports assigned to this app. These will be assigned dynamically on runtime. [VnetRouteAllEnabled <Boolean?>]: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. [WebSocketsEnabled <Boolean?>]: <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. [WebsiteTimeZone <String>]: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones [WindowsFxVersion <String>]: Xenon App Framework and version [XManagedServiceIdentityId <Int32?>]: Explicit Managed Service Identity Id [ContainerSize <Int32?>]: Size of the function container. [CustomDomainVerificationId <String>]: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. [DailyMemoryTimeQuota <Int32?>]: Maximum allowed daily memory-time quota (applicable on dynamic apps only). [DaprConfigAppId <String>]: Dapr application identifier [DaprConfigAppPort <Int32?>]: Tells Dapr which port your application is listening on [DaprConfigEnableApiLogging <Boolean?>]: Enables API logging for the Dapr sidecar [DaprConfigEnabled <Boolean?>]: Boolean indicating if the Dapr side car is enabled [DaprConfigHttpMaxRequestSize <Int32?>]: Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. [DaprConfigHttpReadBufferSize <Int32?>]: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. [DaprConfigLogLevel <DaprLogLevel?>]: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. [DnsConfigurationDnsAltServer <String>]: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. [DnsConfigurationDnsMaxCacheTimeout <Int32?>]: Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. [DnsConfigurationDnsRetryAttemptCount <Int32?>]: Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. [DnsConfigurationDnsRetryAttemptTimeout <Int32?>]: Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. [DnsConfigurationDnsServer <String[]>]: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. [Enabled <Boolean?>]: <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline). [ExtendedLocationName <String>]: Name of extended location. [HostNameSslState <IHostNameSslState[]>]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. [HostType <HostType?>]: Indicates whether the hostname is a standard or repository hostname. [Name <String>]: Hostname. [SslState <SslState?>]: SSL type. [Thumbprint <String>]: SSL certificate thumbprint. [ToUpdate <Boolean?>]: Set to <code>true</code> to update existing hostname. [VirtualIP <String>]: Virtual IP address assigned to the hostname if IP based SSL is enabled. [HostNamesDisabled <Boolean?>]: <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process. [HostingEnvironmentProfileId <String>]: Resource ID of the App Service Environment. [HttpPerInstanceConcurrency <Single?>]: The maximum number of concurrent HTTP trigger invocations per instance. [HttpsOnly <Boolean?>]: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests [HyperV <Boolean?>]: Hyper-V sandbox. [IdentityType <ManagedServiceIdentityType?>]: Type of managed service identity. [IdentityUserAssignedIdentity <IManagedServiceIdentityUserAssignedIdentities>]: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} [(Any) <IUserAssignedIdentity>]: This indicates any property can be added to this object. [IsXenon <Boolean?>]: Obsolete: Hyper-V sandbox. [KeyVaultReferenceIdentity <String>]: Identity to use for Key Vault Reference authentication. [ManagedEnvironmentId <String>]: Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} [PublicNetworkAccess <String>]: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. [RedundancyMode <RedundancyMode?>]: Site redundancy mode [Reserved <Boolean?>]: <code>true</code> if reserved; otherwise, <code>false</code>. [ResourceConfigCpu <Double?>]: Required CPU in cores, e.g. 0.5 [ResourceConfigMemory <String>]: Required memory, e.g. "1Gi" [RuntimeName <RuntimeName?>]: Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom [RuntimeVersion <String>]: Function app runtime version. Example: 8 (for dotnet-isolated) [ScaleAndConcurrencyAlwaysReady <IFunctionsAlwaysReadyConfig[]>]: 'Always Ready' configuration for the function app. [InstanceCount <Single?>]: Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready. [Name <String>]: Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. [ScaleAndConcurrencyInstanceMemoryMb <Single?>]: Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. [ScaleAndConcurrencyMaximumInstanceCount <Single?>]: The maximum number of instances for the function app. [ScmSiteAlsoStopped <Boolean?>]: <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. [ServerFarmId <String>]: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". [StorageAccountRequired <Boolean?>]: Checks if Customer provided storage account is required [StorageType <FunctionsDeploymentStorageType?>]: Property to select Azure Storage type. Available options: blobContainer. [StorageValue <String>]: Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://<storageAccountName>.blob.core.windows.net/<containerName>. [VirtualNetworkSubnetId <String>]: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} [VnetBackupRestoreEnabled <Boolean?>]: To enable Backup and Restore operations over virtual network [VnetContentShareEnabled <Boolean?>]: To enable accessing content over virtual network [VnetImagePullEnabled <Boolean?>]: To enable pulling image over Virtual Network [VnetRouteAllEnabled <Boolean?>]: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. [WorkloadProfileName <String>]: Workload profile name for function app to execute on. .Link https://learn.microsoft.com/powershell/module/az.functions/start-azfunctionapp #> function Start-AzFunctionApp { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='StartByName', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='StartByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] # The name of function app. ${Name}, [Parameter(ParameterSetName='StartByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] ${ResourceGroupName}, [Parameter(ParameterSetName='StartByName')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.DefaultInfo(Script='(Get-AzContext).Subscription.Id')] [System.String] # The Azure subscription ID. ${SubscriptionId}, [Parameter(ParameterSetName='ByObjectInput', Mandatory, ValueFromPipeline)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite] # To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ${InputObject}, [Parameter()] [Alias('AzureRMContext', 'AzureCredential')] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Azure')] [System.Management.Automation.PSObject] # The credentials, account, tenant, and subscription used for communication with Azure. ${DefaultProfile}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Returns true when the command succeeds. ${PassThru}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelinePrepend}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Uri] ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.PSCredential] ${ProxyCredential}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName if ($null -eq [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion) { [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion = $PSVersionTable.PSVersion.ToString() } $preTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId if ($preTelemetryId -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId =(New-Guid).ToString() [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Create', $MyInvocation, $parameterSet, $PSCmdlet) } else { $internalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets if ($internalCalledCmdlets -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $MyInvocation.MyCommand.Name } else { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets += ',' + $MyInvocation.MyCommand.Name } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = 'internal' } $mapping = @{ StartByName = 'Az.Functions.custom\Start-AzFunctionApp'; ByObjectInput = 'Az.Functions.custom\Start-AzFunctionApp'; } if (('StartByName') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $testPlayback = $false $PSBoundParameters['HttpPipelinePrepend'] | Foreach-Object { if ($_) { $testPlayback = $testPlayback -or ('Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.PipelineMock' -eq $_.Target.GetType().FullName -and 'Playback' -eq $_.Target.Mode) } } if ($testPlayback) { $PSBoundParameters['SubscriptionId'] = . (Join-Path $PSScriptRoot '..' 'utils' 'Get-SubscriptionIdTestSafe.ps1') } else { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id } } $cmdInfo = Get-Command -Name $mapping[$parameterSet] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessCustomAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) if ($null -ne $MyInvocation.MyCommand -and [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets -notcontains $MyInvocation.MyCommand.Name -and [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ContainsPreviewAttribute($cmdInfo, $MyInvocation)){ [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessPreviewMessageAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets.Enqueue($MyInvocation.MyCommand.Name) } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } process { try { $steppablePipeline.Process($_) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } finally { $backupTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId $backupInternalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } } end { try { $steppablePipeline.End() [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $backupTelemetryId [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $backupInternalCalledCmdlets if ($preTelemetryId -eq '') { [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Send', $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $preTelemetryId } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } } <# .Synopsis Stops a function app. .Description Stops a function app. .Example Get-AzFunctionApp -Name MyAppName -ResourceGroupName MyResourceGroupName | Stop-AzFunctionApp -Force .Example Stop-AzFunctionApp -Name MyAppName -ResourceGroupName MyResourceGroupName -Force .Inputs Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite .Outputs System.Boolean .Notes COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. INPUTOBJECT <ISite>: Location <String>: Resource Location. [Kind <String>]: Kind of resource. [Tag <IResourceTags>]: Resource tags. [(Any) <String>]: This indicates any property can be added to this object. [AuthenticationStorageAccountConnectionStringName <String>]: Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. [AuthenticationType <AuthenticationType?>]: Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. [AuthenticationUserAssignedIdentityResourceId <String>]: Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. [ClientAffinityEnabled <Boolean?>]: <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>. [ClientCertEnabled <Boolean?>]: <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. [ClientCertExclusionPath <String>]: client certificate authentication comma-separated exclusion paths [ClientCertMode <ClientCertMode?>]: This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. [CloningInfoAppSettingsOverride <ICloningInfoAppSettingsOverrides>]: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. [(Any) <String>]: This indicates any property can be added to this object. [CloningInfoCloneCustomHostName <Boolean?>]: <code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>. [CloningInfoCloneSourceControl <Boolean?>]: <code>true</code> to clone source control from source app; otherwise, <code>false</code>. [CloningInfoConfigureLoadBalancing <Boolean?>]: <code>true</code> to configure load balancing for source and destination app. [CloningInfoCorrelationId <String>]: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. [CloningInfoHostingEnvironment <String>]: App Service Environment. [CloningInfoOverwrite <Boolean?>]: <code>true</code> to overwrite destination app; otherwise, <code>false</code>. [CloningInfoSourceWebAppId <String>]: ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. [CloningInfoSourceWebAppLocation <String>]: Location of source app ex: West US or North Europe [CloningInfoTrafficManagerProfileId <String>]: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. [CloningInfoTrafficManagerProfileName <String>]: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. [Config <ISiteConfig>]: Configuration of the app. [AcrUseManagedIdentityCred <Boolean?>]: Flag to use Managed Identity Creds for ACR pull [AcrUserManagedIdentityId <String>]: If using user managed identity, the user managed identity ClientId [ActionMinProcessExecutionTime <String>]: Minimum time the process must execute before taking the action [ActionType <AutoHealActionType?>]: Predefined action to be taken. [AlwaysOn <Boolean?>]: <code>true</code> if Always On is enabled; otherwise, <code>false</code>. [ApiDefinitionUrl <String>]: The URL of the API definition. [ApiManagementConfigId <String>]: APIM-Api Identifier. [AppCommandLine <String>]: App command line to launch. [AppSetting <INameValuePair[]>]: Application settings. [Name <String>]: Pair name. [Value <String>]: Pair value. [AutoHealEnabled <Boolean?>]: <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. [AutoSwapSlotName <String>]: Auto-swap slot name. [AzureStorageAccount <ISiteConfigAzureStorageAccounts>]: List of Azure Storage Accounts. [(Any) <IAzureStorageInfoValue>]: This indicates any property can be added to this object. [ConnectionString <IConnStringInfo[]>]: Connection strings. [ConnectionString <String>]: Connection string value. [Name <String>]: Name of connection string. [Type <ConnectionStringType?>]: Type of database. [CorAllowedOrigin <String[]>]: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. [CorSupportCredentials <Boolean?>]: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. [CustomActionExe <String>]: Executable to be run. [CustomActionParameter <String>]: Parameters for the executable. [DefaultDocument <String[]>]: Default documents. [DetailedErrorLoggingEnabled <Boolean?>]: <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. [DocumentRoot <String>]: Document root. [DynamicTagsJson <String>]: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. [ElasticWebAppScaleLimit <Int32?>]: Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is <code>true</code> [ExperimentRampUpRule <IRampUpRule[]>]: List of ramp-up rules. [ActionHostName <String>]: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. [ChangeDecisionCallbackUrl <String>]: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/ [ChangeIntervalInMinute <Int32?>]: Specifies interval in minutes to reevaluate ReroutePercentage. [ChangeStep <Double?>]: In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>. [MaxReroutePercentage <Double?>]: Specifies upper boundary below which ReroutePercentage will stay. [MinReroutePercentage <Double?>]: Specifies lower boundary above which ReroutePercentage will stay. [Name <String>]: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. [ReroutePercentage <Double?>]: Percentage of the traffic which will be redirected to <code>ActionHostName</code>. [FtpsState <FtpsState?>]: State of FTP / FTPS service [FunctionAppScaleLimit <Int32?>]: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans [FunctionsRuntimeScaleMonitoringEnabled <Boolean?>]: Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status. [HandlerMapping <IHandlerMapping[]>]: Handler mappings. [Argument <String>]: Command-line arguments to be passed to the script processor. [Extension <String>]: Requests with this extension will be handled using the specified FastCGI application. [ScriptProcessor <String>]: The absolute path to the FastCGI application. [HealthCheckPath <String>]: Health check path [Http20Enabled <Boolean?>]: Http20Enabled: configures a web site to allow clients to connect over http2.0 [HttpLoggingEnabled <Boolean?>]: <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. [IPSecurityRestriction <IIPSecurityRestriction[]>]: IP security restrictions for main. [Action <String>]: Allow or Deny access for this IP range. [Description <String>]: IP restriction rule description. [Header <IIPSecurityRestrictionHeaders>]: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. [(Any) <String[]>]: This indicates any property can be added to this object. [IPAddress <String>]: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. [Name <String>]: IP restriction rule name. [Priority <Int32?>]: Priority of IP restriction rule. [SubnetMask <String>]: Subnet mask for the range of IP addresses the restriction is valid for. [SubnetTrafficTag <Int32?>]: (internal) Subnet traffic tag [Tag <IPFilterTag?>]: Defines what this IP filter will be used for. This is to support IP filtering on proxies. [VnetSubnetResourceId <String>]: Virtual network resource id [VnetTrafficTag <Int32?>]: (internal) Vnet traffic tag [IPSecurityRestrictionsDefaultAction <DefaultAction?>]: Default action for main access restriction if no rules are matched. [IsPushEnabled <Boolean?>]: Gets or sets a flag indicating whether the Push endpoint is enabled. [JavaContainer <String>]: Java container. [JavaContainerVersion <String>]: Java container version. [JavaVersion <String>]: Java version. [KeyVaultReferenceIdentity <String>]: Identity to use for Key Vault Reference authentication. [LimitMaxDiskSizeInMb <Int64?>]: Maximum allowed disk size usage in MB. [LimitMaxMemoryInMb <Int64?>]: Maximum allowed memory usage in MB. [LimitMaxPercentageCpu <Double?>]: Maximum allowed CPU usage percentage. [LinuxFxVersion <String>]: Linux App Framework and version [LoadBalancing <SiteLoadBalancing?>]: Site load balancing. [LocalMySqlEnabled <Boolean?>]: <code>true</code> to enable local MySQL; otherwise, <code>false</code>. [LogsDirectorySizeLimit <Int32?>]: HTTP logs directory size limit. [MachineKeyDecryption <String>]: Algorithm used for decryption. [MachineKeyDecryptionKey <String>]: Decryption key. [MachineKeyValidation <String>]: MachineKey validation. [MachineKeyValidationKey <String>]: Validation key. [ManagedPipelineMode <ManagedPipelineMode?>]: Managed pipeline mode. [ManagedServiceIdentityId <Int32?>]: Managed Service Identity Id [Metadata <INameValuePair[]>]: Application metadata. This property cannot be retrieved, since it may contain secrets. [MinTlsCipherSuite <TlsCipherSuites?>]: The minimum strength TLS cipher suite allowed for an application [MinTlsVersion <SupportedTlsVersions?>]: MinTlsVersion: configures the minimum version of TLS required for SSL requests [MinimumElasticInstanceCount <Int32?>]: Number of minimum instance count for a site This setting only applies to the Elastic Plans [NetFrameworkVersion <String>]: .NET Framework version. [NodeVersion <String>]: Version of Node.js. [NumberOfWorker <Int32?>]: Number of workers. [PhpVersion <String>]: Version of PHP. [PowerShellVersion <String>]: Version of PowerShell. [PreWarmedInstanceCount <Int32?>]: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans [PublicNetworkAccess <String>]: Property to allow or block all public traffic. [PublishingUsername <String>]: Publishing user name. [PushKind <String>]: Kind of resource. [PythonVersion <String>]: Version of Python. [RemoteDebuggingEnabled <Boolean?>]: <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. [RemoteDebuggingVersion <String>]: Remote debugging version. [RequestCount <Int32?>]: Request Count. [RequestTimeInterval <String>]: Time interval. [RequestTracingEnabled <Boolean?>]: <code>true</code> if request tracing is enabled; otherwise, <code>false</code>. [RequestTracingExpirationTime <DateTime?>]: Request tracing expiration time. [ScmIPSecurityRestriction <IIPSecurityRestriction[]>]: IP security restrictions for scm. [ScmIPSecurityRestrictionsDefaultAction <DefaultAction?>]: Default action for scm access restriction if no rules are matched. [ScmIPSecurityRestrictionsUseMain <Boolean?>]: IP security restrictions for scm to use main. [ScmMinTlsVersion <SupportedTlsVersions?>]: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site [ScmType <ScmType?>]: SCM type. [SlowRequestCount <Int32?>]: Request Count. [SlowRequestPath <String>]: Request Path. [SlowRequestTimeInterval <String>]: Time interval. [SlowRequestTimeTaken <String>]: Time taken. [TagWhitelistJson <String>]: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. [TagsRequiringAuth <String>]: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. [TracingOption <String>]: Tracing options. [TriggerPrivateBytesInKb <Int32?>]: A rule based on private bytes. [TriggerSlowRequestsWithPath <ISlowRequestsBasedTrigger[]>]: A rule based on multiple Slow Requests Rule with path [Count <Int32?>]: Request Count. [Path <String>]: Request Path. [TimeInterval <String>]: Time interval. [TimeTaken <String>]: Time taken. [TriggerStatusCode <IStatusCodesBasedTrigger[]>]: A rule based on status codes. [Count <Int32?>]: Request Count. [Path <String>]: Request Path [Status <Int32?>]: HTTP status code. [SubStatus <Int32?>]: Request Sub Status. [TimeInterval <String>]: Time interval. [Win32Status <Int32?>]: Win32 error code. [TriggerStatusCodesRange <IStatusCodesRangeBasedTrigger[]>]: A rule based on status codes ranges. [Count <Int32?>]: Request Count. [Path <String>]: [StatusCode <String>]: HTTP status code. [TimeInterval <String>]: Time interval. [Use32BitWorkerProcess <Boolean?>]: <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. [VirtualApplication <IVirtualApplication[]>]: Virtual applications. [PhysicalPath <String>]: Physical path. [PreloadEnabled <Boolean?>]: <code>true</code> if preloading is enabled; otherwise, <code>false</code>. [VirtualDirectory <IVirtualDirectory[]>]: Virtual directories for virtual application. [PhysicalPath <String>]: Physical path. [VirtualPath <String>]: Path to virtual application. [VirtualPath <String>]: Virtual path. [VnetName <String>]: Virtual Network name. [VnetPrivatePortsCount <Int32?>]: The number of private ports assigned to this app. These will be assigned dynamically on runtime. [VnetRouteAllEnabled <Boolean?>]: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. [WebSocketsEnabled <Boolean?>]: <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. [WebsiteTimeZone <String>]: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones [WindowsFxVersion <String>]: Xenon App Framework and version [XManagedServiceIdentityId <Int32?>]: Explicit Managed Service Identity Id [ContainerSize <Int32?>]: Size of the function container. [CustomDomainVerificationId <String>]: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. [DailyMemoryTimeQuota <Int32?>]: Maximum allowed daily memory-time quota (applicable on dynamic apps only). [DaprConfigAppId <String>]: Dapr application identifier [DaprConfigAppPort <Int32?>]: Tells Dapr which port your application is listening on [DaprConfigEnableApiLogging <Boolean?>]: Enables API logging for the Dapr sidecar [DaprConfigEnabled <Boolean?>]: Boolean indicating if the Dapr side car is enabled [DaprConfigHttpMaxRequestSize <Int32?>]: Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. [DaprConfigHttpReadBufferSize <Int32?>]: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. [DaprConfigLogLevel <DaprLogLevel?>]: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. [DnsConfigurationDnsAltServer <String>]: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. [DnsConfigurationDnsMaxCacheTimeout <Int32?>]: Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. [DnsConfigurationDnsRetryAttemptCount <Int32?>]: Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. [DnsConfigurationDnsRetryAttemptTimeout <Int32?>]: Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. [DnsConfigurationDnsServer <String[]>]: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. [Enabled <Boolean?>]: <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline). [ExtendedLocationName <String>]: Name of extended location. [HostNameSslState <IHostNameSslState[]>]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. [HostType <HostType?>]: Indicates whether the hostname is a standard or repository hostname. [Name <String>]: Hostname. [SslState <SslState?>]: SSL type. [Thumbprint <String>]: SSL certificate thumbprint. [ToUpdate <Boolean?>]: Set to <code>true</code> to update existing hostname. [VirtualIP <String>]: Virtual IP address assigned to the hostname if IP based SSL is enabled. [HostNamesDisabled <Boolean?>]: <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process. [HostingEnvironmentProfileId <String>]: Resource ID of the App Service Environment. [HttpPerInstanceConcurrency <Single?>]: The maximum number of concurrent HTTP trigger invocations per instance. [HttpsOnly <Boolean?>]: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests [HyperV <Boolean?>]: Hyper-V sandbox. [IdentityType <ManagedServiceIdentityType?>]: Type of managed service identity. [IdentityUserAssignedIdentity <IManagedServiceIdentityUserAssignedIdentities>]: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} [(Any) <IUserAssignedIdentity>]: This indicates any property can be added to this object. [IsXenon <Boolean?>]: Obsolete: Hyper-V sandbox. [KeyVaultReferenceIdentity <String>]: Identity to use for Key Vault Reference authentication. [ManagedEnvironmentId <String>]: Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} [PublicNetworkAccess <String>]: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. [RedundancyMode <RedundancyMode?>]: Site redundancy mode [Reserved <Boolean?>]: <code>true</code> if reserved; otherwise, <code>false</code>. [ResourceConfigCpu <Double?>]: Required CPU in cores, e.g. 0.5 [ResourceConfigMemory <String>]: Required memory, e.g. "1Gi" [RuntimeName <RuntimeName?>]: Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom [RuntimeVersion <String>]: Function app runtime version. Example: 8 (for dotnet-isolated) [ScaleAndConcurrencyAlwaysReady <IFunctionsAlwaysReadyConfig[]>]: 'Always Ready' configuration for the function app. [InstanceCount <Single?>]: Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready. [Name <String>]: Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. [ScaleAndConcurrencyInstanceMemoryMb <Single?>]: Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. [ScaleAndConcurrencyMaximumInstanceCount <Single?>]: The maximum number of instances for the function app. [ScmSiteAlsoStopped <Boolean?>]: <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. [ServerFarmId <String>]: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". [StorageAccountRequired <Boolean?>]: Checks if Customer provided storage account is required [StorageType <FunctionsDeploymentStorageType?>]: Property to select Azure Storage type. Available options: blobContainer. [StorageValue <String>]: Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://<storageAccountName>.blob.core.windows.net/<containerName>. [VirtualNetworkSubnetId <String>]: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} [VnetBackupRestoreEnabled <Boolean?>]: To enable Backup and Restore operations over virtual network [VnetContentShareEnabled <Boolean?>]: To enable accessing content over virtual network [VnetImagePullEnabled <Boolean?>]: To enable pulling image over Virtual Network [VnetRouteAllEnabled <Boolean?>]: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. [WorkloadProfileName <String>]: Workload profile name for function app to execute on. .Link https://learn.microsoft.com/powershell/module/az.functions/stop-azfunctionapp #> function Stop-AzFunctionApp { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='StopByName', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='StopByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] # The name of function app. ${Name}, [Parameter(ParameterSetName='StopByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] ${ResourceGroupName}, [Parameter(ParameterSetName='StopByName')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.DefaultInfo(Script='(Get-AzContext).Subscription.Id')] [System.String] # The Azure subscription ID. ${SubscriptionId}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.Management.Automation.SwitchParameter] # Forces the cmdlet to stop the function app without prompting for confirmation. ${Force}, [Parameter(ParameterSetName='ByObjectInput', Mandatory, ValueFromPipeline)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite] # To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ${InputObject}, [Parameter()] [Alias('AzureRMContext', 'AzureCredential')] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Azure')] [System.Management.Automation.PSObject] # The credentials, account, tenant, and subscription used for communication with Azure. ${DefaultProfile}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Returns true when the command succeeds. ${PassThru}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelinePrepend}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Uri] ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.PSCredential] ${ProxyCredential}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName if ($null -eq [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion) { [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion = $PSVersionTable.PSVersion.ToString() } $preTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId if ($preTelemetryId -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId =(New-Guid).ToString() [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Create', $MyInvocation, $parameterSet, $PSCmdlet) } else { $internalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets if ($internalCalledCmdlets -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $MyInvocation.MyCommand.Name } else { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets += ',' + $MyInvocation.MyCommand.Name } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = 'internal' } $mapping = @{ StopByName = 'Az.Functions.custom\Stop-AzFunctionApp'; ByObjectInput = 'Az.Functions.custom\Stop-AzFunctionApp'; } if (('StopByName') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $testPlayback = $false $PSBoundParameters['HttpPipelinePrepend'] | Foreach-Object { if ($_) { $testPlayback = $testPlayback -or ('Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.PipelineMock' -eq $_.Target.GetType().FullName -and 'Playback' -eq $_.Target.Mode) } } if ($testPlayback) { $PSBoundParameters['SubscriptionId'] = . (Join-Path $PSScriptRoot '..' 'utils' 'Get-SubscriptionIdTestSafe.ps1') } else { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id } } $cmdInfo = Get-Command -Name $mapping[$parameterSet] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessCustomAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) if ($null -ne $MyInvocation.MyCommand -and [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets -notcontains $MyInvocation.MyCommand.Name -and [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ContainsPreviewAttribute($cmdInfo, $MyInvocation)){ [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessPreviewMessageAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets.Enqueue($MyInvocation.MyCommand.Name) } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } process { try { $steppablePipeline.Process($_) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } finally { $backupTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId $backupInternalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } } end { try { $steppablePipeline.End() [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $backupTelemetryId [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $backupInternalCalledCmdlets if ($preTelemetryId -eq '') { [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Send', $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $preTelemetryId } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } } <# .Synopsis Updates a function app. .Description Updates a function app. .Example Update-AzFunctionApp -Name MyUniqueFunctionAppName -ResourceGroupName MyResourceGroupName -PlanName NewPlanName -Force .Example Update-AzFunctionApp -Name MyUniqueFunctionAppName -ResourceGroupName MyResourceGroupName -IdentityType SystemAssigned -Force .Example Update-AzFunctionApp -Name MyUniqueFunctionAppName -ResourceGroupName MyResourceGroupName -ApplicationInsightsName ApplicationInsightsProjectName -Force .Example Update-AzFunctionApp -Name MyUniqueFunctionAppName -ResourceGroupName MyResourceGroupName -IdentityType None -Force .Inputs Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite .Outputs Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite .Notes COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. INPUTOBJECT <ISite>: Location <String>: Resource Location. [Kind <String>]: Kind of resource. [Tag <IResourceTags>]: Resource tags. [(Any) <String>]: This indicates any property can be added to this object. [AuthenticationStorageAccountConnectionStringName <String>]: Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. [AuthenticationType <AuthenticationType?>]: Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. [AuthenticationUserAssignedIdentityResourceId <String>]: Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. [ClientAffinityEnabled <Boolean?>]: <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>. [ClientCertEnabled <Boolean?>]: <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. [ClientCertExclusionPath <String>]: client certificate authentication comma-separated exclusion paths [ClientCertMode <ClientCertMode?>]: This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. [CloningInfoAppSettingsOverride <ICloningInfoAppSettingsOverrides>]: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. [(Any) <String>]: This indicates any property can be added to this object. [CloningInfoCloneCustomHostName <Boolean?>]: <code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>. [CloningInfoCloneSourceControl <Boolean?>]: <code>true</code> to clone source control from source app; otherwise, <code>false</code>. [CloningInfoConfigureLoadBalancing <Boolean?>]: <code>true</code> to configure load balancing for source and destination app. [CloningInfoCorrelationId <String>]: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. [CloningInfoHostingEnvironment <String>]: App Service Environment. [CloningInfoOverwrite <Boolean?>]: <code>true</code> to overwrite destination app; otherwise, <code>false</code>. [CloningInfoSourceWebAppId <String>]: ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. [CloningInfoSourceWebAppLocation <String>]: Location of source app ex: West US or North Europe [CloningInfoTrafficManagerProfileId <String>]: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. [CloningInfoTrafficManagerProfileName <String>]: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. [Config <ISiteConfig>]: Configuration of the app. [AcrUseManagedIdentityCred <Boolean?>]: Flag to use Managed Identity Creds for ACR pull [AcrUserManagedIdentityId <String>]: If using user managed identity, the user managed identity ClientId [ActionMinProcessExecutionTime <String>]: Minimum time the process must execute before taking the action [ActionType <AutoHealActionType?>]: Predefined action to be taken. [AlwaysOn <Boolean?>]: <code>true</code> if Always On is enabled; otherwise, <code>false</code>. [ApiDefinitionUrl <String>]: The URL of the API definition. [ApiManagementConfigId <String>]: APIM-Api Identifier. [AppCommandLine <String>]: App command line to launch. [AppSetting <INameValuePair[]>]: Application settings. [Name <String>]: Pair name. [Value <String>]: Pair value. [AutoHealEnabled <Boolean?>]: <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. [AutoSwapSlotName <String>]: Auto-swap slot name. [AzureStorageAccount <ISiteConfigAzureStorageAccounts>]: List of Azure Storage Accounts. [(Any) <IAzureStorageInfoValue>]: This indicates any property can be added to this object. [ConnectionString <IConnStringInfo[]>]: Connection strings. [ConnectionString <String>]: Connection string value. [Name <String>]: Name of connection string. [Type <ConnectionStringType?>]: Type of database. [CorAllowedOrigin <String[]>]: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. [CorSupportCredentials <Boolean?>]: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. [CustomActionExe <String>]: Executable to be run. [CustomActionParameter <String>]: Parameters for the executable. [DefaultDocument <String[]>]: Default documents. [DetailedErrorLoggingEnabled <Boolean?>]: <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. [DocumentRoot <String>]: Document root. [DynamicTagsJson <String>]: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. [ElasticWebAppScaleLimit <Int32?>]: Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is <code>true</code> [ExperimentRampUpRule <IRampUpRule[]>]: List of ramp-up rules. [ActionHostName <String>]: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. [ChangeDecisionCallbackUrl <String>]: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/ [ChangeIntervalInMinute <Int32?>]: Specifies interval in minutes to reevaluate ReroutePercentage. [ChangeStep <Double?>]: In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>. [MaxReroutePercentage <Double?>]: Specifies upper boundary below which ReroutePercentage will stay. [MinReroutePercentage <Double?>]: Specifies lower boundary above which ReroutePercentage will stay. [Name <String>]: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. [ReroutePercentage <Double?>]: Percentage of the traffic which will be redirected to <code>ActionHostName</code>. [FtpsState <FtpsState?>]: State of FTP / FTPS service [FunctionAppScaleLimit <Int32?>]: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans [FunctionsRuntimeScaleMonitoringEnabled <Boolean?>]: Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status. [HandlerMapping <IHandlerMapping[]>]: Handler mappings. [Argument <String>]: Command-line arguments to be passed to the script processor. [Extension <String>]: Requests with this extension will be handled using the specified FastCGI application. [ScriptProcessor <String>]: The absolute path to the FastCGI application. [HealthCheckPath <String>]: Health check path [Http20Enabled <Boolean?>]: Http20Enabled: configures a web site to allow clients to connect over http2.0 [HttpLoggingEnabled <Boolean?>]: <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. [IPSecurityRestriction <IIPSecurityRestriction[]>]: IP security restrictions for main. [Action <String>]: Allow or Deny access for this IP range. [Description <String>]: IP restriction rule description. [Header <IIPSecurityRestrictionHeaders>]: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. [(Any) <String[]>]: This indicates any property can be added to this object. [IPAddress <String>]: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. [Name <String>]: IP restriction rule name. [Priority <Int32?>]: Priority of IP restriction rule. [SubnetMask <String>]: Subnet mask for the range of IP addresses the restriction is valid for. [SubnetTrafficTag <Int32?>]: (internal) Subnet traffic tag [Tag <IPFilterTag?>]: Defines what this IP filter will be used for. This is to support IP filtering on proxies. [VnetSubnetResourceId <String>]: Virtual network resource id [VnetTrafficTag <Int32?>]: (internal) Vnet traffic tag [IPSecurityRestrictionsDefaultAction <DefaultAction?>]: Default action for main access restriction if no rules are matched. [IsPushEnabled <Boolean?>]: Gets or sets a flag indicating whether the Push endpoint is enabled. [JavaContainer <String>]: Java container. [JavaContainerVersion <String>]: Java container version. [JavaVersion <String>]: Java version. [KeyVaultReferenceIdentity <String>]: Identity to use for Key Vault Reference authentication. [LimitMaxDiskSizeInMb <Int64?>]: Maximum allowed disk size usage in MB. [LimitMaxMemoryInMb <Int64?>]: Maximum allowed memory usage in MB. [LimitMaxPercentageCpu <Double?>]: Maximum allowed CPU usage percentage. [LinuxFxVersion <String>]: Linux App Framework and version [LoadBalancing <SiteLoadBalancing?>]: Site load balancing. [LocalMySqlEnabled <Boolean?>]: <code>true</code> to enable local MySQL; otherwise, <code>false</code>. [LogsDirectorySizeLimit <Int32?>]: HTTP logs directory size limit. [MachineKeyDecryption <String>]: Algorithm used for decryption. [MachineKeyDecryptionKey <String>]: Decryption key. [MachineKeyValidation <String>]: MachineKey validation. [MachineKeyValidationKey <String>]: Validation key. [ManagedPipelineMode <ManagedPipelineMode?>]: Managed pipeline mode. [ManagedServiceIdentityId <Int32?>]: Managed Service Identity Id [Metadata <INameValuePair[]>]: Application metadata. This property cannot be retrieved, since it may contain secrets. [MinTlsCipherSuite <TlsCipherSuites?>]: The minimum strength TLS cipher suite allowed for an application [MinTlsVersion <SupportedTlsVersions?>]: MinTlsVersion: configures the minimum version of TLS required for SSL requests [MinimumElasticInstanceCount <Int32?>]: Number of minimum instance count for a site This setting only applies to the Elastic Plans [NetFrameworkVersion <String>]: .NET Framework version. [NodeVersion <String>]: Version of Node.js. [NumberOfWorker <Int32?>]: Number of workers. [PhpVersion <String>]: Version of PHP. [PowerShellVersion <String>]: Version of PowerShell. [PreWarmedInstanceCount <Int32?>]: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans [PublicNetworkAccess <String>]: Property to allow or block all public traffic. [PublishingUsername <String>]: Publishing user name. [PushKind <String>]: Kind of resource. [PythonVersion <String>]: Version of Python. [RemoteDebuggingEnabled <Boolean?>]: <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. [RemoteDebuggingVersion <String>]: Remote debugging version. [RequestCount <Int32?>]: Request Count. [RequestTimeInterval <String>]: Time interval. [RequestTracingEnabled <Boolean?>]: <code>true</code> if request tracing is enabled; otherwise, <code>false</code>. [RequestTracingExpirationTime <DateTime?>]: Request tracing expiration time. [ScmIPSecurityRestriction <IIPSecurityRestriction[]>]: IP security restrictions for scm. [ScmIPSecurityRestrictionsDefaultAction <DefaultAction?>]: Default action for scm access restriction if no rules are matched. [ScmIPSecurityRestrictionsUseMain <Boolean?>]: IP security restrictions for scm to use main. [ScmMinTlsVersion <SupportedTlsVersions?>]: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site [ScmType <ScmType?>]: SCM type. [SlowRequestCount <Int32?>]: Request Count. [SlowRequestPath <String>]: Request Path. [SlowRequestTimeInterval <String>]: Time interval. [SlowRequestTimeTaken <String>]: Time taken. [TagWhitelistJson <String>]: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. [TagsRequiringAuth <String>]: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. [TracingOption <String>]: Tracing options. [TriggerPrivateBytesInKb <Int32?>]: A rule based on private bytes. [TriggerSlowRequestsWithPath <ISlowRequestsBasedTrigger[]>]: A rule based on multiple Slow Requests Rule with path [Count <Int32?>]: Request Count. [Path <String>]: Request Path. [TimeInterval <String>]: Time interval. [TimeTaken <String>]: Time taken. [TriggerStatusCode <IStatusCodesBasedTrigger[]>]: A rule based on status codes. [Count <Int32?>]: Request Count. [Path <String>]: Request Path [Status <Int32?>]: HTTP status code. [SubStatus <Int32?>]: Request Sub Status. [TimeInterval <String>]: Time interval. [Win32Status <Int32?>]: Win32 error code. [TriggerStatusCodesRange <IStatusCodesRangeBasedTrigger[]>]: A rule based on status codes ranges. [Count <Int32?>]: Request Count. [Path <String>]: [StatusCode <String>]: HTTP status code. [TimeInterval <String>]: Time interval. [Use32BitWorkerProcess <Boolean?>]: <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. [VirtualApplication <IVirtualApplication[]>]: Virtual applications. [PhysicalPath <String>]: Physical path. [PreloadEnabled <Boolean?>]: <code>true</code> if preloading is enabled; otherwise, <code>false</code>. [VirtualDirectory <IVirtualDirectory[]>]: Virtual directories for virtual application. [PhysicalPath <String>]: Physical path. [VirtualPath <String>]: Path to virtual application. [VirtualPath <String>]: Virtual path. [VnetName <String>]: Virtual Network name. [VnetPrivatePortsCount <Int32?>]: The number of private ports assigned to this app. These will be assigned dynamically on runtime. [VnetRouteAllEnabled <Boolean?>]: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. [WebSocketsEnabled <Boolean?>]: <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. [WebsiteTimeZone <String>]: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones [WindowsFxVersion <String>]: Xenon App Framework and version [XManagedServiceIdentityId <Int32?>]: Explicit Managed Service Identity Id [ContainerSize <Int32?>]: Size of the function container. [CustomDomainVerificationId <String>]: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. [DailyMemoryTimeQuota <Int32?>]: Maximum allowed daily memory-time quota (applicable on dynamic apps only). [DaprConfigAppId <String>]: Dapr application identifier [DaprConfigAppPort <Int32?>]: Tells Dapr which port your application is listening on [DaprConfigEnableApiLogging <Boolean?>]: Enables API logging for the Dapr sidecar [DaprConfigEnabled <Boolean?>]: Boolean indicating if the Dapr side car is enabled [DaprConfigHttpMaxRequestSize <Int32?>]: Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. [DaprConfigHttpReadBufferSize <Int32?>]: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. [DaprConfigLogLevel <DaprLogLevel?>]: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. [DnsConfigurationDnsAltServer <String>]: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. [DnsConfigurationDnsMaxCacheTimeout <Int32?>]: Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. [DnsConfigurationDnsRetryAttemptCount <Int32?>]: Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. [DnsConfigurationDnsRetryAttemptTimeout <Int32?>]: Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. [DnsConfigurationDnsServer <String[]>]: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. [Enabled <Boolean?>]: <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline). [ExtendedLocationName <String>]: Name of extended location. [HostNameSslState <IHostNameSslState[]>]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. [HostType <HostType?>]: Indicates whether the hostname is a standard or repository hostname. [Name <String>]: Hostname. [SslState <SslState?>]: SSL type. [Thumbprint <String>]: SSL certificate thumbprint. [ToUpdate <Boolean?>]: Set to <code>true</code> to update existing hostname. [VirtualIP <String>]: Virtual IP address assigned to the hostname if IP based SSL is enabled. [HostNamesDisabled <Boolean?>]: <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process. [HostingEnvironmentProfileId <String>]: Resource ID of the App Service Environment. [HttpPerInstanceConcurrency <Single?>]: The maximum number of concurrent HTTP trigger invocations per instance. [HttpsOnly <Boolean?>]: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests [HyperV <Boolean?>]: Hyper-V sandbox. [IdentityType <ManagedServiceIdentityType?>]: Type of managed service identity. [IdentityUserAssignedIdentity <IManagedServiceIdentityUserAssignedIdentities>]: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} [(Any) <IUserAssignedIdentity>]: This indicates any property can be added to this object. [IsXenon <Boolean?>]: Obsolete: Hyper-V sandbox. [KeyVaultReferenceIdentity <String>]: Identity to use for Key Vault Reference authentication. [ManagedEnvironmentId <String>]: Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} [PublicNetworkAccess <String>]: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. [RedundancyMode <RedundancyMode?>]: Site redundancy mode [Reserved <Boolean?>]: <code>true</code> if reserved; otherwise, <code>false</code>. [ResourceConfigCpu <Double?>]: Required CPU in cores, e.g. 0.5 [ResourceConfigMemory <String>]: Required memory, e.g. "1Gi" [RuntimeName <RuntimeName?>]: Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom [RuntimeVersion <String>]: Function app runtime version. Example: 8 (for dotnet-isolated) [ScaleAndConcurrencyAlwaysReady <IFunctionsAlwaysReadyConfig[]>]: 'Always Ready' configuration for the function app. [InstanceCount <Single?>]: Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready. [Name <String>]: Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. [ScaleAndConcurrencyInstanceMemoryMb <Single?>]: Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. [ScaleAndConcurrencyMaximumInstanceCount <Single?>]: The maximum number of instances for the function app. [ScmSiteAlsoStopped <Boolean?>]: <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. [ServerFarmId <String>]: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". [StorageAccountRequired <Boolean?>]: Checks if Customer provided storage account is required [StorageType <FunctionsDeploymentStorageType?>]: Property to select Azure Storage type. Available options: blobContainer. [StorageValue <String>]: Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://<storageAccountName>.blob.core.windows.net/<containerName>. [VirtualNetworkSubnetId <String>]: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} [VnetBackupRestoreEnabled <Boolean?>]: To enable Backup and Restore operations over virtual network [VnetContentShareEnabled <Boolean?>]: To enable accessing content over virtual network [VnetImagePullEnabled <Boolean?>]: To enable pulling image over Virtual Network [VnetRouteAllEnabled <Boolean?>]: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. [WorkloadProfileName <String>]: Workload profile name for function app to execute on. .Link https://learn.microsoft.com/powershell/module/az.functions/update-azfunctionapp #> function Update-AzFunctionApp { [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite])] [CmdletBinding(DefaultParameterSetName='ByName', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='ByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # The name of the resource group. ${ResourceGroupName}, [Parameter(ParameterSetName='ByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # The name of the function app. ${Name}, [Parameter(ParameterSetName='ByName')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.DefaultInfo(Script='(Get-AzContext).Subscription.Id')] [System.String] # The Azure subscription ID. ${SubscriptionId}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # The name of the service plan. ${PlanName}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.Management.Automation.SwitchParameter] # Forces the cmdlet to update the function app without prompting for confirmation. ${Force}, [Parameter()] [Alias('AppInsightsName')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # Name of the existing App Insights project to be added to the function app. ${ApplicationInsightsName}, [Parameter()] [Alias('AppInsightsKey')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # Instrumentation key of App Insights to be added. ${ApplicationInsightsKey}, [Parameter()] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.Info(PossibleTypes=([Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IResourceTags]))] [System.Collections.Hashtable] # Resource tags. ${Tag}, [Parameter()] [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.Functions.Support.FunctionAppManagedServiceIdentityUpdateType])] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Support.ManagedServiceIdentityType] # Specifies the type of identity used for the function app. # The type 'None' will remove any identities from the function app. # The acceptable values for this parameter are: # - SystemAssigned # - UserAssigned # - None ${IdentityType}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String[]] # Specifies the list of user 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/identities/{identityName}' ${IdentityID}, [Parameter(ParameterSetName='ByObjectInput', Mandatory, ValueFromPipeline)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite] # To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ${InputObject}, [Parameter()] [Alias('AzureRMContext', 'AzureCredential')] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Azure')] [System.Management.Automation.PSObject] ${DefaultProfile}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] # 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. ${NoWait}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Runs the cmdlet as a background job. ${AsJob}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelinePrepend}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Uri] ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.PSCredential] ${ProxyCredential}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName if ($null -eq [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion) { [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion = $PSVersionTable.PSVersion.ToString() } $preTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId if ($preTelemetryId -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId =(New-Guid).ToString() [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Create', $MyInvocation, $parameterSet, $PSCmdlet) } else { $internalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets if ($internalCalledCmdlets -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $MyInvocation.MyCommand.Name } else { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets += ',' + $MyInvocation.MyCommand.Name } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = 'internal' } $mapping = @{ ByName = 'Az.Functions.custom\Update-AzFunctionApp'; ByObjectInput = 'Az.Functions.custom\Update-AzFunctionApp'; } if (('ByName') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $testPlayback = $false $PSBoundParameters['HttpPipelinePrepend'] | Foreach-Object { if ($_) { $testPlayback = $testPlayback -or ('Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.PipelineMock' -eq $_.Target.GetType().FullName -and 'Playback' -eq $_.Target.Mode) } } if ($testPlayback) { $PSBoundParameters['SubscriptionId'] = . (Join-Path $PSScriptRoot '..' 'utils' 'Get-SubscriptionIdTestSafe.ps1') } else { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id } } $cmdInfo = Get-Command -Name $mapping[$parameterSet] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessCustomAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) if ($null -ne $MyInvocation.MyCommand -and [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets -notcontains $MyInvocation.MyCommand.Name -and [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ContainsPreviewAttribute($cmdInfo, $MyInvocation)){ [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessPreviewMessageAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets.Enqueue($MyInvocation.MyCommand.Name) } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } process { try { $steppablePipeline.Process($_) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } finally { $backupTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId $backupInternalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } } end { try { $steppablePipeline.End() [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $backupTelemetryId [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $backupInternalCalledCmdlets if ($preTelemetryId -eq '') { [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Send', $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $preTelemetryId } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } } <# .Synopsis Updates a function app service plan. .Description Updates a function app service plan. .Example Update-AzFunctionAppPlan -ResourceGroupName MyResourceGroupName ` -Name MyPremiumPlan ` -MaximumWorkerCount 20 ` -Sku EP2 ` -Force .Inputs Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IAppServicePlan .Outputs Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IAppServicePlan .Notes COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. INPUTOBJECT <IAppServicePlan>: Location <String>: Resource Location. [Kind <String>]: Kind of resource. [Tag <IResourceTags>]: Resource tags. [(Any) <String>]: This indicates any property can be added to this object. [Capacity <Int32?>]: Current number of instances assigned to the resource. [ElasticScaleEnabled <Boolean?>]: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku [ExtendedLocationName <String>]: Name of extended location. [FreeOfferExpirationTime <DateTime?>]: The time when the server farm free offer expires. [HostingEnvironmentProfileId <String>]: Resource ID of the App Service Environment. [HyperV <Boolean?>]: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise. [IsSpot <Boolean?>]: If <code>true</code>, this App Service Plan owns spot instances. [IsXenon <Boolean?>]: Obsolete: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise. [KubeEnvironmentProfileId <String>]: Resource ID of the Kubernetes Environment. [MaximumElasticWorkerCount <Int32?>]: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan [PerSiteScaling <Boolean?>]: If <code>true</code>, apps assigned to this App Service plan can be scaled independently. If <code>false</code>, apps assigned to this App Service plan will scale to all instances of the plan. [Reserved <Boolean?>]: If Linux app service plan <code>true</code>, <code>false</code> otherwise. [SkuCapability <ICapability[]>]: Capabilities of the SKU, e.g., is traffic manager enabled? [Name <String>]: Name of the SKU capability. [Reason <String>]: Reason of the SKU capability. [Value <String>]: Value of the SKU capability. [SkuCapacityDefault <Int32?>]: Default number of workers for this App Service plan SKU. [SkuCapacityElasticMaximum <Int32?>]: Maximum number of Elastic workers for this App Service plan SKU. [SkuCapacityMaximum <Int32?>]: Maximum number of workers for this App Service plan SKU. [SkuCapacityMinimum <Int32?>]: Minimum number of workers for this App Service plan SKU. [SkuCapacityScaleType <String>]: Available scale configurations for an App Service plan. [SkuFamily <String>]: Family code of the resource SKU. [SkuLocation <String[]>]: Locations of the SKU. [SkuName <String>]: Name of the resource SKU. [SkuSize <String>]: Size specifier of the resource SKU. [SkuTier <String>]: Service tier of the resource SKU. [SpotExpirationTime <DateTime?>]: The time when the server farm expires. Valid only if it is a spot server farm. [TargetWorkerCount <Int32?>]: Scaling worker count. [TargetWorkerSizeId <Int32?>]: Scaling worker size ID. [WorkerTierName <String>]: Target worker tier assigned to the App Service plan. [ZoneRedundant <Boolean?>]: If <code>true</code>, this App Service Plan will perform availability zone balancing. If <code>false</code>, this App Service Plan will not perform availability zone balancing. .Link https://learn.microsoft.com/powershell/module/az.functions/update-azfunctionappplan #> function Update-AzFunctionAppPlan { [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IAppServicePlan])] [CmdletBinding(DefaultParameterSetName='ByName', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='ByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] # Name of the resource group to which the resource belongs. ${ResourceGroupName}, [Parameter(ParameterSetName='ByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] # Name of the App Service plan. ${Name}, [Parameter(ParameterSetName='ByName')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.DefaultInfo(Script='(Get-AzContext).Subscription.Id')] [System.String] # The Azure subscription ID. ${SubscriptionId}, [Parameter()] [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.Functions.Support.SkuType])] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.String] # The plan sku. # Valid inputs are: EP1, EP2, EP3 ${Sku}, [Parameter()] [Alias('MaxBurst')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.Int32] # The maximum number of workers for the app service plan. ${MaximumWorkerCount}, [Parameter()] [Alias('MinInstances')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.Int32] # The minimum number of workers for the app service plan. ${MinimumWorkerCount}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.Management.Automation.SwitchParameter] # Forces the cmdlet to update the function app plan without prompting for confirmation. ${Force}, [Parameter()] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.Info(PossibleTypes=([Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IResourceTags]))] [System.Collections.Hashtable] # Resource tags. ${Tag}, [Parameter(ParameterSetName='ByObjectInput', Mandatory, ValueFromPipeline)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IAppServicePlan] # To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ${InputObject}, [Parameter()] [Alias('AzureRMContext', 'AzureCredential')] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Azure')] [System.Management.Automation.PSObject] ${DefaultProfile}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Run the command asynchronously. ${NoWait}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Run the command as a job. ${AsJob}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelinePrepend}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Uri] ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.PSCredential] ${ProxyCredential}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName if ($null -eq [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion) { [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion = $PSVersionTable.PSVersion.ToString() } $preTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId if ($preTelemetryId -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId =(New-Guid).ToString() [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Create', $MyInvocation, $parameterSet, $PSCmdlet) } else { $internalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets if ($internalCalledCmdlets -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $MyInvocation.MyCommand.Name } else { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets += ',' + $MyInvocation.MyCommand.Name } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = 'internal' } $mapping = @{ ByName = 'Az.Functions.custom\Update-AzFunctionAppPlan'; ByObjectInput = 'Az.Functions.custom\Update-AzFunctionAppPlan'; } if (('ByName') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $testPlayback = $false $PSBoundParameters['HttpPipelinePrepend'] | Foreach-Object { if ($_) { $testPlayback = $testPlayback -or ('Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.PipelineMock' -eq $_.Target.GetType().FullName -and 'Playback' -eq $_.Target.Mode) } } if ($testPlayback) { $PSBoundParameters['SubscriptionId'] = . (Join-Path $PSScriptRoot '..' 'utils' 'Get-SubscriptionIdTestSafe.ps1') } else { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id } } $cmdInfo = Get-Command -Name $mapping[$parameterSet] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessCustomAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) if ($null -ne $MyInvocation.MyCommand -and [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets -notcontains $MyInvocation.MyCommand.Name -and [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ContainsPreviewAttribute($cmdInfo, $MyInvocation)){ [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessPreviewMessageAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets.Enqueue($MyInvocation.MyCommand.Name) } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } process { try { $steppablePipeline.Process($_) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } finally { $backupTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId $backupInternalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } } end { try { $steppablePipeline.End() [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $backupTelemetryId [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $backupInternalCalledCmdlets if ($preTelemetryId -eq '') { [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Send', $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $preTelemetryId } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } } <# .Synopsis Adds or updates app settings in a function app. .Description Adds or updates app settings in a function app. .Example Update-AzFunctionAppSetting -Name MyAppName -ResourceGroupName MyResourceGroupName -AppSetting @{"Name1" = "Value1"} .Inputs Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite .Outputs Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IStringDictionary .Notes COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. INPUTOBJECT <ISite>: Location <String>: Resource Location. [Kind <String>]: Kind of resource. [Tag <IResourceTags>]: Resource tags. [(Any) <String>]: This indicates any property can be added to this object. [AuthenticationStorageAccountConnectionStringName <String>]: Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. [AuthenticationType <AuthenticationType?>]: Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. [AuthenticationUserAssignedIdentityResourceId <String>]: Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. [ClientAffinityEnabled <Boolean?>]: <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>. [ClientCertEnabled <Boolean?>]: <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. [ClientCertExclusionPath <String>]: client certificate authentication comma-separated exclusion paths [ClientCertMode <ClientCertMode?>]: This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. [CloningInfoAppSettingsOverride <ICloningInfoAppSettingsOverrides>]: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. [(Any) <String>]: This indicates any property can be added to this object. [CloningInfoCloneCustomHostName <Boolean?>]: <code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>. [CloningInfoCloneSourceControl <Boolean?>]: <code>true</code> to clone source control from source app; otherwise, <code>false</code>. [CloningInfoConfigureLoadBalancing <Boolean?>]: <code>true</code> to configure load balancing for source and destination app. [CloningInfoCorrelationId <String>]: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. [CloningInfoHostingEnvironment <String>]: App Service Environment. [CloningInfoOverwrite <Boolean?>]: <code>true</code> to overwrite destination app; otherwise, <code>false</code>. [CloningInfoSourceWebAppId <String>]: ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. [CloningInfoSourceWebAppLocation <String>]: Location of source app ex: West US or North Europe [CloningInfoTrafficManagerProfileId <String>]: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. [CloningInfoTrafficManagerProfileName <String>]: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. [Config <ISiteConfig>]: Configuration of the app. [AcrUseManagedIdentityCred <Boolean?>]: Flag to use Managed Identity Creds for ACR pull [AcrUserManagedIdentityId <String>]: If using user managed identity, the user managed identity ClientId [ActionMinProcessExecutionTime <String>]: Minimum time the process must execute before taking the action [ActionType <AutoHealActionType?>]: Predefined action to be taken. [AlwaysOn <Boolean?>]: <code>true</code> if Always On is enabled; otherwise, <code>false</code>. [ApiDefinitionUrl <String>]: The URL of the API definition. [ApiManagementConfigId <String>]: APIM-Api Identifier. [AppCommandLine <String>]: App command line to launch. [AppSetting <INameValuePair[]>]: Application settings. [Name <String>]: Pair name. [Value <String>]: Pair value. [AutoHealEnabled <Boolean?>]: <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. [AutoSwapSlotName <String>]: Auto-swap slot name. [AzureStorageAccount <ISiteConfigAzureStorageAccounts>]: List of Azure Storage Accounts. [(Any) <IAzureStorageInfoValue>]: This indicates any property can be added to this object. [ConnectionString <IConnStringInfo[]>]: Connection strings. [ConnectionString <String>]: Connection string value. [Name <String>]: Name of connection string. [Type <ConnectionStringType?>]: Type of database. [CorAllowedOrigin <String[]>]: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. [CorSupportCredentials <Boolean?>]: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. [CustomActionExe <String>]: Executable to be run. [CustomActionParameter <String>]: Parameters for the executable. [DefaultDocument <String[]>]: Default documents. [DetailedErrorLoggingEnabled <Boolean?>]: <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. [DocumentRoot <String>]: Document root. [DynamicTagsJson <String>]: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. [ElasticWebAppScaleLimit <Int32?>]: Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is <code>true</code> [ExperimentRampUpRule <IRampUpRule[]>]: List of ramp-up rules. [ActionHostName <String>]: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. [ChangeDecisionCallbackUrl <String>]: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/ [ChangeIntervalInMinute <Int32?>]: Specifies interval in minutes to reevaluate ReroutePercentage. [ChangeStep <Double?>]: In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>. [MaxReroutePercentage <Double?>]: Specifies upper boundary below which ReroutePercentage will stay. [MinReroutePercentage <Double?>]: Specifies lower boundary above which ReroutePercentage will stay. [Name <String>]: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. [ReroutePercentage <Double?>]: Percentage of the traffic which will be redirected to <code>ActionHostName</code>. [FtpsState <FtpsState?>]: State of FTP / FTPS service [FunctionAppScaleLimit <Int32?>]: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans [FunctionsRuntimeScaleMonitoringEnabled <Boolean?>]: Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status. [HandlerMapping <IHandlerMapping[]>]: Handler mappings. [Argument <String>]: Command-line arguments to be passed to the script processor. [Extension <String>]: Requests with this extension will be handled using the specified FastCGI application. [ScriptProcessor <String>]: The absolute path to the FastCGI application. [HealthCheckPath <String>]: Health check path [Http20Enabled <Boolean?>]: Http20Enabled: configures a web site to allow clients to connect over http2.0 [HttpLoggingEnabled <Boolean?>]: <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. [IPSecurityRestriction <IIPSecurityRestriction[]>]: IP security restrictions for main. [Action <String>]: Allow or Deny access for this IP range. [Description <String>]: IP restriction rule description. [Header <IIPSecurityRestrictionHeaders>]: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. [(Any) <String[]>]: This indicates any property can be added to this object. [IPAddress <String>]: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. [Name <String>]: IP restriction rule name. [Priority <Int32?>]: Priority of IP restriction rule. [SubnetMask <String>]: Subnet mask for the range of IP addresses the restriction is valid for. [SubnetTrafficTag <Int32?>]: (internal) Subnet traffic tag [Tag <IPFilterTag?>]: Defines what this IP filter will be used for. This is to support IP filtering on proxies. [VnetSubnetResourceId <String>]: Virtual network resource id [VnetTrafficTag <Int32?>]: (internal) Vnet traffic tag [IPSecurityRestrictionsDefaultAction <DefaultAction?>]: Default action for main access restriction if no rules are matched. [IsPushEnabled <Boolean?>]: Gets or sets a flag indicating whether the Push endpoint is enabled. [JavaContainer <String>]: Java container. [JavaContainerVersion <String>]: Java container version. [JavaVersion <String>]: Java version. [KeyVaultReferenceIdentity <String>]: Identity to use for Key Vault Reference authentication. [LimitMaxDiskSizeInMb <Int64?>]: Maximum allowed disk size usage in MB. [LimitMaxMemoryInMb <Int64?>]: Maximum allowed memory usage in MB. [LimitMaxPercentageCpu <Double?>]: Maximum allowed CPU usage percentage. [LinuxFxVersion <String>]: Linux App Framework and version [LoadBalancing <SiteLoadBalancing?>]: Site load balancing. [LocalMySqlEnabled <Boolean?>]: <code>true</code> to enable local MySQL; otherwise, <code>false</code>. [LogsDirectorySizeLimit <Int32?>]: HTTP logs directory size limit. [MachineKeyDecryption <String>]: Algorithm used for decryption. [MachineKeyDecryptionKey <String>]: Decryption key. [MachineKeyValidation <String>]: MachineKey validation. [MachineKeyValidationKey <String>]: Validation key. [ManagedPipelineMode <ManagedPipelineMode?>]: Managed pipeline mode. [ManagedServiceIdentityId <Int32?>]: Managed Service Identity Id [Metadata <INameValuePair[]>]: Application metadata. This property cannot be retrieved, since it may contain secrets. [MinTlsCipherSuite <TlsCipherSuites?>]: The minimum strength TLS cipher suite allowed for an application [MinTlsVersion <SupportedTlsVersions?>]: MinTlsVersion: configures the minimum version of TLS required for SSL requests [MinimumElasticInstanceCount <Int32?>]: Number of minimum instance count for a site This setting only applies to the Elastic Plans [NetFrameworkVersion <String>]: .NET Framework version. [NodeVersion <String>]: Version of Node.js. [NumberOfWorker <Int32?>]: Number of workers. [PhpVersion <String>]: Version of PHP. [PowerShellVersion <String>]: Version of PowerShell. [PreWarmedInstanceCount <Int32?>]: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans [PublicNetworkAccess <String>]: Property to allow or block all public traffic. [PublishingUsername <String>]: Publishing user name. [PushKind <String>]: Kind of resource. [PythonVersion <String>]: Version of Python. [RemoteDebuggingEnabled <Boolean?>]: <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. [RemoteDebuggingVersion <String>]: Remote debugging version. [RequestCount <Int32?>]: Request Count. [RequestTimeInterval <String>]: Time interval. [RequestTracingEnabled <Boolean?>]: <code>true</code> if request tracing is enabled; otherwise, <code>false</code>. [RequestTracingExpirationTime <DateTime?>]: Request tracing expiration time. [ScmIPSecurityRestriction <IIPSecurityRestriction[]>]: IP security restrictions for scm. [ScmIPSecurityRestrictionsDefaultAction <DefaultAction?>]: Default action for scm access restriction if no rules are matched. [ScmIPSecurityRestrictionsUseMain <Boolean?>]: IP security restrictions for scm to use main. [ScmMinTlsVersion <SupportedTlsVersions?>]: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site [ScmType <ScmType?>]: SCM type. [SlowRequestCount <Int32?>]: Request Count. [SlowRequestPath <String>]: Request Path. [SlowRequestTimeInterval <String>]: Time interval. [SlowRequestTimeTaken <String>]: Time taken. [TagWhitelistJson <String>]: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. [TagsRequiringAuth <String>]: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. [TracingOption <String>]: Tracing options. [TriggerPrivateBytesInKb <Int32?>]: A rule based on private bytes. [TriggerSlowRequestsWithPath <ISlowRequestsBasedTrigger[]>]: A rule based on multiple Slow Requests Rule with path [Count <Int32?>]: Request Count. [Path <String>]: Request Path. [TimeInterval <String>]: Time interval. [TimeTaken <String>]: Time taken. [TriggerStatusCode <IStatusCodesBasedTrigger[]>]: A rule based on status codes. [Count <Int32?>]: Request Count. [Path <String>]: Request Path [Status <Int32?>]: HTTP status code. [SubStatus <Int32?>]: Request Sub Status. [TimeInterval <String>]: Time interval. [Win32Status <Int32?>]: Win32 error code. [TriggerStatusCodesRange <IStatusCodesRangeBasedTrigger[]>]: A rule based on status codes ranges. [Count <Int32?>]: Request Count. [Path <String>]: [StatusCode <String>]: HTTP status code. [TimeInterval <String>]: Time interval. [Use32BitWorkerProcess <Boolean?>]: <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. [VirtualApplication <IVirtualApplication[]>]: Virtual applications. [PhysicalPath <String>]: Physical path. [PreloadEnabled <Boolean?>]: <code>true</code> if preloading is enabled; otherwise, <code>false</code>. [VirtualDirectory <IVirtualDirectory[]>]: Virtual directories for virtual application. [PhysicalPath <String>]: Physical path. [VirtualPath <String>]: Path to virtual application. [VirtualPath <String>]: Virtual path. [VnetName <String>]: Virtual Network name. [VnetPrivatePortsCount <Int32?>]: The number of private ports assigned to this app. These will be assigned dynamically on runtime. [VnetRouteAllEnabled <Boolean?>]: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. [WebSocketsEnabled <Boolean?>]: <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. [WebsiteTimeZone <String>]: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones [WindowsFxVersion <String>]: Xenon App Framework and version [XManagedServiceIdentityId <Int32?>]: Explicit Managed Service Identity Id [ContainerSize <Int32?>]: Size of the function container. [CustomDomainVerificationId <String>]: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. [DailyMemoryTimeQuota <Int32?>]: Maximum allowed daily memory-time quota (applicable on dynamic apps only). [DaprConfigAppId <String>]: Dapr application identifier [DaprConfigAppPort <Int32?>]: Tells Dapr which port your application is listening on [DaprConfigEnableApiLogging <Boolean?>]: Enables API logging for the Dapr sidecar [DaprConfigEnabled <Boolean?>]: Boolean indicating if the Dapr side car is enabled [DaprConfigHttpMaxRequestSize <Int32?>]: Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. [DaprConfigHttpReadBufferSize <Int32?>]: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. [DaprConfigLogLevel <DaprLogLevel?>]: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. [DnsConfigurationDnsAltServer <String>]: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. [DnsConfigurationDnsMaxCacheTimeout <Int32?>]: Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. [DnsConfigurationDnsRetryAttemptCount <Int32?>]: Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. [DnsConfigurationDnsRetryAttemptTimeout <Int32?>]: Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. [DnsConfigurationDnsServer <String[]>]: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. [Enabled <Boolean?>]: <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline). [ExtendedLocationName <String>]: Name of extended location. [HostNameSslState <IHostNameSslState[]>]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. [HostType <HostType?>]: Indicates whether the hostname is a standard or repository hostname. [Name <String>]: Hostname. [SslState <SslState?>]: SSL type. [Thumbprint <String>]: SSL certificate thumbprint. [ToUpdate <Boolean?>]: Set to <code>true</code> to update existing hostname. [VirtualIP <String>]: Virtual IP address assigned to the hostname if IP based SSL is enabled. [HostNamesDisabled <Boolean?>]: <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process. [HostingEnvironmentProfileId <String>]: Resource ID of the App Service Environment. [HttpPerInstanceConcurrency <Single?>]: The maximum number of concurrent HTTP trigger invocations per instance. [HttpsOnly <Boolean?>]: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests [HyperV <Boolean?>]: Hyper-V sandbox. [IdentityType <ManagedServiceIdentityType?>]: Type of managed service identity. [IdentityUserAssignedIdentity <IManagedServiceIdentityUserAssignedIdentities>]: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} [(Any) <IUserAssignedIdentity>]: This indicates any property can be added to this object. [IsXenon <Boolean?>]: Obsolete: Hyper-V sandbox. [KeyVaultReferenceIdentity <String>]: Identity to use for Key Vault Reference authentication. [ManagedEnvironmentId <String>]: Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} [PublicNetworkAccess <String>]: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. [RedundancyMode <RedundancyMode?>]: Site redundancy mode [Reserved <Boolean?>]: <code>true</code> if reserved; otherwise, <code>false</code>. [ResourceConfigCpu <Double?>]: Required CPU in cores, e.g. 0.5 [ResourceConfigMemory <String>]: Required memory, e.g. "1Gi" [RuntimeName <RuntimeName?>]: Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom [RuntimeVersion <String>]: Function app runtime version. Example: 8 (for dotnet-isolated) [ScaleAndConcurrencyAlwaysReady <IFunctionsAlwaysReadyConfig[]>]: 'Always Ready' configuration for the function app. [InstanceCount <Single?>]: Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready. [Name <String>]: Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. [ScaleAndConcurrencyInstanceMemoryMb <Single?>]: Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. [ScaleAndConcurrencyMaximumInstanceCount <Single?>]: The maximum number of instances for the function app. [ScmSiteAlsoStopped <Boolean?>]: <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. [ServerFarmId <String>]: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". [StorageAccountRequired <Boolean?>]: Checks if Customer provided storage account is required [StorageType <FunctionsDeploymentStorageType?>]: Property to select Azure Storage type. Available options: blobContainer. [StorageValue <String>]: Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://<storageAccountName>.blob.core.windows.net/<containerName>. [VirtualNetworkSubnetId <String>]: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} [VnetBackupRestoreEnabled <Boolean?>]: To enable Backup and Restore operations over virtual network [VnetContentShareEnabled <Boolean?>]: To enable accessing content over virtual network [VnetImagePullEnabled <Boolean?>]: To enable pulling image over Virtual Network [VnetRouteAllEnabled <Boolean?>]: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. [WorkloadProfileName <String>]: Workload profile name for function app to execute on. .Link https://learn.microsoft.com/powershell/module/az.functions/update-azfunctionappsetting #> function Update-AzFunctionAppSetting { [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IStringDictionary])] [CmdletBinding(DefaultParameterSetName='ByName', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='ByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] # Name of the function app. ${Name}, [Parameter(ParameterSetName='ByName', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [System.String] # Name of the resource group to which the resource belongs. ${ResourceGroupName}, [Parameter(ParameterSetName='ByName')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.DefaultInfo(Script='(Get-AzContext).Subscription.Id')] [System.String] # The Azure subscription ID. ${SubscriptionId}, [Parameter(Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.Collections.Hashtable] # Hashtable with keys and values describe the app settings to be added or updated in the function app. # For example: @{"myappsetting"="123"} ${AppSetting}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [System.Management.Automation.SwitchParameter] # Forces the cmdlet to update function app setting without prompting for confirmation. ${Force}, [Parameter(ParameterSetName='ByObjectInput', Mandatory, ValueFromPipeline)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite] # To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ${InputObject}, [Parameter()] [Alias('AzureRMContext', 'AzureCredential')] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Azure')] [System.Management.Automation.PSObject] ${DefaultProfile}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.SendAsyncStep[]] ${HttpPipelinePrepend}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Uri] ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.PSCredential] ${ProxyCredential}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName if ($null -eq [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion) { [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PowerShellVersion = $PSVersionTable.PSVersion.ToString() } $preTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId if ($preTelemetryId -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId =(New-Guid).ToString() [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Create', $MyInvocation, $parameterSet, $PSCmdlet) } else { $internalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets if ($internalCalledCmdlets -eq '') { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $MyInvocation.MyCommand.Name } else { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets += ',' + $MyInvocation.MyCommand.Name } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = 'internal' } $mapping = @{ ByName = 'Az.Functions.custom\Update-AzFunctionAppSetting'; ByObjectInput = 'Az.Functions.custom\Update-AzFunctionAppSetting'; } if (('ByName') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $testPlayback = $false $PSBoundParameters['HttpPipelinePrepend'] | Foreach-Object { if ($_) { $testPlayback = $testPlayback -or ('Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.PipelineMock' -eq $_.Target.GetType().FullName -and 'Playback' -eq $_.Target.Mode) } } if ($testPlayback) { $PSBoundParameters['SubscriptionId'] = . (Join-Path $PSScriptRoot '..' 'utils' 'Get-SubscriptionIdTestSafe.ps1') } else { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id } } $cmdInfo = Get-Command -Name $mapping[$parameterSet] [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessCustomAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) if ($null -ne $MyInvocation.MyCommand -and [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets -notcontains $MyInvocation.MyCommand.Name -and [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ContainsPreviewAttribute($cmdInfo, $MyInvocation)){ [Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.MessageAttributeHelper]::ProcessPreviewMessageAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet]::PromptedPreviewMessageCmdlets.Enqueue($MyInvocation.MyCommand.Name) } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } process { try { $steppablePipeline.Process($_) } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } finally { $backupTelemetryId = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId $backupInternalCalledCmdlets = [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } } end { try { $steppablePipeline.End() [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $backupTelemetryId [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::InternalCalledCmdlets = $backupInternalCalledCmdlets if ($preTelemetryId -eq '') { [Microsoft.Azure.PowerShell.Cmdlets.Functions.module]::Instance.Telemetry.Invoke('Send', $MyInvocation, $parameterSet, $PSCmdlet) [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() } [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::TelemetryId = $preTelemetryId } catch { [Microsoft.WindowsAzure.Commands.Common.MetricHelper]::ClearTelemetryContext() throw } } } # SIG # Begin signature block # MIIoQwYJKoZIhvcNAQcCoIIoNDCCKDACAQExDzANBglghkgBZQMEAgEFADB5Bgor # BgEEAYI3AgEEoGswaTA0BgorBgEEAYI3AgEeMCYCAwEAAAQQH8w7YFlLCE63JNLG # KX7zUQIBAAIBAAIBAAIBAAIBADAxMA0GCWCGSAFlAwQCAQUABCD9xRZV1AfC/8dK # Dq6vhVadfkBjd74xrIHN8ZC9Z8I8ZqCCDXYwggX0MIID3KADAgECAhMzAAAEBGx0 # Bv9XKydyAAAAAAQEMA0GCSqGSIb3DQEBCwUAMH4xCzAJBgNVBAYTAlVTMRMwEQYD # VQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNy # b3NvZnQgQ29ycG9yYXRpb24xKDAmBgNVBAMTH01pY3Jvc29mdCBDb2RlIFNpZ25p # bmcgUENBIDIwMTEwHhcNMjQwOTEyMjAxMTE0WhcNMjUwOTExMjAxMTE0WjB0MQsw # CQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9u # ZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMR4wHAYDVQQDExVNaWNy # b3NvZnQgQ29ycG9yYXRpb24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB # AQC0KDfaY50MDqsEGdlIzDHBd6CqIMRQWW9Af1LHDDTuFjfDsvna0nEuDSYJmNyz # NB10jpbg0lhvkT1AzfX2TLITSXwS8D+mBzGCWMM/wTpciWBV/pbjSazbzoKvRrNo # DV/u9omOM2Eawyo5JJJdNkM2d8qzkQ0bRuRd4HarmGunSouyb9NY7egWN5E5lUc3 # a2AROzAdHdYpObpCOdeAY2P5XqtJkk79aROpzw16wCjdSn8qMzCBzR7rvH2WVkvF # HLIxZQET1yhPb6lRmpgBQNnzidHV2Ocxjc8wNiIDzgbDkmlx54QPfw7RwQi8p1fy # 4byhBrTjv568x8NGv3gwb0RbAgMBAAGjggFzMIIBbzAfBgNVHSUEGDAWBgorBgEE # AYI3TAgBBggrBgEFBQcDAzAdBgNVHQ4EFgQU8huhNbETDU+ZWllL4DNMPCijEU4w # RQYDVR0RBD4wPKQ6MDgxHjAcBgNVBAsTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEW # MBQGA1UEBRMNMjMwMDEyKzUwMjkyMzAfBgNVHSMEGDAWgBRIbmTlUAXTgqoXNzci # tW2oynUClTBUBgNVHR8ETTBLMEmgR6BFhkNodHRwOi8vd3d3Lm1pY3Jvc29mdC5j # b20vcGtpb3BzL2NybC9NaWNDb2RTaWdQQ0EyMDExXzIwMTEtMDctMDguY3JsMGEG # CCsGAQUFBwEBBFUwUzBRBggrBgEFBQcwAoZFaHR0cDovL3d3dy5taWNyb3NvZnQu # Y29tL3BraW9wcy9jZXJ0cy9NaWNDb2RTaWdQQ0EyMDExXzIwMTEtMDctMDguY3J0 # MAwGA1UdEwEB/wQCMAAwDQYJKoZIhvcNAQELBQADggIBAIjmD9IpQVvfB1QehvpC # Ge7QeTQkKQ7j3bmDMjwSqFL4ri6ae9IFTdpywn5smmtSIyKYDn3/nHtaEn0X1NBj # L5oP0BjAy1sqxD+uy35B+V8wv5GrxhMDJP8l2QjLtH/UglSTIhLqyt8bUAqVfyfp # h4COMRvwwjTvChtCnUXXACuCXYHWalOoc0OU2oGN+mPJIJJxaNQc1sjBsMbGIWv3 # cmgSHkCEmrMv7yaidpePt6V+yPMik+eXw3IfZ5eNOiNgL1rZzgSJfTnvUqiaEQ0X # dG1HbkDv9fv6CTq6m4Ty3IzLiwGSXYxRIXTxT4TYs5VxHy2uFjFXWVSL0J2ARTYL # E4Oyl1wXDF1PX4bxg1yDMfKPHcE1Ijic5lx1KdK1SkaEJdto4hd++05J9Bf9TAmi # u6EK6C9Oe5vRadroJCK26uCUI4zIjL/qG7mswW+qT0CW0gnR9JHkXCWNbo8ccMk1 # sJatmRoSAifbgzaYbUz8+lv+IXy5GFuAmLnNbGjacB3IMGpa+lbFgih57/fIhamq # 5VhxgaEmn/UjWyr+cPiAFWuTVIpfsOjbEAww75wURNM1Imp9NJKye1O24EspEHmb # DmqCUcq7NqkOKIG4PVm3hDDED/WQpzJDkvu4FrIbvyTGVU01vKsg4UfcdiZ0fQ+/ # V0hf8yrtq9CkB8iIuk5bBxuPMIIHejCCBWKgAwIBAgIKYQ6Q0gAAAAAAAzANBgkq # hkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24x # EDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlv # bjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5 # IDIwMTEwHhcNMTEwNzA4MjA1OTA5WhcNMjYwNzA4MjEwOTA5WjB+MQswCQYDVQQG # EwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwG # A1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSgwJgYDVQQDEx9NaWNyb3NvZnQg # Q29kZSBTaWduaW5nIFBDQSAyMDExMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIIC # CgKCAgEAq/D6chAcLq3YbqqCEE00uvK2WCGfQhsqa+laUKq4BjgaBEm6f8MMHt03 # a8YS2AvwOMKZBrDIOdUBFDFC04kNeWSHfpRgJGyvnkmc6Whe0t+bU7IKLMOv2akr # rnoJr9eWWcpgGgXpZnboMlImEi/nqwhQz7NEt13YxC4Ddato88tt8zpcoRb0Rrrg # OGSsbmQ1eKagYw8t00CT+OPeBw3VXHmlSSnnDb6gE3e+lD3v++MrWhAfTVYoonpy # 4BI6t0le2O3tQ5GD2Xuye4Yb2T6xjF3oiU+EGvKhL1nkkDstrjNYxbc+/jLTswM9 # sbKvkjh+0p2ALPVOVpEhNSXDOW5kf1O6nA+tGSOEy/S6A4aN91/w0FK/jJSHvMAh # dCVfGCi2zCcoOCWYOUo2z3yxkq4cI6epZuxhH2rhKEmdX4jiJV3TIUs+UsS1Vz8k # A/DRelsv1SPjcF0PUUZ3s/gA4bysAoJf28AVs70b1FVL5zmhD+kjSbwYuER8ReTB # w3J64HLnJN+/RpnF78IcV9uDjexNSTCnq47f7Fufr/zdsGbiwZeBe+3W7UvnSSmn # Eyimp31ngOaKYnhfsi+E11ecXL93KCjx7W3DKI8sj0A3T8HhhUSJxAlMxdSlQy90 # lfdu+HggWCwTXWCVmj5PM4TasIgX3p5O9JawvEagbJjS4NaIjAsCAwEAAaOCAe0w # ggHpMBAGCSsGAQQBgjcVAQQDAgEAMB0GA1UdDgQWBBRIbmTlUAXTgqoXNzcitW2o # ynUClTAZBgkrBgEEAYI3FAIEDB4KAFMAdQBiAEMAQTALBgNVHQ8EBAMCAYYwDwYD # VR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBRyLToCMZBDuRQFTuHqp8cx0SOJNDBa # BgNVHR8EUzBRME+gTaBLhklodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2Ny # bC9wcm9kdWN0cy9NaWNSb29DZXJBdXQyMDExXzIwMTFfMDNfMjIuY3JsMF4GCCsG # AQUFBwEBBFIwUDBOBggrBgEFBQcwAoZCaHR0cDovL3d3dy5taWNyb3NvZnQuY29t # L3BraS9jZXJ0cy9NaWNSb29DZXJBdXQyMDExXzIwMTFfMDNfMjIuY3J0MIGfBgNV # HSAEgZcwgZQwgZEGCSsGAQQBgjcuAzCBgzA/BggrBgEFBQcCARYzaHR0cDovL3d3 # dy5taWNyb3NvZnQuY29tL3BraW9wcy9kb2NzL3ByaW1hcnljcHMuaHRtMEAGCCsG # AQUFBwICMDQeMiAdAEwAZQBnAGEAbABfAHAAbwBsAGkAYwB5AF8AcwB0AGEAdABl # AG0AZQBuAHQALiAdMA0GCSqGSIb3DQEBCwUAA4ICAQBn8oalmOBUeRou09h0ZyKb # C5YR4WOSmUKWfdJ5DJDBZV8uLD74w3LRbYP+vj/oCso7v0epo/Np22O/IjWll11l # hJB9i0ZQVdgMknzSGksc8zxCi1LQsP1r4z4HLimb5j0bpdS1HXeUOeLpZMlEPXh6 # I/MTfaaQdION9MsmAkYqwooQu6SpBQyb7Wj6aC6VoCo/KmtYSWMfCWluWpiW5IP0 # wI/zRive/DvQvTXvbiWu5a8n7dDd8w6vmSiXmE0OPQvyCInWH8MyGOLwxS3OW560 # STkKxgrCxq2u5bLZ2xWIUUVYODJxJxp/sfQn+N4sOiBpmLJZiWhub6e3dMNABQam # ASooPoI/E01mC8CzTfXhj38cbxV9Rad25UAqZaPDXVJihsMdYzaXht/a8/jyFqGa # J+HNpZfQ7l1jQeNbB5yHPgZ3BtEGsXUfFL5hYbXw3MYbBL7fQccOKO7eZS/sl/ah # XJbYANahRr1Z85elCUtIEJmAH9AAKcWxm6U/RXceNcbSoqKfenoi+kiVH6v7RyOA # 9Z74v2u3S5fi63V4GuzqN5l5GEv/1rMjaHXmr/r8i+sLgOppO6/8MO0ETI7f33Vt # Y5E90Z1WTk+/gFcioXgRMiF670EKsT/7qMykXcGhiJtXcVZOSEXAQsmbdlsKgEhr # /Xmfwb1tbWrJUnMTDXpQzTGCGiMwghofAgEBMIGVMH4xCzAJBgNVBAYTAlVTMRMw # EQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVN # aWNyb3NvZnQgQ29ycG9yYXRpb24xKDAmBgNVBAMTH01pY3Jvc29mdCBDb2RlIFNp # Z25pbmcgUENBIDIwMTECEzMAAAQEbHQG/1crJ3IAAAAABAQwDQYJYIZIAWUDBAIB # BQCgga4wGQYJKoZIhvcNAQkDMQwGCisGAQQBgjcCAQQwHAYKKwYBBAGCNwIBCzEO # MAwGCisGAQQBgjcCARUwLwYJKoZIhvcNAQkEMSIEIErcSbWeBiJIX//iz+ubhgWX # Tqr4Yj3/lu9KqMJQtCf+MEIGCisGAQQBgjcCAQwxNDAyoBSAEgBNAGkAYwByAG8A # cwBvAGYAdKEagBhodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20wDQYJKoZIhvcNAQEB # BQAEggEAsXKYwGyFIptqoXvcfEl7KlqbDgjjsUwnQhTN0tpitQKxSsV6RqRhZHu9 # rWFEvdtC/QiTpz/HpkiLbIJnEkhBELh/JyhJoi54lQ7Qj0akSk9PS7ewcqlqnxx4 # igyfwyCKel706e35LSOVcDWKMJyKUcpPEob5yZJJ5W8Sh7CWYfTp5od7ClpW/rii # QVYRxRfghdPfnzHA/8XC1tW69ZRPBfCQ59klw+dFAQOll4QWOdr1JH8uaTugxg0j # 8Z4TNieKAWgSbASuz93QPWMyNyBW7FCRS4nqM7ysQ7UEHNDrTsXHn2TyN9WOiJrv # Z7+i5acyQISve3WK+B7+d0hvV75rf6GCF60wghepBgorBgEEAYI3AwMBMYIXmTCC # F5UGCSqGSIb3DQEHAqCCF4YwgheCAgEDMQ8wDQYJYIZIAWUDBAIBBQAwggFaBgsq # hkiG9w0BCRABBKCCAUkEggFFMIIBQQIBAQYKKwYBBAGEWQoDATAxMA0GCWCGSAFl # AwQCAQUABCBJilvwcjTkNpnJNN2aViSfW33EeImjcQMH+4mZQArCzAIGZusiXLZn # GBMyMDI0MTEwMTE1MDQxNS40MDRaMASAAgH0oIHZpIHWMIHTMQswCQYDVQQGEwJV # UzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UE # ChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMS0wKwYDVQQLEyRNaWNyb3NvZnQgSXJl # bGFuZCBPcGVyYXRpb25zIExpbWl0ZWQxJzAlBgNVBAsTHm5TaGllbGQgVFNTIEVT # TjozNjA1LTA1RTAtRDk0NzElMCMGA1UEAxMcTWljcm9zb2Z0IFRpbWUtU3RhbXAg # U2VydmljZaCCEfswggcoMIIFEKADAgECAhMzAAAB91ggdQTK+8L0AAEAAAH3MA0G # CSqGSIb3DQEBCwUAMHwxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9u # MRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRp # b24xJjAkBgNVBAMTHU1pY3Jvc29mdCBUaW1lLVN0YW1wIFBDQSAyMDEwMB4XDTI0 # MDcyNTE4MzEwNloXDTI1MTAyMjE4MzEwNlowgdMxCzAJBgNVBAYTAlVTMRMwEQYD # VQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNy # b3NvZnQgQ29ycG9yYXRpb24xLTArBgNVBAsTJE1pY3Jvc29mdCBJcmVsYW5kIE9w # ZXJhdGlvbnMgTGltaXRlZDEnMCUGA1UECxMeblNoaWVsZCBUU1MgRVNOOjM2MDUt # MDVFMC1EOTQ3MSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNl # MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA0OdHTBNom6/uXKaEKP9r # PITkT6QxF11tjzB0Nk1byDpPrFTHha3hxwSdTcr8Y0a3k6EQlwqy6ROz42e0R5eD # W+dCoQapipDIFUOYp3oNuqwX/xepATEkY17MyXFx6rQW2NcWUJW3Qo2AuJ0HOtbl # SpItQZPGmHnGqkt/DB45Fwxk6VoSvxNcQKhKETkuzrt8U6DRccQm1FdhmPKgDzgc # fDPM5o+GnzbiMu6y069A4EHmLMmkecSkVvBmcZ8VnzFHTDkGLdpnDV5FXjVObAgb # SM0cnqYSGfRp7VGHBRqyoscvR4bcQ+CV9pDjbJ6S5rZn1uA8hRhj09Hs33HRevt4 # oWAVYGItgEsG+BrCYbpgWMDEIVnAgPZEiPAaI8wBGemE4feEkuz7TAwgkRBcUzLg # Q4uvPqRD1A+Jkt26+pDqWYSn0MA8j0zacQk9q/AvciPXD9It2ez+mqEzgFRRsJGL # tcf9HksvK8Jsd6I5zFShlqi5bpzf1Y4NOiNOh5QwW1pIvA5irlal7qFhkAeeeZqm # op8+uNxZXxFCQG3R3s5pXW89FiCh9rmXrVqOCwgcXFIJQAQkllKsI+UJqGq9rmRA # BJz5lHKTFYmFwcM52KWWjNx3z6odwz2h+sxaxewToe9GqtDx3/aU+yqNRcB8w0tS # XUf+ylN4uk5xHEpLpx+ZNNsCAwEAAaOCAUkwggFFMB0GA1UdDgQWBBTfRqQzP3m9 # PZWuLf1p8/meFfkmmDAfBgNVHSMEGDAWgBSfpxVdAF5iXYP05dJlpxtTNRnpcjBf # BgNVHR8EWDBWMFSgUqBQhk5odHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpb3Bz # L2NybC9NaWNyb3NvZnQlMjBUaW1lLVN0YW1wJTIwUENBJTIwMjAxMCgxKS5jcmww # bAYIKwYBBQUHAQEEYDBeMFwGCCsGAQUFBzAChlBodHRwOi8vd3d3Lm1pY3Jvc29m # dC5jb20vcGtpb3BzL2NlcnRzL01pY3Jvc29mdCUyMFRpbWUtU3RhbXAlMjBQQ0El # MjAyMDEwKDEpLmNydDAMBgNVHRMBAf8EAjAAMBYGA1UdJQEB/wQMMAoGCCsGAQUF # BwMIMA4GA1UdDwEB/wQEAwIHgDANBgkqhkiG9w0BAQsFAAOCAgEAN0ajafILeL6S # QIMIMAXM1Qd6xaoci2mOrpR8vKWyyTsL3b83A7XGLiAbQxTrqnXvVWWeNst5YQD8 # saO+UTgOLJdTdfUADhLXoK+RlwjfndimIJT9MH9tUYXLzJXKhZM09ouPwNsrn8YO # LIpdAi5TPyN8Cl11OGZSlP9r8JnvomW00AoJ4Pl9rlg0G5lcQknAXqHa9nQdWp1Z # xXqNd+0JsKmlR8tcANX33ClM9NnaClJExLQHiKeHUUWtqyLMl65TW6wRM7XlF7Y+ # PTnC8duNWn4uLng+ON/Z39GO6qBj7IEZxoq4o3avEh9ba43UU6TgzVZaBm8VaA0w # SwUe/pqpTOYFWN62XL3gl/JC2pzfIPxP66XfRLIxafjBVXm8KVDn2cML9IvRK02s # 941Y5+RR4gSAOhLiQQ6A03VNRup+spMa0k+XTPAi+2aMH5xa1Zjb/K8u9f9M05U0 # /bUMJXJDP++ysWpJbVRDiHG7szaca+r3HiUPjQJyQl2NiOcYTGV/DcLrLCBK2zG5 # 03FGb04N5Kf10XgAwFaXlod5B9eKh95PnXKx2LNBgLwG85anlhhGxxBQ5mFsJGkB # n0PZPtAzZyfr96qxzpp2pH9DJJcjKCDrMmZziXazpa5VVN36CO1kDU4ABkSYTXOM # 8RmJXuQm7mUF3bWmj+hjAJb4pz6hT5UwggdxMIIFWaADAgECAhMzAAAAFcXna54C # m0mZAAAAAAAVMA0GCSqGSIb3DQEBCwUAMIGIMQswCQYDVQQGEwJVUzETMBEGA1UE # CBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9z # b2Z0IENvcnBvcmF0aW9uMTIwMAYDVQQDEylNaWNyb3NvZnQgUm9vdCBDZXJ0aWZp # Y2F0ZSBBdXRob3JpdHkgMjAxMDAeFw0yMTA5MzAxODIyMjVaFw0zMDA5MzAxODMy # MjVaMHwxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQH # EwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xJjAkBgNV # BAMTHU1pY3Jvc29mdCBUaW1lLVN0YW1wIFBDQSAyMDEwMIICIjANBgkqhkiG9w0B # AQEFAAOCAg8AMIICCgKCAgEA5OGmTOe0ciELeaLL1yR5vQ7VgtP97pwHB9KpbE51 # yMo1V/YBf2xK4OK9uT4XYDP/XE/HZveVU3Fa4n5KWv64NmeFRiMMtY0Tz3cywBAY # 6GB9alKDRLemjkZrBxTzxXb1hlDcwUTIcVxRMTegCjhuje3XD9gmU3w5YQJ6xKr9 # cmmvHaus9ja+NSZk2pg7uhp7M62AW36MEBydUv626GIl3GoPz130/o5Tz9bshVZN # 7928jaTjkY+yOSxRnOlwaQ3KNi1wjjHINSi947SHJMPgyY9+tVSP3PoFVZhtaDua # Rr3tpK56KTesy+uDRedGbsoy1cCGMFxPLOJiss254o2I5JasAUq7vnGpF1tnYN74 # kpEeHT39IM9zfUGaRnXNxF803RKJ1v2lIH1+/NmeRd+2ci/bfV+AutuqfjbsNkz2 # K26oElHovwUDo9Fzpk03dJQcNIIP8BDyt0cY7afomXw/TNuvXsLz1dhzPUNOwTM5 # TI4CvEJoLhDqhFFG4tG9ahhaYQFzymeiXtcodgLiMxhy16cg8ML6EgrXY28MyTZk # i1ugpoMhXV8wdJGUlNi5UPkLiWHzNgY1GIRH29wb0f2y1BzFa/ZcUlFdEtsluq9Q # BXpsxREdcu+N+VLEhReTwDwV2xo3xwgVGD94q0W29R6HXtqPnhZyacaue7e3Pmri # Lq0CAwEAAaOCAd0wggHZMBIGCSsGAQQBgjcVAQQFAgMBAAEwIwYJKwYBBAGCNxUC # BBYEFCqnUv5kxJq+gpE8RjUpzxD/LwTuMB0GA1UdDgQWBBSfpxVdAF5iXYP05dJl # pxtTNRnpcjBcBgNVHSAEVTBTMFEGDCsGAQQBgjdMg30BATBBMD8GCCsGAQUFBwIB # FjNodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpb3BzL0RvY3MvUmVwb3NpdG9y # eS5odG0wEwYDVR0lBAwwCgYIKwYBBQUHAwgwGQYJKwYBBAGCNxQCBAweCgBTAHUA # YgBDAEEwCwYDVR0PBAQDAgGGMA8GA1UdEwEB/wQFMAMBAf8wHwYDVR0jBBgwFoAU # 1fZWy4/oolxiaNE9lJBb186aGMQwVgYDVR0fBE8wTTBLoEmgR4ZFaHR0cDovL2Ny # bC5taWNyb3NvZnQuY29tL3BraS9jcmwvcHJvZHVjdHMvTWljUm9vQ2VyQXV0XzIw # MTAtMDYtMjMuY3JsMFoGCCsGAQUFBwEBBE4wTDBKBggrBgEFBQcwAoY+aHR0cDov # L3d3dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNSb29DZXJBdXRfMjAxMC0w # Ni0yMy5jcnQwDQYJKoZIhvcNAQELBQADggIBAJ1VffwqreEsH2cBMSRb4Z5yS/yp # b+pcFLY+TkdkeLEGk5c9MTO1OdfCcTY/2mRsfNB1OW27DzHkwo/7bNGhlBgi7ulm # ZzpTTd2YurYeeNg2LpypglYAA7AFvonoaeC6Ce5732pvvinLbtg/SHUB2RjebYIM # 9W0jVOR4U3UkV7ndn/OOPcbzaN9l9qRWqveVtihVJ9AkvUCgvxm2EhIRXT0n4ECW # OKz3+SmJw7wXsFSFQrP8DJ6LGYnn8AtqgcKBGUIZUnWKNsIdw2FzLixre24/LAl4 # FOmRsqlb30mjdAy87JGA0j3mSj5mO0+7hvoyGtmW9I/2kQH2zsZ0/fZMcm8Qq3Uw # xTSwethQ/gpY3UA8x1RtnWN0SCyxTkctwRQEcb9k+SS+c23Kjgm9swFXSVRk2XPX # fx5bRAGOWhmRaw2fpCjcZxkoJLo4S5pu+yFUa2pFEUep8beuyOiJXk+d0tBMdrVX # VAmxaQFEfnyhYWxz/gq77EFmPWn9y8FBSX5+k77L+DvktxW/tM4+pTFRhLy/AsGC # onsXHRWJjXD+57XQKBqJC4822rpM+Zv/Cuk0+CQ1ZyvgDbjmjJnW4SLq8CdCPSWU # 5nR0W2rRnj7tfqAxM328y+l7vzhwRNGQ8cirOoo6CGJ/2XBjU02N7oJtpQUQwXEG # ahC0HVUzWLOhcGbyoYIDVjCCAj4CAQEwggEBoYHZpIHWMIHTMQswCQYDVQQGEwJV # UzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UE # ChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMS0wKwYDVQQLEyRNaWNyb3NvZnQgSXJl # bGFuZCBPcGVyYXRpb25zIExpbWl0ZWQxJzAlBgNVBAsTHm5TaGllbGQgVFNTIEVT # TjozNjA1LTA1RTAtRDk0NzElMCMGA1UEAxMcTWljcm9zb2Z0IFRpbWUtU3RhbXAg # U2VydmljZaIjCgEBMAcGBSsOAwIaAxUAb28KDG/xXbNBjmM7/nqw3bgrEOaggYMw # gYCkfjB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UE # BxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYD # VQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMDANBgkqhkiG9w0BAQsF # AAIFAOrO9yYwIhgPMjAyNDExMDEwNjQzNTBaGA8yMDI0MTEwMjA2NDM1MFowdDA6 # BgorBgEEAYRZCgQBMSwwKjAKAgUA6s73JgIBADAHAgEAAgIk9TAHAgEAAgISzjAK # AgUA6tBIpgIBADA2BgorBgEEAYRZCgQCMSgwJjAMBgorBgEEAYRZCgMCoAowCAIB # AAIDB6EgoQowCAIBAAIDAYagMA0GCSqGSIb3DQEBCwUAA4IBAQCCjyoncUGngvB0 # 64MftJnT48khEAPUTc05X80dAqCl3P5yJ95fJuRMQnbH1X2mMvPDvxYkRLokgmXn # q7RZYEis/B8eI+4qoY5PcF3TI1f7XAJ2uJvoAhUJg/+FuwIvcjPNlI+zcWKzXSe4 # rRrWjxIvT9fvqQQgR4D7PMX8lFxunuFswKpNadkp38XUFHc24TZlbD/7ycX6yLm6 # 0Y24puwvOO46bmmgBCg2WnWvNQK8ZOOOaKQSIwDc6jS2suA+x0lBojHVmpQM7DO6 # 9S+4JL7rJDS+UvfwtxeTsY4QGUlRhVozycjcQAhayzfD4OHhUWYv54DrgiZa0Pxh # MRAuK7+UMYIEDTCCBAkCAQEwgZMwfDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldh # c2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBD # b3Jwb3JhdGlvbjEmMCQGA1UEAxMdTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBIDIw # MTACEzMAAAH3WCB1BMr7wvQAAQAAAfcwDQYJYIZIAWUDBAIBBQCgggFKMBoGCSqG # SIb3DQEJAzENBgsqhkiG9w0BCRABBDAvBgkqhkiG9w0BCQQxIgQguMUnlLylELRW # BNAyiMgZ/bwKP0q84YkV9jf4xAC5recwgfoGCyqGSIb3DQEJEAIvMYHqMIHnMIHk # MIG9BCAh2pjaa3ca0ecYuhu60uYHP/IKnPbedbVQJ5SoIH5Z4jCBmDCBgKR+MHwx # CzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRt # b25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xJjAkBgNVBAMTHU1p # Y3Jvc29mdCBUaW1lLVN0YW1wIFBDQSAyMDEwAhMzAAAB91ggdQTK+8L0AAEAAAH3 # MCIEINprnf/sP3Nnh4GdzbLjDJfN8EJvq52i5va/WSXLhhqZMA0GCSqGSIb3DQEB # CwUABIICAD0/2eQs8YRfebza5LbVtsxW/dUbwcmEDp6MYP7m3po9XKjox2A5mXUv # Oo45k8pM2l6FoQb13deqtXLpBB5RFuYDq0no46wOpXOqoHAhJfxNRRxO6isPgiU+ # mcqGXub1GcIkQhrMTQwReHEfcmjOwILPC7dvY0Noxs+Fi+yquuNwDFFuf6r9aPow # RnSft+3CSPtIyIMtRMzwj9k8pKG2+gcqjOsaYvCyOSnYVGuThmUoCtphyi5OmqYy # tAVmYN8cEulOP85N4VgxVoJ/rLtjJ5An2V1WiX0hHeU08DSbXvoM56MFrs6QweAq # U1RUXRGvv02idkr0TfbZPaSFAHaNLOx+WQASK6GkLPF8d3hemHfpXTldK4yUwT92 # 0aaScmE1ex7vYZ3bHBPIiPg29Q7gF03GXJHMxYpK+inLi8tYVDK1+R61K2cGXiaF # FXK/o+cHdDdjLx/1FBpYWBmnpn57UHrbarKf6aIjsvs1QbO09k37Dq6XNjmESHGj # I9pEBm88BCcRL3phlL5Vhk7i/rKzPe0gyMrqyVl2082cx3rJE5ZIP9m2Kv3C+yn1 # SEgTLl5hFT4el80yyRHEhj5xazonDPcwj4hz/OumqYv5SCTKZyBlm1Ts8VGDEvEU # XPvQk8jOOsGSjV7dGaGHqkCCx2B8G7tWKB9b0Wfmzwf1AD0BZytm # SIG # End signature block |