Register-AzStaticWebAppUserProvidedFunctionApp

Reference

Module:: Az.Websites

Description for Register a user provided function app with a static site build

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Register-AzStaticWebAppUserProvidedFunctionApp
        -FunctionAppName <String>
        -Name <String>
        -ResourceGroupName <String>
        [-SubscriptionId <String>]
        [-Forced]
        [-FunctionAppRegion <String>]
        [-FunctionAppResourceId <String>]
        [-Kind <String>]
        [-DefaultProfile <PSObject>]
        [-AsJob]
        [-NoWait]
        [-Confirm]
        [-WhatIf]
        [<CommonParameters>]

Register-AzStaticWebAppUserProvidedFunctionApp
        -EnvironmentName <String>
        -FunctionAppName <String>
        -Name <String>
        -ResourceGroupName <String>
        [-SubscriptionId <String>]
        [-Forced]
        [-FunctionAppRegion <String>]
        [-FunctionAppResourceId <String>]
        [-Kind <String>]
        [-DefaultProfile <PSObject>]
        [-AsJob]
        [-NoWait]
        [-Confirm]
        [-WhatIf]
        [<CommonParameters>]

Description

Description for Register a user provided function app with a static site build

Examples

Example 1: Register a user provided function app with a static site

PS C:\> Register-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName azure-rg-test -Name staticweb-pwsh02 -FunctionAppName funcapp-portal01-test -FunctionAppResourceId '/subscriptions/xxxxxxxxxxxxx/resourcegroups/azure-rg-test/providers/Microsoft.Web/sites/funcapp-portal01-test' -FunctionAppRegion 'Central US'

Kind Name                  Type
---- ----                  ----
     funcapp-portal01-test Microsoft.Web/staticSites/userProvidedFunctionApps

This command registers a user provided function app with a static site. The -FunctionAppRegion is region of the function app.

Example 2: Register a user provided function app with a static site build

PS C:\> Register-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName azure-rg-test -Name staticweb-pwsh02 -FunctionAppName functionapp-portal02 -FunctionAppResourceId '/subscriptions/xxxxxxxxx/resourcegroups/azure-rg-test/providers/Microsoft.Web/sites/functionapp-portal02' -FunctionAppRegion 'Central US' -EnvironmentName 5

Kind Name                 Type
---- ----                 ----
     functionapp-portal02 Microsoft.Web/staticSites/builds/userProvidedFunctionApps

This command registers a user provided function app with a static site build. The -FunctionAppRegion is region of the function app.

Parameters

-AsJob

Run the command as a job

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

-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

-EnvironmentName

The stage site identifier.

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

-Forced

Specify <code>true</code> to force the update of the auth configuration on the function app even if an AzureStaticWebApps provider is already configured on the function app. The default is <code>false</code>.

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

-FunctionAppName

Name of the function app to register with the static site build.

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

-FunctionAppRegion

The region of the function app registered with the static site

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

-FunctionAppResourceId

The resource id of the function app registered with the static site

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

-Kind

Kind of resource.

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

-Name

Name of the static site.

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

-NoWait

Run the command asynchronously

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

-ResourceGroupName

Name of the resource group to which the resource belongs.

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

-SubscriptionId

Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

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

Outputs

IStaticSiteUserProvidedFunctionAppArmResource

Notes

ALIASES