Remove-AzFunctionAppPlan

Deletes a function app plan.

Syntax

Remove-AzFunctionAppPlan
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-Force]
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Remove-AzFunctionAppPlan
      -InputObject <IAppServicePlan>
      [-Force]
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

Deletes a function app plan.

Examples

Example 1: Get a function app plan by name and delete it.

PS C:\> Get-AzFunctionAppPlan -Name MyAppName -ResourceGroupName MyResourceGroupName | Remove-AzFunctionAppPlan -Force

This command gets a function app plan by name and deletes it.

Example 2: Delete a function app plan by name.

PS C:\> Remove-AzFunctionAppPlan -Name MyAppName -ResourceGroupName MyResourceGroupName -Force

This command deletes a function app plan by name.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Forces the cmdlet to remove the function app plan without prompting for confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InputObject

To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.IAppServicePlan
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Name

The name of function app.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

Returns true when the command succeeds.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceGroupName
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SubscriptionId

The Azure subscription ID.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.IAppServicePlan

Outputs

Boolean

Notes

ALIASES

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 :

  • 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.
  • [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 true, false otherwise.
  • [IsSpot <Boolean?>]: If true, this App Service Plan owns spot instances.
  • [IsXenon <Boolean?>]: Obsolete: If Hyper-V container app service plan true, false otherwise.
  • [MaximumElasticWorkerCount <Int32?>]: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
  • [PerSiteScaling <Boolean?>]: If true, apps assigned to this App Service plan can be scaled independently. If false, apps assigned to this App Service plan will scale to all instances of the plan.
  • [Reserved <Boolean?>]: If Linux app service plan true, false 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.
  • [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.