Register-AzStaticWebAppUserProvidedFunctionApp
Description for Register a user provided function app with a static site build
Syntax
RegisterExpanded1 (Default)
Register-AzStaticWebAppUserProvidedFunctionApp
-FunctionAppName <String>
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-Forced]
[-FunctionAppRegion <String>]
[-FunctionAppResourceId <String>]
[-Kind <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RegisterViaJsonString
Register-AzStaticWebAppUserProvidedFunctionApp
-FunctionAppName <String>
-EnvironmentName <String>
-Name <String>
-ResourceGroupName <String>
-JsonString <String>
[-SubscriptionId <String>]
[-Forced]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RegisterViaJsonFilePath
Register-AzStaticWebAppUserProvidedFunctionApp
-FunctionAppName <String>
-EnvironmentName <String>
-Name <String>
-ResourceGroupName <String>
-JsonFilePath <String>
[-SubscriptionId <String>]
[-Forced]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RegisterViaIdentityStaticSiteExpanded
Register-AzStaticWebAppUserProvidedFunctionApp
-FunctionAppName <String>
-EnvironmentName <String>
-StaticSiteInputObject <IWebsitesIdentity>
[-Forced]
[-FunctionAppRegion <String>]
[-FunctionAppResourceId <String>]
[-Kind <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RegisterViaIdentityStaticSite
Register-AzStaticWebAppUserProvidedFunctionApp
-FunctionAppName <String>
-EnvironmentName <String>
-StaticSiteInputObject <IWebsitesIdentity>
-StaticSiteUserProvidedFunctionEnvelope <IStaticSiteUserProvidedFunctionAppArmResource>
[-Forced]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RegisterExpanded
Register-AzStaticWebAppUserProvidedFunctionApp
-FunctionAppName <String>
-EnvironmentName <String>
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-Forced]
[-FunctionAppRegion <String>]
[-FunctionAppResourceId <String>]
[-Kind <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RegisterViaJsonString1
Register-AzStaticWebAppUserProvidedFunctionApp
-FunctionAppName <String>
-Name <String>
-ResourceGroupName <String>
-JsonString <String>
[-SubscriptionId <String>]
[-Forced]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RegisterViaJsonFilePath1
Register-AzStaticWebAppUserProvidedFunctionApp
-FunctionAppName <String>
-Name <String>
-ResourceGroupName <String>
-JsonFilePath <String>
[-SubscriptionId <String>]
[-Forced]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RegisterViaIdentityBuildExpanded
Register-AzStaticWebAppUserProvidedFunctionApp
-FunctionAppName <String>
-BuildInputObject <IWebsitesIdentity>
[-Forced]
[-FunctionAppRegion <String>]
[-FunctionAppResourceId <String>]
[-Kind <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RegisterViaIdentityBuild
Register-AzStaticWebAppUserProvidedFunctionApp
-FunctionAppName <String>
-BuildInputObject <IWebsitesIdentity>
-StaticSiteUserProvidedFunctionEnvelope <IStaticSiteUserProvidedFunctionAppArmResource>
[-Forced]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RegisterViaIdentityStaticSiteExpanded1
Register-AzStaticWebAppUserProvidedFunctionApp
-FunctionAppName <String>
-StaticSiteInputObject <IWebsitesIdentity>
[-Forced]
[-FunctionAppRegion <String>]
[-FunctionAppResourceId <String>]
[-Kind <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RegisterViaIdentityStaticSite1
Register-AzStaticWebAppUserProvidedFunctionApp
-FunctionAppName <String>
-StaticSite1InputObject <IWebsitesIdentity>
-StaticSiteUserProvidedFunctionEnvelope <IStaticSiteUserProvidedFunctionAppArmResource>
[-Forced]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<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
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
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
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
RegisterViaIdentityBuildExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaIdentityBuild
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EnvironmentName
The stage site identifier.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
RegisterViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaIdentityStaticSiteExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaIdentityStaticSite
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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>.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-FunctionAppName
Name of the function app to register with the static site build.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-FunctionAppRegion
The region of the function app registered with the static site
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
RegisterExpanded1
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaIdentityStaticSiteExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaIdentityBuildExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaIdentityStaticSiteExpanded1
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-FunctionAppResourceId
The resource id of the function app registered with the static site
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
RegisterExpanded1
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaIdentityStaticSiteExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaIdentityBuildExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaIdentityStaticSiteExpanded1
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JsonFilePath
Path of Json file supplied to the Register operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
RegisterViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaJsonFilePath1
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JsonString
Json string supplied to the Register operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
RegisterViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaJsonString1
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Kind
Kind of resource.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
RegisterExpanded1
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaIdentityStaticSiteExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaIdentityBuildExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaIdentityStaticSiteExpanded1
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
Name of the static site.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
RegisterExpanded1
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaJsonString1
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaJsonFilePath1
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NoWait
Run the command asynchronously
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
Name of the resource group to which the resource belongs.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
RegisterExpanded1
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaJsonString1
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaJsonFilePath1
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
RegisterViaIdentityStaticSite1
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
RegisterViaIdentityStaticSiteExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaIdentityStaticSite
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaIdentityStaticSiteExpanded1
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-StaticSiteUserProvidedFunctionEnvelope
Static Site User Provided Function App ARM resource.
Parameter properties
Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionAppArmResource
Default value: None Supports wildcards: False DontShow: False
Parameter sets
RegisterViaIdentityStaticSite
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaIdentityBuild
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaIdentityStaticSite1
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
Your Azure subscription ID.
This is a GUID-formatted string (e.g.
00000000-0000-0000-0000-000000000000).
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
RegisterExpanded1
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaJsonString
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaJsonFilePath
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaJsonString1
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RegisterViaJsonFilePath1
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionAppArmResource
Outputs
Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IStaticSiteUserProvidedFunctionAppArmResource
