Edit

Unregister-AzStaticWebAppUserProvidedFunctionApp

  • Reference
Module:
Az.Websites

Description for Detach the user provided function app from the static site

Note

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

Syntax

Unregister-AzStaticWebAppUserProvidedFunctionApp
          -FunctionAppName <String>
          -Name <String>
          -ResourceGroupName <String>
          [-SubscriptionId <String>]
          [-DefaultProfile <PSObject>]
          [-PassThru]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]
Unregister-AzStaticWebAppUserProvidedFunctionApp
          -InputObject <IWebsitesIdentity>
          [-DefaultProfile <PSObject>]
          [-PassThru]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]

Description

Description for Detach the user provided function app from the static site

Examples

Example 1: Unregister the user provided function app from the static site

Unregister-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName 'resourceGroup' -Name 'staticweb00' -FunctionAppName 'functionAppName01'

This command unregisters the user provided function app from the static site.

Example 2: Unregister the user provided function app from the static site by pipeline

Register-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName $env.resourceGroup -Name $env.staticweb00 -FunctionAppName $env.functionAppName01 -FunctionAppResourceId $env.functionAppId01 -FunctionAppRegion $env.location -IsForced | Unregister-AzStaticWebAppUserProvidedFunctionApp

This command unregisters the user provided function app from the static site by pipeline.

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
-FunctionAppName

Name of the function app registered with the static site.

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

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

Type:IWebsitesIdentity
Position:Named
Default value:None
Accept pipeline input:True
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
-PassThru

Returns true when the command succeeds

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

Inputs

IWebsitesIdentity

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 <IWebsitesIdentity>: Identity Parameter

  • [Authprovider <String>]: The auth provider for the users.
  • [DomainName <String>]: The custom domain name.
  • [EnvironmentName <String>]: The stage site identifier.
  • [FunctionAppName <String>]: Name of the function app registered with the static site build.
  • [Id <String>]: Resource identity path
  • [JobHistoryId <String>]: History ID.
  • [Location <String>]: Location where you plan to create the static site.
  • [Name <String>]: Name of the static site.
  • [PrivateEndpointConnectionName <String>]: Name of the private endpoint connection.
  • [ResourceGroupName <String>]: Name of the resource group to which the resource belongs.
  • [Slot <String>]: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
  • [SubscriptionId <String>]: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
  • [Userid <String>]: The user id of the user.
  • [WebJobName <String>]: Name of Web Job.