Start-AzFunctionApp

Reference

Module:: Az.Functions

Starts a function app.

Syntax

Start-AzFunctionApp
     -Name <String>
     -ResourceGroupName <String>
     [-SubscriptionId <String>]
     [-DefaultProfile <PSObject>]
     [-PassThru]
     [-Confirm]
     [-WhatIf]
     [<CommonParameters>]

Start-AzFunctionApp
     -InputObject <ISite>
     [-DefaultProfile <PSObject>]
     [-PassThru]
     [-Confirm]
     [-WhatIf]
     [<CommonParameters>]

Description

Starts a function app.

Examples

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

Get-AzFunctionApp -Name MyAppName -ResourceGroupName MyResourceGroupName | Start-AzFunctionApp

This command gets a function app by name and starts it.

Example 2: Start a function app by name.

Start-AzFunctionApp -Name MyAppName -ResourceGroupName MyResourceGroupName

This command starts a function app by name.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

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

Type:	ISite
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

The name of function app.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

Returns true when the command succeeds.

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

-ResourceGroupName

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

The Azure subscription ID.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

ISite

Outputs

Boolean